com.adobe.livecycle.signatures.client.types
Class PDFSeedValueOptionSpec

java.lang.Object
  com.adobe.livecycle.signatures.client.types.PDFSeedValueOptionSpec

All Implemented Interfaces:

java.io.Serializable

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

Represents the seed value dictionary that is associated with a signature field. A seed value dictionary contains entries that constrain information that is used at the time the signature is applied. For more information about seed value dictionaries, see the PDF Reference guide version 1.7.

To see an object of this type used in a code example, see the Modifying a signature field using the Java API quick start in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

PDFSeedValueOptionSpec()
Creates a PDFSeedValueOptionSpec object.

Method Summary

CertificateSeedValueOptionSpec	getCertificateSeedValueOptions() Gets the Certificate Seed Value dictionary containing information about the certificate used when signing.
HashAlgorithm[]	getDigestMethod() Returns an array of names indicating acceptable digest algorithms for signing.
PDFFilterType	getFilter() Deprecated.
java.lang.String	getFilterEx() Gets the signature handler that is used to sign the signature field.
int	getFlags() Gets the flag associated with this seed value.
java.lang.String[]	getLegalAttestations() Gets the legal attestation associated with this seed value.
MDPPermissions	getMdpValue() Gets the MDP value associated with this seed value.
java.lang.String[]	getReasons() Gets the reasons associated with this seed value.
PDFSubFilterType[]	getSubFilter() Deprecated.
java.lang.String[]	getSubFilterEx() Gets the subfilters associated with this seed value dictionary.
PDFTimeStampSeed	getTimeStampSeed() Gets the timestamp seed associated with this dictionary.
java.lang.Double	getVersion() Gets the minimum required version number of the signature handler to be used to sign the signature field.
java.lang.Boolean	isAddRevInfo() Returns a Boolean value that specifies whether revocation checking should be performed.
void	setAddRevInfo(boolean addRevInfo) Sets a Boolean value that specifies whether revocation checking should be performed.
void	setCertificateSeedValueOptions(CertificateSeedValueOptionSpec certSeedValue) Sets the Certificate Seed Value dictionary containing information about the certificate to be used when signing.
void	setDigestMethod(HashAlgorithm[] digestMethod) Sets an array of names indicating acceptable digest algorithms to use for signing.
void	setFilter(PDFFilterType filter) Deprecated.
void	setFilterEx(java.lang.String filterEx) Sets the signature handler that is used to sign the signature field.
void	setFlags(int flags) Sets the flag associated with the seed value.
void	setLegalAttestations(java.lang.String[] legalAttestations) Sets the legal attestation associated with this seed value.
void	setMdpValue(MDPPermissions mdpValue) Sets the MDP value associated with this seed value.
void	setReasons(java.lang.String[] reasons) Sets the reasons associated with this seed value.
void	setSubFilter(PDFSubFilterType[] subfilter) Deprecated.
void	setSubFilterEx(java.lang.String[] subFilterEx) Sets the subfilters associated with this seed value dictionary.
void	setTimeStampSeed(PDFTimeStampSeed timeStampSeed) Sets the timestamp seed associated with this dictionary.
void	setVersion(java.lang.Double version) Sets the minimum required version number of the signature handler to be used to sign the signature field.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFSeedValueOptionSpec

public PDFSeedValueOptionSpec()

Creates a PDFSeedValueOptionSpec object.

Method Detail

getCertificateSeedValueOptions

public CertificateSeedValueOptionSpec getCertificateSeedValueOptions()

Gets the Certificate Seed Value dictionary containing information about the certificate used when signing.

Returns:

A CertificateSeedValueOptionSpec object that represents the Certificate Seed Value dictionary.

setCertificateSeedValueOptions

public void setCertificateSeedValueOptions(CertificateSeedValueOptionSpec certSeedValue)

Sets the Certificate Seed Value dictionary containing information about the certificate to be used when signing.

Parameters:

certSeedValue - A CertificateSeedValueOptionSpec object that represents the Certificate Seed Value dictionary.

getFilter

public PDFFilterType getFilter()

Deprecated.

Gets the signature handler that is used to sign the signature field.

Returns:

A PDFFilterType object that represents a signature handler that is used to sign the signature field.

setFilter

public void setFilter(PDFFilterType filter)

Deprecated.

Sets the signature handler to be used to sign the signature field.

Parameters:

filter - A PDFFilterType object that represents a signature handler that is used to sign the signature field.

getFlags

public int getFlags()

Gets the flag associated with this seed value.

Returns:

A set of bit flags specifying the interpretation of specific entries in this dictionary. A value of 1 for the flag indicates that the associated entry is a required constraint. A value of 0 indicates that the associated entry is an optional constraint.

Bit positions are:

• 1 (Filter) - The signature handler to be used to sign the signature field.
• 2 (SubFilter) - An array of names indicating acceptable encodings to use when signing.
• 3 (V) - The minimum required version number of the signature handler to be used to sign the signature field.
• 4 (Reasons) - An array of strings specifying possible reasons for signing a document.
• 5(PDFLegalWarnings)- An array of strings specifying possible legal attestations.
• 6(AddRevInfo) - Revision information.
• 7(DigestMethod)- A name identifying the algorithm to be used when computing the digest.

The default value is 0.

setFlags

public void setFlags(int flags)

Sets the flag associated with the seed value.

Parameters:

flags - A set of bit flags specifying the interpretation of specific entries in this dictionary. A value of 1 for the flag means that a signer is required to use only the specified values for the entry. A value of 0 means that other values are permissible.

Bit positions are:

• 1 (Filter) - The signature handler to be used to sign the signature field.
• 2 (SubFilter) - An array of names indicating acceptable encodings to use when signing.
• 3 (V) - The minimum required version number of the signature handler to be used to sign the signature field.
• 4 (Reasons) - An array of strings that specifying possible reasons for signing a document.
• 5(PDFLegalWarnings)- An array of strings specifying possible legal attestations.

The default value is 0.

getLegalAttestations

public java.lang.String[] getLegalAttestations()

Gets the legal attestation associated with this seed value.

Returns:

An array of strings specifying possible legal attestations.

setLegalAttestations

public void setLegalAttestations(java.lang.String[] legalAttestations)

Sets the legal attestation associated with this seed value.

Parameters:

legalAttestations - An array of strings specifying legal attestations.

getMdpValue

public MDPPermissions getMdpValue()

Gets the MDP value associated with this seed value.

Returns:

A dictionary containing a single entry whose key is P and whose value is an integer between 0 and 3. A value of 0 defines the signature as an ordinary (non-author) signature. The values 1 through 3 are used for author signatures and correspond to the value of P in a DocMDP transform parameters dictionary.

• 1 - No changes to the document are permitted; any change to the document invalidates the signature.
• 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.
• 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.

If this entry is not present or does not contain a P entry, no rules are defined regarding the type of signature or its permissions.

setMdpValue

public void setMdpValue(MDPPermissions mdpValue)

Sets the MDP value associated with this seed value.

Parameters:

mdpValue - A MDPPermissions object that represents a dictionary containing a single entry whose key is P and whose value is an integer between 0 and 3. A value of 0 defines the signature as an ordinary (non-author) signature. The values 1 through 3 are used for author signatures and correspond to the value of P in a DocMDP transform parameters dictionary.

• 1 - No changes to the document are permitted; any change to the document invalidates the signature.
• 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.
• 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.

If this entry is not present or does not contain a P entry, no rules are defined regarding the type of signature or its permissions.

getReasons

public java.lang.String[] getReasons()

Gets the reasons associated with this seed value.

Returns:

An array of strings that specify possible reasons for signing a PDF document.

setReasons

public void setReasons(java.lang.String[] reasons)

Sets the reasons associated with this seed value.

Parameters:

reasons - An array of strings that specify possible reasons for signing a PDF document.

getSubFilter

public PDFSubFilterType[] getSubFilter()

Deprecated.

Gets the subfilters associated with this seed value.

Returns:

An array of names indicating acceptable encodings to use when signing. The first name in the array that matches an encoding supported by the signature handler is the encoding that is used for signing.

setSubFilter

public void setSubFilter(PDFSubFilterType[] subfilter)

Deprecated.

Sets the subfilters associated with this seed value dictionary.

Parameters:

subfilter - An array of names indicating acceptable encodings to use when signing. The first name in the array that matches an encoding supported by the signature handler is the encoding that is used for signing.

getTimeStampSeed

public PDFTimeStampSeed getTimeStampSeed()

Gets the timestamp seed associated with this dictionary. It contains two values: the URL to use while timestamping and a Boolean value that specifies whether timestamping is required.

Returns:

A PDFTimeStampSeed object that represents the timestamp associated with this seed value dictionary.

setTimeStampSeed

public void setTimeStampSeed(PDFTimeStampSeed timeStampSeed)

