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

java.lang.Object
  extended by com.adobe.livecycle.signatures.client.types.PKIOptions
All Implemented Interfaces:
java.io.Serializable

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

Represents PKI options that can be set when validating digital signatures. For example, you can specify whether or not to perform revocation checking on a certificate used to sign or certify a PDF document. An object of this type is used when verifying either a single digital signature or multiple digital signatures located in a PDF document. To see an object of this type used in a code example, see either the Verifying a digital signature using the Java API quick start or the Verifying multiple digital signatures using the Java API quick start in Programming with LiveCycle ES4.

This class was added in LiveCycle ES2.

See Also:
Serialized Form

Constructor Summary
PKIOptions()
           
 
Method Summary
 CRLOptionSpec getCRLOptionSpec()
          Returns certificate revocation list (CRL) preference information that is associated with this signature.
 OCSPOptionSpec getOCSPOptionSpec()
          Returns information about online certificate status protocol (OCSP) support that is associated with this signature.
 PathValidationOptionSpec getPathValidationOptionSpec()
          Returns RFC3280 related path validation information that is associated with this signature.
 RevocationCheckStyle getRevocationCheckStyle()
          Returns the revocation check style that is associated with this signature.
 TSPOptionSpec getTSPOptionSpec()
          Returns time stamping provider (TSP) support information that is associated with this signature.
 VerificationTime getVerificationTime()
          Returns the verification time that is associated with this signature.
 java.lang.Boolean isUseDocValidationInfo()
           
 void setCRLOptionSpec(CRLOptionSpec crlOptionSpec)
          Sets certificate revocation list (CRL) preference information that is associated with this signature.
 void setOCSPOptionSpec(OCSPOptionSpec ocspOptionSpec)
          Sets information about online certificate status protocol (OCSP) support that is associated with this signature.
 void setPathValidationOptionSpec(PathValidationOptionSpec pathValidationOptionSpec)
          Sets RFC3280 related path validation information that is associated with this signature.
 void setRevocationCheckStyle(RevocationCheckStyle revocationCheckStyle)
          Sets the revocation check style that is associated with this signature.
 void setTSPOptionSpec(TSPOptionSpec tspOptionSpec)
          Sets time stamping provider (TSP) support information that is associated with this signature.
 void setUseDocValidationInfo(java.lang.Boolean useDocValidationInfo)
           
 void setVerificationTime(VerificationTime verificationTime)
          Sets the verification time that is associated with this signature.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PKIOptions

public PKIOptions()
Method Detail

getRevocationCheckStyle

public RevocationCheckStyle getRevocationCheckStyle()
Returns the revocation check style that is associated with this signature.

Returns:
A RevocationCheckStyle enumeration value that specifies the revocation check style.

setRevocationCheckStyle

public void setRevocationCheckStyle(RevocationCheckStyle revocationCheckStyle)
Sets the revocation check style that is associated with this signature. For example, you can specify the RevocationCheckStyle.NoCheck enumeration value that results in the Signature service not checking to determine if the certificate used to sign or certify a PDF document has been revoked. To see this method used in a code example, see either the Verifying a digital signature using the Java API quick start or the Verifying multiple digital signatures using the Java API quick start in Programming with LiveCycle ES4.

Parameters:
revocationCheckStyle - A RevocationCheckStyle enumeration value that specifies the revocation check style.

getVerificationTime

public VerificationTime getVerificationTime()
Returns the verification time that is associated with this signature.

Returns:
A VerificationTime enumeration value that specifies the verification time.

setVerificationTime

public void setVerificationTime(VerificationTime verificationTime)
Sets the verification time that is associated with this signature. To see this method used in a code example, see either the Verifying a digital signature using the Java API quick start or the Verifying multiple digital signatures using the Java API quick start in Programming with LiveCycle ES4.

Parameters:
verificationTime - A VerificationTime enumeration value that specifies the verification time.

getOCSPOptionSpec

public OCSPOptionSpec getOCSPOptionSpec()
Returns information about online certificate status protocol (OCSP) support that is associated with this signature.

Returns:
An OCSPOptionSpec enumeration value that provides information about online certificate status protocol (OCSP) support.

setOCSPOptionSpec

public void setOCSPOptionSpec(OCSPOptionSpec ocspOptionSpec)
Sets information about online certificate status protocol (OCSP) support that is associated with this signature.

Parameters:
ocspOptionSpec - An OCSPOptionSpec enumeration value that provides information about online certificate status protocol (OCSP) support.

getCRLOptionSpec

public CRLOptionSpec getCRLOptionSpec()
Returns certificate revocation list (CRL) preference information that is associated with this signature.

Returns:
A CRLOptionSpec enumeration value that specifies certificate revocation list (CRL) preference information.

setCRLOptionSpec

public void setCRLOptionSpec(CRLOptionSpec crlOptionSpec)
Sets certificate revocation list (CRL) preference information that is associated with this signature. If you want to use revocation checking and do not specify a URL for the CRL server, the URL is obtained from the certificate.

Parameters:
crlOptionSpec - A CRLOptionSpec enumeration value that specifies certificate revocation list (CRL) preference information.

getPathValidationOptionSpec

public PathValidationOptionSpec getPathValidationOptionSpec()
Returns RFC3280 related path validation information that is associated with this signature. For information, see "Basic Path Validation" in the RFC3280 document at http://www.ietf.org/rfc/rfc3280.txt.

Returns:
A PathValidationOptionSpec enumeration value that specifies RFC3280 related path validation information.

setPathValidationOptionSpec

public void setPathValidationOptionSpec(PathValidationOptionSpec pathValidationOptionSpec)
Sets RFC3280 related path validation information that is associated with this signature. For information, see "Basic Path Validation" in the RFC3280 document at http://www.ietf.org/rfc/rfc3280.txt.

Parameters:
pathValidationOptionSpec - A PathValidationOptionSpec enumeration value that specifies RFC3280 related path validation information.

getTSPOptionSpec

public TSPOptionSpec getTSPOptionSpec()
Returns time stamping provider (TSP) support information that is associated with this signature.

Returns:
A TSPOptionSpec enumeration value that specifies time stamping provider (TSP) support information.

setTSPOptionSpec

public void setTSPOptionSpec(TSPOptionSpec tspOptionSpec)
Sets time stamping provider (TSP) support information that is associated with this signature. Time stamping refers to the process of tracking the time when a signed or certified document was modified. Once a document is signed, it should not be modified, even by the document owner. Time stamping helps enforce the validity of a signed or certified document.

Parameters:
tspOptionSpec - A TSPOptionSpec enumeration value that specifies time stamping provider (TSP) support information.

isUseDocValidationInfo

public java.lang.Boolean isUseDocValidationInfo()

setUseDocValidationInfo

public void setUseDocValidationInfo(java.lang.Boolean useDocValidationInfo)


[an error occurred while processing this directive] [an error occurred while processing this directive]