 | Report generated by Clover Code Coverage v3.0.2 Wed Apr 13 2011 04:19:36 EDT. |
Clover: Open Source License registered to University of Arizona. |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| DigitalSigner | Line # 31 | 0 | - | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| No Tests | |||
| 1 | /* | |
| 2 | * Copyright 2005-2007 The Kuali Foundation | |
| 3 | * | |
| 4 | * | |
| 5 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
| 6 | * you may not use this file except in compliance with the License. | |
| 7 | * You may obtain a copy of the License at | |
| 8 | * | |
| 9 | * http://www.opensource.org/licenses/ecl2.php | |
| 10 | * | |
| 11 | * Unless required by applicable law or agreed to in writing, software | |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 14 | * See the License for the specific language governing permissions and | |
| 15 | * limitations under the License. | |
| 16 | */ | |
| 17 | package org.kuali.rice.ksb.security; | |
| 18 | ||
| 19 | import java.security.Signature; | |
| 20 | ||
| 21 | /** | |
| 22 | * Responsible for signing a message. A reference is provided to the Signature to allow for population | |
| 23 | * of the singnature from message data. When this population of data is complete, the sign() method | |
| 24 | * will sign the message according to the implementation. | |
| 25 | * <br> | |
| 26 | * Note that the interface itself does not provide any means of retrieving the message being signed. It | |
| 27 | * is up to the implementing classes to determine what consititutes "signing" of a message. | |
| 28 | * | |
| 29 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 30 | */ | |
| 31 | public interface DigitalSigner { | |
| 32 | ||
| 33 | /** | |
| 34 | * Retrieve a reference to Signature which will be used for signing. | |
| 35 | */ | |
| 36 | public Signature getSignature(); | |
| 37 | ||
| 38 | /** | |
| 39 | * Sign the message using the Signature. This method will not be called until all of the message data | |
| 40 | * has been populated into the Signature. After signing implementations may, for example, place the digital | |
| 41 | * signature in a header or perform whatever steps are required to successfully sign the message. | |
| 42 | */ | |
| 43 | public void sign() throws Exception; | |
| 44 | ||
| 45 | } | |
|
||||||||||||