com.entrust.toolkit.x509.revocation

Class CRLConfig

java.lang.Object

com.entrust.toolkit.x509.revocation.CRLConfig

public class CRLConfig
extends java.lang.Object

CRLConfig is a class used for carrying configuration information specific to CRL revocation.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
CRLConfig(RevocationStore[] revStores, boolean requireCRL) Create a CRL configuration with an array of RevocationStore objects.
CRLConfig(java.lang.String[] revStores, boolean requireCRL) Create a CRL configuration which consists of a list of fully qualified RevocationStore class names that will be used.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Test if the CRLConfigs are equal.
boolean	getEnableOfflineLookup() This API is used to enable offline lookup for all RevocationStores configure by this object.
boolean	getRequireCRL() Return whether or not a CRL is Required
java.lang.String[]	getRevocationStoreClassNames() Returns a List of RevocationStore class names that this class encapsulates
RevocationStore[]	getRevocationStores(ValidationInfo validationInfo) Returns a List of RevocationStore objects that this class encapsulates.
int	hashCode() Returns a hash code value for the object.
void	setEnableOfflineLookup(boolean enableOfflineLookup) This API is used to enable offline lookup for all RevocationStores configure by this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CRLConfig

public CRLConfig(java.lang.String[] revStores,
                 boolean requireCRL)

Create a CRL configuration which consists of a list of fully qualified RevocationStore class names that will be used. For example, to configure the default configuration setting (which is used when no CRLConfig has been set), it could be configured as follows:

 String revocationStores[] = new String[]{
                                 "com.entrust.toolkit.x509.revocation.CachedCRLRS",
                                 "com.entrust.toolkit.x509.revocation.DirectoryCRLRS",
                                 "com.entrust.toolkit.x509.revocation.HttpCRLRS"};
 or possibly:

 String revocationStores[]{CachedCRLRS.class.getName(),
                           DirectoryCRLRS.class.getName(),
                           HttpCRLRS.class.getName()}

 CRLConfig config = new CRLConfig(revocationStores, true);
 

Note: When this configuration is used, the classes will be loaded by reflection, using a Constructor that takes a ValidationInfo as a parameter. Therefore, if a custom CRL revocation store is used, it must contain a Constructor that takes a ValidationInfo object as a constructor otherwise it will fail to load.

Parameters:

revStores - the array of fully qualified class names

requireCRL - value to determine if CRLs are required.

Since:

8.0

CRLConfig

public CRLConfig(RevocationStore[] revStores,
                 boolean requireCRL)

Create a CRL configuration with an array of RevocationStore objects. For example:

 User user = new User();
 ....
 user.login(credentialReader, password);
 ValidationInfo validationInfo = User.getCertVerifier();
 RevocationStore revocationStores[] = new RevocationStore[] { 
                                          new CachedCRLRS(validationInfo),
                                          new DirectoryCRLRS(validationInfo),
                                          new HttpCRLRS(validationInfo)
                                      };
 CRLConfig config = new CRLConfig(revocationStores, true);
 

Parameters:

revStores - The array of RevocationStores to use for CRL revoation checking

requireCRL - value to determine if CRLs are required.

Since:

8.0

Method Detail

getRevocationStoreClassNames

public java.lang.String[] getRevocationStoreClassNames()

Returns a List of RevocationStore class names that this class encapsulates

Returns:

A List of RevocationStore objects

Since:

8.0

getRevocationStores

public RevocationStore[] getRevocationStores(ValidationInfo validationInfo)

Returns a List of RevocationStore objects that this class encapsulates.

Note: This method may use reflection to load the RevocationStore objects. Reflection will be used if the constructor CRLConfig(String[], boolean) was used and this method has not been called previously.

Parameters:

validationInfo - object used to construct

Returns:

A List of RevocationStore objects

Since:

8.0

getRequireCRL

public boolean getRequireCRL()

Return whether or not a CRL is Required

Returns:

true if CRL's are required, false otherwise.

setEnableOfflineLookup

public void setEnableOfflineLookup(boolean enableOfflineLookup)

This API is used to enable offline lookup for all RevocationStores configure by this object. A toolkit user is considered to be offline when no LdapDirectory has been configured in the User via the User.setConnections(String) method. The default setting is false.

Note: When this method is set to false, it does nothing. Individual RevocationStores may have offline lookup enabled or disabled as required.

See Also:

RevocationStore.enableOfflineLookup(boolean)

getEnableOfflineLookup

public boolean getEnableOfflineLookup()

This API is used to enable offline lookup for all RevocationStores configure by this object. A toolkit user is considered to be offline when no LdapDirectory has been configured in the User via the User.setConnections(String) method. The default setting is false.

Note: When this method is set to false, it does nothing. Individual RevocationStores may have offline lookup enabled or disabled as required.

See Also:

RevocationStore.enableOfflineLookup(boolean)

equals

public boolean equals(java.lang.Object obj)

Test if the CRLConfigs are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare for equality

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()