|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.signatures.client.spi.types.SignRequest
public class SignRequest
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 ES.
Constructor Summary | |
---|---|
SignRequest()
|
|
SignRequest(NameIdentifierType userID,
KeyInfoType credentialIdentifier,
HashMap signedSignatureProperties,
HashMap unsignedSignatureProperties,
boolean predictSize,
String requestID,
InputDocument inputDocument,
AddTimestamp addTimestamp,
URI signatureStandard,
String digestEmbedType,
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. |
String |
getDigestEmbedType()
Retrieves a string value that specifies the digest value. |
InputDocument |
getInputDocument()
Returns the input document to sign. |
String |
getRequestID()
Retrieves the request identifier value, which associates a response with a request. |
URI |
getSignatureStandard()
Retrieves the signature standard type value. |
HashMap |
getSignedSignatureProperties()
Retrieves signed signature properties. |
HashMap |
getSPIGenericProperties()
Gets the properties used by the signature handler. |
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(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(String requestID)
Sets the request identifier value, which associates a response with a request. |
void |
setSignatureStandard(URI signatureStandard)
Sets the signature standard type value. |
void |
setSignedSignatureProperties(HashMap signedSignatureProperties)
Sets signed signature properties. |
void |
setUnsignedSignatureProperties(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 |
---|
public SignRequest(NameIdentifierType userID, KeyInfoType credentialIdentifier, HashMap signedSignatureProperties, HashMap unsignedSignatureProperties, boolean predictSize, String requestID, InputDocument inputDocument, AddTimestamp addTimestamp, URI signatureStandard, String digestEmbedType, HashMap props)
SignRequest
constructor. This constructor is invoked by the Signature service.
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 PropertiesTSPPreferences
: Another PropertiesCRLPreferences
: Another PropertiesembedRevocationInfoInDSS
: 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.public SignRequest()
Method Detail |
---|
public NameIdentifierType getUserID()
NameIdentifierType
object that specifies the user identifier value.public void setUserID(NameIdentifierType userID)
userID
- A NameIdentifierType
object that specifies the user identifier value.public KeyInfoType getCredentialIdentifier()
KeyInfoType
object that specifies the credential identifier value.public void setCredentialIdentifier(KeyInfoType credentialIdentifier)
credentialIdentifier
- A KeyInfoType
object that specifies the credential identifier value.public AddTimestamp getAddTimestamp()
AddTimestamp
object that represents the timestamp embedded into the signature.public void setAddTimestamp(AddTimestamp addTimestamp)
addTimestamp
- An AddTimestamp
object that represents the timestamp embedded into the signature.public InputDocument getInputDocument()
InputDocument
that represents the document to sign.public void setInputDocument(InputDocument inputDocument)
inputDocument
- An InputDocument
that represents the document to sign.public boolean isPredictSize()
InputDocuments.DocumentHash.DigestValue
value
is an un-used hash value.
true
if the predictSize run-time option is set, otherwise false.public void setPredictSize(boolean predictSize)
InputDocuments.DocumentHash.DigestValue
value
is an un-used hash value.
predictSize
- The value true
to set the predictSize run-time option, otherwise false.public String getRequestID()
public void setRequestID(String requestID)
requestID
- the requestID to setpublic HashMap getSignedSignatureProperties()
HashMap
object that specifies signed signature properties.public void setSignedSignatureProperties(HashMap signedSignatureProperties)
signedSignatureProperties
- the signedSignatureProperties to setpublic HashMap getUnsignedSignatureProperties()
HashMap
object that specifies unsigned signature properties.public void setUnsignedSignatureProperties(HashMap unsignedSignatureProperties)
unsignedSignatureProperties
- A HashMap
object that specifies unsigned signature properties.public String getDigestEmbedType()
public void setDigestEmbedType(String digestEmbedType)
digestEmbedType
- A string value specifies the digest value.public URI getSignatureStandard()
A
- URI value that specifies the signature standard.public void setSignatureStandard(URI signatureStandard)
A
- URI value that specifies the signature standard.public HashMap getSPIGenericProperties()
HashMap
object that contains properties used by the signature handler.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |