org.kuali.rice.ksb.security

Interface DigitalSigner

All Known Implementing Classes:

AbstractDigitalSigner, HttpClientHeaderDigitalSigner, ResponseHeaderDigitalSigner

public interface DigitalSigner

Responsible for signing a message. A reference is provided to the Signature to allow for population of the singnature from message data. When this population of data is complete, the sign() method will sign the message according to the implementation.
Note that the interface itself does not provide any means of retrieving the message being signed. It is up to the implementing classes to determine what consititutes "signing" of a message.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
Signature	getSignature() Retrieve a reference to Signature which will be used for signing.
void	sign() Sign the message using the Signature.

Method Detail

getSignature

Signature getSignature()

Retrieve a reference to Signature which will be used for signing.

sign

void sign()
          throws Exception

Sign the message using the Signature. This method will not be called until all of the message data has been populated into the Signature. After signing implementations may, for example, place the digital signature in a header or perform whatever steps are required to successfully sign the message.

Throws:

Exception