com.adobe.livecycle.signatures.client.spi.types
Class SignRequest

java.lang.Object
  com.adobe.livecycle.signatures.client.spi.types.SignRequest

All Implemented Interfaces:

java.io.Serializable

public class SignRequest
extends java.lang.Object
implements java.io.Serializable

A SignRequest object is passed by the Signature service to a signature handler's sign method when a client application invokes the sign operation. This object contains information such as the key name element which specifies a string value which can be used by the signer to communicate a key identifier to the recipient. Typically, the key name value contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair.

For information about creating a signature handler, see the Creating Signature Handlers section in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

SignRequest()

SignRequest(NameIdentifierType userID, KeyInfoType credentialIdentifier, java.util.HashMap signedSignatureProperties, java.util.HashMap unsignedSignatureProperties, boolean predictSize, java.lang.String requestID, InputDocument inputDocument, AddTimestamp addTimestamp, java.net.URI signatureStandard, java.lang.String digestEmbedType, java.util.HashMap props)
A SignRequest constructor.

Method Summary

AddTimestamp	getAddTimestamp() Gets a timestamp that represents a timestamp that is embedded into the signature.
KeyInfoType	getCredentialIdentifier() Retrieves the credential identifier value for this sign request.
java.lang.String	getDigestEmbedType() Retrieves a string value that specifies the digest value.
InputDocument	getInputDocument() Returns the input document to sign.
java.lang.String	getRequestID() Retrieves the request identifier value, which associates a response with a request.
java.net.URI	getSignatureStandard() Retrieves the signature standard type value.
java.util.HashMap	getSignedSignatureProperties() Retrieves signed signature properties.
java.util.HashMap	getSPIGenericProperties() Gets the properties used by the signature handler.
java.util.HashMap	getUnsignedSignatureProperties() Retrieves unsigned signature properties.
NameIdentifierType	getUserID() Retrieves the user identifier value for this sign request.
boolean	isPredictSize() Specifies whether the predictSize run-time option is set.
void	setAddTimestamp(AddTimestamp addTimestamp) Sets a timestamp that is embedded into the signature.
void	setCredentialIdentifier(KeyInfoType credentialIdentifier) Sets the credential identifier value for this sign request.
void	setDigestEmbedType(java.lang.String digestEmbedType) Sets a string value that specifies the digest value.
void	setInputDocument(InputDocument inputDocument) Sets the input document to sign.
void	setPredictSize(boolean predictSize) Sets the predictSize run-time option.
void	setRequestID(java.lang.String requestID) Sets the request identifier value, which associates a response with a request.
void	setSignatureStandard(java.net.URI signatureStandard) Sets the signature standard type value.
void	setSignedSignatureProperties(java.util.HashMap signedSignatureProperties) Sets signed signature properties.
void	setUnsignedSignatureProperties(java.util.HashMap unsignedSignatureProperties) Sets unsigned signature properties.
void	setUserID(NameIdentifierType userID) Sets the user identifier value for this sign request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignRequest

public SignRequest(NameIdentifierType userID,
                   KeyInfoType credentialIdentifier,
                   java.util.HashMap signedSignatureProperties,
                   java.util.HashMap unsignedSignatureProperties,
                   boolean predictSize,
                   java.lang.String requestID,
                   InputDocument inputDocument,
                   AddTimestamp addTimestamp,
                   java.net.URI signatureStandard,
                   java.lang.String digestEmbedType,
                   java.util.HashMap props)

A SignRequest constructor. This constructor is invoked by the Signature service.

Parameters:

userID - The name of the user on whose behalf the sign request is generated.

credentialIdentifier - Identifies the credentials that are used for signing in case the user has multiple credentials.

signedSignatureProperties - Informs the signer to add additional properties in the document signature. The value of the properties can be specified here or can be determined by the signer. The signer can add additional properties even if they are not requested by the client. These properties are covered by the signature.

unsignedSignatureProperties - Informs the signer to add additional properties in the document signature. The value of the properties can be specified here or can be determined by the signer. The signer can add additional properties even if they are not requested by the client. These properties are not covered by signature.

