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

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

All Implemented Interfaces:

java.io.Serializable

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

Stores preferences for online certificate status protocol (OCSP) support. For information, see "Online Certificate Status Protocol" at http://tools.ietf.org/html/rfc2560.

See Also:

Serialized Form

Constructor Summary

OCSPOptionSpec()
Creates an OCSPOptionSpec object.

Method Summary

long	getMaxClockSkew() Returns the maximum allowed skew in response time and local time.
java.lang.String	getOcspServerURL() Returns the locally configured OCSP URL.
java.lang.String	getRequestSignerCredentialAlias() Returns the alias that corresponds to the credential that is used to sign the PDF document.
long	getResponseFreshness() Gets the maximum time validity of a preconstructed OCSP response.
RevocationCheckStyle	getRevocationCheckStyle() Gets the RevocationCheckStyle object associated with this object.
OCSPURLtoConsultOption	getURLtoConsultOption() Specifies the OCSP URL to use.
boolean	isAllowOCSPNoCheck() Specifies whether it is unnecessary to check the OCSP server.
boolean	isDoSignRequest() Specifies whether to sign the request or not.
boolean	isGoOnline() Specifies whether to go online to interact with the OCSP server.
boolean	isIgnoreValidityDates() Specifies whether to ignore the response's thisUpdate and nextUpdate times, thereby preventing any negative affect of these times on the response validity.
boolean	isRequireOCSPCertHash() Specifies whether the hash algorithm is required.
boolean	isSendNonce() Specifies whether a Nonce is sent with the request.
void	setAllowOCSPNoCheck(boolean allowOCSPNoCheck) Sets whether it is unnecessary to check the OCSP server.
void	setDoSignRequest(boolean doSignRequest) Sets whether to sign the request or not.
void	setGoOnline(boolean goOnline) Sets whether to go online to interact with the OCSP server.
void	setIgnoreValidityDates(boolean ignoreValidityDates) Sets whether to ignore the response's thisUpdate and nextUpdate times, thereby preventing any negative affect of these times on the response validity.
void	setMaxClockSkew(long maxClockSkew) Sets the maximum allowed skew in response time and local time.
void	setOcspServerURL(java.lang.String ocspServerURL) Sets the locally configured OCSP URL.
void	setRequestSignerCredentialAlias(java.lang.String requestSignerCredentialAlias) Sets the alias that corresponds to the credential that is used to sign the PDF document.
void	setRequireOCSPCertHash(boolean requireOCSPCertHash) Sets whether the hash algorithm is required.
void	setResponseFreshness(long responseFreshness) Sets the maximum time validity of a preconstructed OCSP response.
void	setRevocationCheckStyle(RevocationCheckStyle revocationCheckStyle) Sets the RevocationCheckStyle object associated with this object.
void	setSendNonce(boolean sendNonce) Sets whether a nonce is sent during the request to the OCSP.
void	setURLtoConsultOption(OCSPURLtoConsultOption ltoConsultOption) Sets the OCSP URL to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

OCSPOptionSpec

public OCSPOptionSpec()

Creates an OCSPOptionSpec object.

This object contains the following default values:

• Check revocation information if available.
• Use locally configured OCSP server.
• Do not sign the request.
• The maxClockSkew time value is 5.
• The responseFreshness allowed value is 52600 (1 year).

Method Detail

isDoSignRequest

public boolean isDoSignRequest()

Specifies whether to sign the request or not.

Returns:

A Boolean value that specifies whether to sign the request.

setDoSignRequest

public void setDoSignRequest(boolean doSignRequest)

Sets whether to sign the request or not.

Parameters:

doSignRequest - A Boolean value that specifies whether to sign the request.

getMaxClockSkew

public long getMaxClockSkew()

Returns the maximum allowed skew in response time and local time.

Returns:

The maximum allowed skew in response time and local time.

setMaxClockSkew

public void setMaxClockSkew(long maxClockSkew)

Sets the maximum allowed skew in response time and local time.

Parameters:

maxClockSkew - The maximum allowed skew in response time and local time.

getOcspServerURL

public java.lang.String getOcspServerURL()

Returns the locally configured OCSP URL.

Returns:

the locally configured OCSP URL.

setOcspServerURL

public void setOcspServerURL(java.lang.String ocspServerURL)

Sets the locally configured OCSP URL.

Parameters:

ocspServerURL - The locally configured OCSP URL.

getRequestSignerCredentialAlias

public java.lang.String getRequestSignerCredentialAlias()

Returns the alias that corresponds to the credential that is used to sign the PDF document.

Returns:

The alias that corresponds to the credential.

setRequestSignerCredentialAlias

public void setRequestSignerCredentialAlias(java.lang.String requestSignerCredentialAlias)

Sets the alias that corresponds to the credential that is used to sign the PDF document.

Parameters:

requestSignerCredentialAlias - The alias that corresponds to the credential.

getResponseFreshness

public long getResponseFreshness()

Gets the maximum time validity of a preconstructed OCSP response.

Returns:

The maximum time validity of a preconstructed OCSP response.

setResponseFreshness

public void setResponseFreshness(long responseFreshness)

Sets the maximum time validity of a preconstructed OCSP response.

Parameters:

responseFreshness - The maximum time validity of a preconstructed OCSP response.

getRevocationCheckStyle

public RevocationCheckStyle getRevocationCheckStyle()

Gets the RevocationCheckStyle object associated with this object.

Returns:

The RevocationCheckStyle object associated with this object.

setRevocationCheckStyle

public void setRevocationCheckStyle(RevocationCheckStyle revocationCheckStyle)

Sets the RevocationCheckStyle object associated with this object.

Parameters:

revocationCheckStyle - The RevocationCheckStyle object associated with this object.

isSendNonce

public boolean isSendNonce()

Specifies whether a Nonce is sent with the request. A nonce is a parameter that varies with time. A nonce can be a time stamp, a visit counter on a Web page, or a special marker intended to limit or prevent the unauthorized replay or reproduction of a file.

Returns:

A boolean value that specifies whether a nonce is sent.

setSendNonce

public void setSendNonce(boolean sendNonce)

Sets whether a nonce is sent during the request to the OCSP.

Parameters:

sendNonce - A boolean value that specifies whether a nonce is sent during the request.

getURLtoConsultOption

public OCSPURLtoConsultOption getURLtoConsultOption()

Specifies the OCSP URL to use.

Returns:

A OCSPURLtoConsultOption object that corresponds to the OCSP URL to use.

setURLtoConsultOption

public void setURLtoConsultOption(OCSPURLtoConsultOption ltoConsultOption)

Sets the OCSP URL to use.

Parameters:

ltoConsultOption - A OCSPURLtoConsultOption object that corresponds to the OCSP URL.

isIgnoreValidityDates

public boolean isIgnoreValidityDates()

Specifies whether to ignore the response's thisUpdate and nextUpdate times, thereby preventing any negative affect of these times on the response validity. This method was added in LiveCycle ES 8.2.

Returns:

A boolean value that specifies whether to ignore the response's thisUpdate and nextUpdate times.

setIgnoreValidityDates

public void setIgnoreValidityDates(boolean ignoreValidityDates)

Sets whether to ignore the response's thisUpdate and nextUpdate times, thereby preventing any negative affect of these times on the response validity.

Parameters:

ignoreValidityDates - A boolean value that specifies whether to ignore the response's thisUpdate and nextUpdate times.

isGoOnline

public boolean isGoOnline()

Specifies whether to go online to interact with the OCSP server. This method was added in LiveCycle ES 8.2.

Returns:

A boolean value that specifies whether to go online.

setGoOnline

public void setGoOnline(boolean goOnline)

Sets whether to go online to interact with the OCSP server.

Parameters:

goOnline - A boolean value that specifies whether to go online to to interact with the OCSP server.

isAllowOCSPNoCheck

public boolean isAllowOCSPNoCheck()

Specifies whether it is unnecessary to check the OCSP server. This method was added in LiveCycle 8.2.

Returns:

A boolean value that specifies whether it is unnecessary to check the OCSP server.

setAllowOCSPNoCheck

public void setAllowOCSPNoCheck(boolean allowOCSPNoCheck)

Sets whether it is unnecessary to check the OCSP server. This method was added in LiveCycle ES 8.2.

Parameters:

allowOCSPNoCheck - A boolean value that specifies whether it is unnecessary to check the OCSP server.

isRequireOCSPCertHash

public boolean isRequireOCSPCertHash()

Specifies whether the hash algorithm is required. This method was added in LiveCycle ES 8.2.

Returns:

A boolean value that specifies whether the hash algorithm is required.

setRequireOCSPCertHash

public void setRequireOCSPCertHash(boolean requireOCSPCertHash)

Sets whether the hash algorithm is required. This method was added in LiveCycle ES 8.2.

Parameters:

requireOCSPCertHash - A boolean value that specifies whether the hash algorithm is required.