com.adobe.fd.signatures.pki.client.types.prefs

Class OCSPPreferencesImpl

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.adobe.fd.signatures.pki.client.types.prefs.PreferencesMap

com.adobe.fd.signatures.pki.client.types.prefs.CommonPreferencesImpl

com.adobe.fd.signatures.pki.client.types.prefs.OCSPPreferencesImpl

All Implemented Interfaces:

CommonPreferences, OCSPPreferences, Serializable, Cloneable, Map<String,Object>

public class OCSPPreferencesImpl
extends CommonPreferencesImpl
implements OCSPPreferences

This class stores preferences for OCSP support.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OCSPPreferencesImpl() Sets the defaults.

Method Summary

Modifier and Type	Method and Description
protected PreferencesMap	createChild(String myKey)
boolean	getAllowOCSPNoCheck() Allow OCSP NoCheck Extension
HashAlgorithm	getDigestAlgorithm() Digest Algorithm to be used for OCSPRequests CertID
boolean	getDoSignRequest() Gets whether OCSP request would be signed or not.
boolean	getGoOnline() Indicates if online OCSP server can be contacted for revocation information
boolean	getIgnoreValidityDates() Indicates if OCSP validity needs to be honored
long	getMaxClockSkew() Gets the maximum Skew time allowed between the OCSP Server's clock and the local computer.
protected String[]	getNonCloneableKeys()
String	getOcspServerURL() Gets the Server URL configured to lookup for OCSP Responses.
protected Object	getPrefValueFromString(String prefName, String value)
PKICredential	getRequestSignerCredential() Gets the Alias of the credential to be used for signing the OCSP Request
boolean	getRequireOCSPCertHash() Indicates if OCSP Response CertID needs to be have certificate hash
long	getResponseFreshness() Gets the allowed OCSP Response freshness.
boolean	getSendNonce() Gets Whether a nonce should be a part of the OCSP request.
OCSPURLtoConsultOption	getURLtoConsult() Gets The type of OCSP Server URL to use for fetching revocation information
boolean	getUseCache() Indicates if OCSP Response needs to be cached/used till OCSP nextUpdate
PreferencesMap	newInstance() Get the new instance of the type
void	setAllowOCSPNoCheck(boolean value)
void	setDigestAlgorithm(HashAlgorithm algo)
void	setDoSignRequest(boolean doSignRequest) Sets whether OCSP request should be signed or not
void	setGoOnline(boolean value)
void	setIgnoreValidityDates(boolean value)
void	setMaxClockSkew(long maxClockSkew) Sets the maximum Skew time allowed between the OCSP Server's clock and the local computer.
void	setOcspServerURL(String ocspServerURL) Sets the Server URL to lookup for OCSP Responses.
void	setRequestSignerCredential(PKICredential cred) Sets the Alias of the credential to be used for signing the OCSP Request
void	setRequireOCSPCertHash(boolean value)
void	setResponseFreshness(long responseFreshness) Sets the allowed OCSP Response freshness.
void	setSendNonce(boolean sendNonce) Sets Whether a nonce should be a part of the OCSP request.
void	setURLtoConsult(OCSPURLtoConsultOption urlToConsult) Sets The type of OCSP Server URL to use for fetching revocation information
void	setUseCache(boolean value)

Methods inherited from class com.adobe.fd.signatures.pki.client.types.prefs.CommonPreferencesImpl

getRevocationCheck, setRevocationCheck

Methods inherited from class com.adobe.fd.signatures.pki.client.types.prefs.PreferencesMap

clone, get, getPreference, put, setPreference

Methods inherited from interface com.adobe.fd.signatures.pki.client.types.prefs.CommonPreferences

getRevocationCheck

Constructor Detail

OCSPPreferencesImpl

public OCSPPreferencesImpl()

Sets the defaults. The defaults are :
- Check revocation information if available
- use locally configured ocsp server if no aia present
- do not sign the request
- maxClockSkew time = 5
- responseFreshness allowed = 52600 (1 year)

Method Detail

getPrefValueFromString

protected Object getPrefValueFromString(String prefName,
                                        String value)

Overrides:

getPrefValueFromString in class CommonPreferencesImpl

getDoSignRequest

public boolean getDoSignRequest()

Gets whether OCSP request would be signed or not.

Specified by:

getDoSignRequest in interface OCSPPreferences

Returns:

Returns the whether OCSP request would be signed or not.

setDoSignRequest

public void setDoSignRequest(boolean doSignRequest)

Sets whether OCSP request should be signed or not

Parameters:

doSignRequest - the whether OCSP request should be signed or not.

getMaxClockSkew

public long getMaxClockSkew()

Gets the maximum Skew time allowed between the OCSP Server's clock and the local computer.

Specified by:

getMaxClockSkew in interface OCSPPreferences

Returns:

Returns the maximum Skew time allowed between the OCSP Server's clock and the local computer.

setMaxClockSkew

public void setMaxClockSkew(long maxClockSkew)

Sets the maximum Skew time allowed between the OCSP Server's clock and the local computer.