predictSize - Predicts the size of the PKCS7 value that is returned if a signature is created. The presence of this field indicates that the hash in InputDocuments.DocumentHash.DigestValue value is an un-used hash value.

requestID - An optional parameter to uniquely associate a response with a request.

inputDocument - Represents the PDF document or the documet hash required for signing.

addTimestamp - Represents the timestamp that is added to the signature field.

signatureStandard - Represents the type of algorithm used to generate a signature, Valid types are: XML Signature (urn:ietf:rfc:3275), MLTimeStampToken (urn:oasis:names:tc:dss:1.0:core:schema:XMLTimeStampToken), RFC 3161 TimeStampToken (urn:ietf:rfc:3161), PKCS#7 (urn:ietf:rfc:2315), PKCS#1 (urn:ietf:rfc:3447), and DSA Signatures (urn:ietf:rfc:3279).

digestEmbedType - The digest value used when signing a document.

props - Properties that are used by the signature handler. Valid properties are:

• OCSPPreferences: Another Properties object conatining qualified preference name strings as keys and the values as strings. This object contains OCSP preferences.
• TSPPreferences: Another Properties object conatining qualified preference name strings as keys and the values as strings. This object contains Timestamping preferences.
• CRLPreferences: Another Properties object conatining qualified preference name strings as keys and the values as strings. This object contains CRLs related preferences.
• embedRevocationInfoInDSS: This property is ignored if the value of the embedRevocationInfo paramter to the API is false, otherwise it determines where the embedding takes place. If the value of this property is false, then embedding takes place in signature handler, otherwise it takes place in within the Signature service.
• m_embedTimeStampInDSS: This property determines where the embedding of a timestamp takes place. If the value of this property is false, then embedding takes place in signature handler, otherwise it takes place in within the Signature service.

SignRequest

public SignRequest()

Method Detail

getUserID

public NameIdentifierType getUserID()

Retrieves the user identifier value for this sign request. A user identifier value specifies the name of the user on whose behalf the sign request is generated.

Returns:

A NameIdentifierType object that specifies the user identifier value.

setUserID

public void setUserID(NameIdentifierType userID)

Sets the user identifier value for this sign request. A user identifier value specifies the name of the user on whose behalf the sign request is generated.

Parameters:

userID - A NameIdentifierType object that specifies the user identifier value.

getCredentialIdentifier

public KeyInfoType getCredentialIdentifier()

Retrieves the credential identifier value for this sign request. A credential identifier value specifies the credentials that are used to sign a document in case the user has multiple credentials.

Returns:

A KeyInfoType object that specifies the credential identifier value.

setCredentialIdentifier

public void setCredentialIdentifier(KeyInfoType credentialIdentifier)

Sets the credential identifier value for this sign request. A credential identifier value specifies the credentials that are used to sign a document in case the user has multiple credentials.

Parameters:

credentialIdentifier - A KeyInfoType object that specifies the credential identifier value.

getAddTimestamp

public AddTimestamp getAddTimestamp()

Gets a timestamp that represents a timestamp that is embedded into the signature.

Returns:

A AddTimestamp object that represents the timestamp embedded into the signature.

setAddTimestamp

public void setAddTimestamp(AddTimestamp addTimestamp)

Sets a timestamp that is embedded into the signature.

Parameters:

addTimestamp - An AddTimestamp object that represents the timestamp embedded into the signature.

getInputDocument

public InputDocument getInputDocument()

Returns the input document to sign.

Returns:

An InputDocument that represents the document to sign.

setInputDocument

public void setInputDocument(InputDocument inputDocument)

Sets the input document to sign.

Parameters:

inputDocument - An InputDocument that represents the document to sign.

isPredictSize

public boolean isPredictSize()

Specifies whether the predictSize run-time option is set. This run-time option indicates that the hash in InputDocuments.DocumentHash.DigestValue value is an un-used hash value.

Returns:

