|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.signatures.client.types.PDFSeedValueOptionSpec
public class PDFSeedValueOptionSpec
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 ES3.
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. |
String |
getFilterEx()
Gets the signature handler that is used to sign the signature field. |
int |
getFlags()
Gets the flag associated with this seed value. |
String[] |
getLegalAttestations()
Gets the legal attestation associated with this seed value. |
MDPPermissions |
getMdpValue()
Gets the MDP value associated with this seed value. |
String[] |
getReasons()
Gets the reasons associated with this seed value. |
PDFSubFilterType[] |
getSubFilter()
Deprecated. |
String[] |
getSubFilterEx()
Gets the subfilters associated with this seed value dictionary. |
PDFTimeStampSeed |
getTimeStampSeed()
Gets the timestamp seed associated with this dictionary. |
Double |
getVersion()
Gets the minimum required version number of the signature handler to be used to sign the signature field. |
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(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(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(String[] reasons)
Sets the reasons associated with this seed value. |
void |
setSubFilter(PDFSubFilterType[] subfilter)
Deprecated. |
void |
setSubFilterEx(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(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 |
---|
public PDFSeedValueOptionSpec()
PDFSeedValueOptionSpec
object.
Method Detail |
---|
public CertificateSeedValueOptionSpec getCertificateSeedValueOptions()
CertificateSeedValueOptionSpec
object that
represents the Certificate Seed Value dictionary.public void setCertificateSeedValueOptions(CertificateSeedValueOptionSpec certSeedValue)
certSeedValue
- A CertificateSeedValueOptionSpec
object that
represents the Certificate Seed Value dictionary.public PDFFilterType getFilter()
PDFFilterType
object that represents a signature
handler that is used to sign the signature field.public void setFilter(PDFFilterType filter)
filter
- A PDFFilterType
object that represents a
signature handler that is used to sign the signature field.public int getFlags()
Bit positions are:
The default value is 0.
public void setFlags(int flags)
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:
The default value is 0.
public String[] getLegalAttestations()
public void setLegalAttestations(String[] legalAttestations)
legalAttestations
- An array of strings specifying legal attestations.public MDPPermissions getMdpValue()
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.
public void setMdpValue(MDPPermissions mdpValue)
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.
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.
public String[] getReasons()
public void setReasons(String[] reasons)
reasons
- An array of strings that specify possible reasons for signing
a PDF document.public PDFSubFilterType[] getSubFilter()
public void setSubFilter(PDFSubFilterType[] subfilter)
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.public PDFTimeStampSeed getTimeStampSeed()
PDFTimeStampSeed
object that represents the
timestamp associated with this seed value dictionary.public void setTimeStampSeed(PDFTimeStampSeed timeStampSeed)
timeStampSeed
- A PDFTimeStampSeed
object that represents the
timestamp associated with this seed value dictionary.public Double getVersion()
public void setVersion(Double version)
version
- The minimum required version number of the signature handler to be
used to sign the signature field.public Boolean isAddRevInfo()
true
, the viewer
application performs the following additional tasks when signing
the signature field:
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
.
public void setAddRevInfo(boolean addRevInfo)
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
.
public HashAlgorithm[] getDigestMethod()
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.
public void setDigestMethod(HashAlgorithm[] digestMethod)
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.
public String getFilterEx()
public void setFilterEx(String filterEx)
filterEx
- A string that represents a signature
handler that is used to sign the signature field.public String[] getSubFilterEx()
public void setSubFilterEx(String[] subFilterEx)
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |