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