Sets the timestamp seed associated with this dictionary. It contains two values: the URL to use while timestamping and a Boolean value that specifies whether timestamping is required.

Parameters:

timeStampSeed - A PDFTimeStampSeed object that represents the timestamp associated with this seed value dictionary.

getVersion

public java.lang.Double getVersion()

Gets the minimum required version number of the signature handler to be used to sign the signature field.

Returns:

The minimum required version number of the signature handler to be used to sign the signature field.

setVersion

public void setVersion(java.lang.Double version)

Sets the minimum required version number of the signature handler to be used to sign the signature field.

Parameters:

version - The minimum required version number of the signature handler to be used to sign the signature field.

isAddRevInfo

public java.lang.Boolean isAddRevInfo()

Returns a Boolean value that specifies whether revocation checking should be performed.

Returns:

A flag indicating whether revocation checking should be carried out. If this value is true, the viewer application performs the following additional tasks when signing the signature field:

Perform revocation checking of the certificate (and the corresponding issuing certificates) used to sign.

Include the revocation information within the signature value.

A value of true is relevant only if SubFilter is adbe.pkcs7.detached or adbe.pkcs7.sha1. If SubFilter is x509.rsa_sha1, this entry must be omitted or set to false; otherwise, the signature process may fail.

If AddRevInfo is true and the Ff entry indicates this is a required constraint, then the tasks described above must be performed. If they cannot be performed, then signing must fail.

The default value is false.

setAddRevInfo

public void setAddRevInfo(boolean addRevInfo)

Sets a Boolean value that specifies whether revocation checking should be performed.

Parameters:

addRevInfo - A flag indicating whether revocation checking should be carried out. If this value is true, the viewer application performs the following additional tasks when signing the signature field:

Perform revocation checking of the certificate (and the corresponding issuing certificates) used to sign. Include the revocation information within the signature value.

A value of true is relevant only if SubFilter is adbe.pkcs7.detached or adbe.pkcs7.sha1. If SubFilter is x509.rsa_sha1, this entry must be omitted or set to false; otherwise, the signature process may fail.

If AddRevInfo is true and the Ff entry indicates this is a required constraint, then the tasks described above must be performed. If they cannot be performed, then the signing operations fails.

The default value is false.

getDigestMethod

public HashAlgorithm[] getDigestMethod()

Returns an array of names indicating acceptable digest algorithms for signing.

Returns:

An array of names indicating acceptable digest algorithms to use while signing. Valid values are SHA1, SHA256, SHA384, SHA512 and RIPEMD160. The default value is implementation-specific.

Note: This property is only applicable if the digital credential signing contains RSA public/private keys. If it contains DSA public/private key, the digest algorithm is always SHA1 and this attribute is ignored. If MD5 is used as input, it is ignored.

setDigestMethod

public void setDigestMethod(HashAlgorithm[] digestMethod)

Sets an array of names indicating acceptable digest algorithms to use for signing.

Parameters:

digestMethod - An array of names indicating acceptable digest algorithms to use while signing. Valid values are SHA1, SHA256, SHA384, SHA512 and RIPEMD160. The default value is implementation-specific.

Note: This property is only applicable if the digital credential signing contains RSA public/private keys. If it contains DSA public/private key, the digest algorithm is always SHA1 and this attribute is ignored. If MD5 is used as input, it is ignored.

getFilterEx

public java.lang.String getFilterEx()

Gets the signature handler that is used to sign the signature field. This method was added in LiveCycle ES 8.2.

Returns:

A string that represents a signature handler that is used to sign the signature field.

setFilterEx

public void setFilterEx(java.lang.String filterEx)

Sets the signature handler that is used to sign the signature field. This method was added in LiveCycle ES 8.2.

Parameters:

filterEx - A string that represents a signature handler that is used to sign the signature field.

getSubFilterEx

public java.lang.String[] getSubFilterEx()

Gets the subfilters associated with this seed value dictionary. This method was added in LiveCycle ES 8.2.

Returns:

A string array of names indicating acceptable encodings to use when signing. The first name in the array that matches an encoding supported by the signature handler is the encoding that is used for signing.

setSubFilterEx

public void setSubFilterEx(java.lang.String[] subFilterEx)

Sets the subfilters associated with this seed value dictionary. This method was added in LiveCycle ES 8.2.

Parameters:

subFilterEx - A string array of names indicating acceptable encodings to use when signing. The first name in the array that matches an encoding supported by the signature handler is the encoding that is used for signing.