The value true if the predictSize run-time option is set, otherwise false.

setPredictSize

public void setPredictSize(boolean predictSize)

Sets the predictSize run-time option. This run-time option indicates that the hash in InputDocuments.DocumentHash.DigestValue value is an un-used hash value.

Parameters:

predictSize - The value true to set the predictSize run-time option, otherwise false.

getRequestID

public java.lang.String getRequestID()

Retrieves the request identifier value, which associates a response with a request.

Returns:

A string value that specifies the request identifier value.

setRequestID

public void setRequestID(java.lang.String requestID)

Sets the request identifier value, which associates a response with a request.

Parameters:

requestID - the requestID to set

getSignedSignatureProperties

public java.util.HashMap getSignedSignatureProperties()

Retrieves signed signature properties. This property informs the signer to add additional properties in the document signature. The value of the properties can be specified here or can be determined by the signer. The signer can add additional properties even if they are not requested by the client.

Returns:

A HashMap object that specifies signed signature properties.

setSignedSignatureProperties

public void setSignedSignatureProperties(java.util.HashMap signedSignatureProperties)

Sets signed signature properties. This property informs the signer to add additional properties in the document signature. The value of the properties can be specified here or can be determined by the signer. The signer can add additional properties even if they are not requested by the client.

Parameters:

signedSignatureProperties - the signedSignatureProperties to set

getUnsignedSignatureProperties

public java.util.HashMap getUnsignedSignatureProperties()

Retrieves unsigned signature properties. Unsigned signature properties informs the signer to add additional properties in the document signature. The value of the properties can be specified here or can be determined by the signer. The signer can add additional properties even if they are not requested by the client. These properties are not covered by signature.

Returns:

A HashMap object that specifies unsigned signature properties.

setUnsignedSignatureProperties

public void setUnsignedSignatureProperties(java.util.HashMap unsignedSignatureProperties)

Sets unsigned signature properties. Unsigned signature properties informs the signer to add additional properties in the document signature. The value of the properties can be specified here or can be determined by the signer. The signer can add additional properties even if they are not requested by the client. These properties are not covered by signature.

Parameters:

unsignedSignatureProperties - A HashMap object that specifies unsigned signature properties.

getDigestEmbedType

public java.lang.String getDigestEmbedType()

Retrieves a string value that specifies the digest value.

Returns:

A string value specifies the digest value.

setDigestEmbedType

public void setDigestEmbedType(java.lang.String digestEmbedType)

Sets a string value that specifies the digest value.

Parameters:

digestEmbedType - A string value specifies the digest value.

getSignatureStandard

public java.net.URI getSignatureStandard()

Retrieves the signature standard type value. This value informs the type of algorithm to use to generate a signature. Valid values are XML Signature (urn:ietf:rfc:3275), MLTimeStampToken (urn:oasis:names:tc:dss:1.0:core:schema:XMLTimeStampToken), RFC 3161 TimeStampToken (urn:ietf:rfc:3161), PKCS#7 (urn:ietf:rfc:2315), PKCS#1 (urn:ietf:rfc:3447), and DSA Signatures (urn:ietf:rfc:3279).

Parameters:

A - URI value that specifies the signature standard.

setSignatureStandard

public void setSignatureStandard(java.net.URI signatureStandard)

Sets the signature standard type value. This value informs the type of algorithm to use to generate a signature. Valid values are XML Signature (urn:ietf:rfc:3275), MLTimeStampToken (urn:oasis:names:tc:dss:1.0:core:schema:XMLTimeStampToken), RFC 3161 TimeStampToken (urn:ietf:rfc:3161), PKCS#7 (urn:ietf:rfc:2315), PKCS#1 (urn:ietf:rfc:3447), and DSA Signatures (urn:ietf:rfc:3279).

Parameters:

A - URI value that specifies the signature standard.

getSPIGenericProperties

public java.util.HashMap getSPIGenericProperties()

Gets the properties used by the signature handler.

Returns:

A HashMap object that contains properties used by the signature handler.