Parameters:

maxClockSkew - The maxClockSkew to set.

getOcspServerURL

public String getOcspServerURL()

Gets the Server URL configured to lookup for OCSP Responses.

Specified by:

getOcspServerURL in interface OCSPPreferences

Returns:

Returns the ocspServerURL.

setOcspServerURL

public void setOcspServerURL(String ocspServerURL)

Sets the Server URL to lookup for OCSP Responses.

Parameters:

ocspServerURL - The Server URL to lookup for OCSP Responses

getRequestSignerCredential

public PKICredential getRequestSignerCredential()

Gets the Alias of the credential to be used for signing the OCSP Request

Specified by:

getRequestSignerCredential in interface OCSPPreferences

Returns:

Returns the Alias of the credential to be used for signing the OCSP Request.

setRequestSignerCredential

public void setRequestSignerCredential(PKICredential cred)

Sets the Alias of the credential to be used for signing the OCSP Request

Parameters:

cred - Alias of the credential to be used for signing the OCSP Request.

getResponseFreshness

public long getResponseFreshness()

Gets the allowed OCSP Response freshness. If the response was created within this time, the response is accepted.

Specified by:

getResponseFreshness in interface OCSPPreferences

Returns:

Returns the responseFreshness.

setResponseFreshness

public void setResponseFreshness(long responseFreshness)

Sets the allowed OCSP Response freshness. If the response was created within this time, the response is accepted.

Parameters:

responseFreshness - The responseFreshness to set.

getSendNonce

public boolean getSendNonce()

Gets Whether a nonce should be a part of the OCSP request.

Specified by:

getSendNonce in interface OCSPPreferences

Returns:

Whether a nonce should be a part of the OCSP request.

setSendNonce

public void setSendNonce(boolean sendNonce)

Sets Whether a nonce should be a part of the OCSP request.

Parameters:

sendNonce - Whether a nonce should be a part of the OCSP request.

getURLtoConsult

public OCSPURLtoConsultOption getURLtoConsult()

Gets The type of OCSP Server URL to use for fetching revocation information

Specified by:

getURLtoConsult in interface OCSPPreferences

Returns:

The type of OCSP Server URL to use for fetching revocation information.

setURLtoConsult

public void setURLtoConsult(OCSPURLtoConsultOption urlToConsult)

Sets The type of OCSP Server URL to use for fetching revocation information

Parameters:

urlToConsult - The type of OCSP Server URL to use for fetching revocation information

setDigestAlgorithm

public void setDigestAlgorithm(HashAlgorithm algo)

getDigestAlgorithm

public HashAlgorithm getDigestAlgorithm()

Description copied from interface: OCSPPreferences

Digest Algorithm to be used for OCSPRequests CertID

Specified by:

getDigestAlgorithm in interface OCSPPreferences

setUseCache

public void setUseCache(boolean value)

getUseCache

public boolean getUseCache()

Description copied from interface: OCSPPreferences

Indicates if OCSP Response needs to be cached/used till OCSP nextUpdate

Specified by:

getUseCache in interface OCSPPreferences

Returns:

- if OCSP Response needs to be cached/used till OCSP nextUpdate

setIgnoreValidityDates

public void setIgnoreValidityDates(boolean value)

getIgnoreValidityDates

public boolean getIgnoreValidityDates()

Description copied from interface: OCSPPreferences

Indicates if OCSP validity needs to be honored

Specified by:

getIgnoreValidityDates in interface OCSPPreferences

Returns:

if OCSP validity needs to be honored

setGoOnline

public void setGoOnline(boolean value)

getGoOnline

public boolean getGoOnline()

Description copied from interface: OCSPPreferences

Indicates if online OCSP server can be contacted for revocation information

Specified by:

getGoOnline in interface OCSPPreferences

Returns:

if online OCSP server can be contacted for revocation information

setAllowOCSPNoCheck

public void setAllowOCSPNoCheck(boolean value)

getAllowOCSPNoCheck

public boolean getAllowOCSPNoCheck()

Description copied from interface: OCSPPreferences

Allow OCSP NoCheck Extension

Specified by:

getAllowOCSPNoCheck in interface OCSPPreferences

Returns:

Allow OCSP NoCheck Extensions

setRequireOCSPCertHash

public void setRequireOCSPCertHash(boolean value)

getRequireOCSPCertHash

public boolean getRequireOCSPCertHash()

Description copied from interface: OCSPPreferences

Indicates if OCSP Response CertID needs to be have certificate hash

Specified by:

getRequireOCSPCertHash in interface OCSPPreferences

Returns:

if OCSP Response CertID needs to be have certificate hash

newInstance

public PreferencesMap newInstance()

Description copied from class: PreferencesMap

Get the new instance of the type

Specified by:

newInstance in class PreferencesMap

Returns:

new instance of the type

createChild

protected PreferencesMap createChild(String myKey)

Specified by:

createChild in class PreferencesMap

getNonCloneableKeys

protected String[] getNonCloneableKeys()

Overrides:

getNonCloneableKeys in class PreferencesMap