com.entrust.toolkit.x509.directory

Class MultipleDirectories

java.lang.Object

com.entrust.toolkit.x509.directory.MultipleDirectories

All Implemented Interfaces:

LdapDirectory

public final class MultipleDirectories
extends java.lang.Object
implements LdapDirectory

Supports multiple directories and the ability to fail over from one to another when a directory is not available.

The directory entries in the entrust.ini file are passed to a User object using either of the following:

     User.login(CredentialReader credentialReader, SecureStringBuffer password)
     User.setConnections(String)
 

Alternatively, you can create a MultipleDirectories object with the directory entries as String objects formatted as follows:

     host1+port1,host2+port2,host3+port3,host4+port4
 

and passed to the user using User.setConnections(LdapDirectory, ManagerTransport).

See Also:

LdapDirectory, JNDIDirectory

Constructor Summary

Constructors

Constructor and Description
MultipleDirectories(IniFile entrustIniFile) Creates an instance of MultipleDirectories by parsing the Directory information from the given entrust.ini file.
MultipleDirectories(IniFile entrustIniFile, java.security.cert.X509Certificate[] certs) Creates an instance of MultipleDirectories by parsing the Directory information from the given entrust.ini file.
MultipleDirectories(MultipleDirectories directories) Copy constructor creates new object using existing parameters
MultipleDirectories(java.lang.String directories) Parses the given String into a list of host names and port numbers.

Method Summary

Modifier and Type	Method and Description
byte[][]	getAttr(java.lang.String dn, java.lang.String attributeToFind) Searches for the given attribute associated with the given DN.
X509CRL[]	getCRLs(java.lang.String distributionPoint, boolean wantARL) Searches for the CRLs or ARLs from the given distribution point.
JNDIDirectory	getDirectory() Returns the directory in use.
boolean	isAvailable() Determines whether a directory is available.
void	setClientCredentials(java.security.cert.X509Certificate verificationCertificate, java.security.cert.X509Certificate caCertificate, java.security.PrivateKey signingKey) Not available.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleDirectories

public MultipleDirectories(IniFile entrustIniFile)
                    throws java.text.ParseException

Creates an instance of MultipleDirectories by parsing the Directory information from the given entrust.ini file.

Parameters:

entrustIniFile - a parsed entrust.ini file

Throws:

java.text.ParseException - thrown if an error occurs in parsing the directory entries

Since:

7.0

MultipleDirectories

public MultipleDirectories(IniFile entrustIniFile,
                           java.security.cert.X509Certificate[] certs)
                    throws java.text.ParseException

Creates an instance of MultipleDirectories by parsing the Directory information from the given entrust.ini file.

Parameters:

entrustIniFile - a parsed entrust.ini file

certs - an array of trusted certificates which can be used for LDAPS connections

Throws:

java.text.ParseException - thrown if an error occurs in parsing the directory entries

Since:

7.2 patch

MultipleDirectories

public MultipleDirectories(java.lang.String directories)
                    throws java.text.ParseException

Parses the given String into a list of host names and port numbers.

Parameters:

directories - directory entries in the format host1+port1,host2+port2,host3+port3,host4+port4

Throws:

java.text.ParseException - thrown if an error occurs in parsing the directory entries

MultipleDirectories

public MultipleDirectories(MultipleDirectories directories)

Copy constructor creates new object using existing parameters

Parameters:

directories - a com.entrust.toolkit.x509.directory.MultipleDirectories object.

Method Detail

getAttr

public byte[][] getAttr(java.lang.String dn,
                        java.lang.String attributeToFind)
                 throws javax.naming.NamingException

Searches for the given attribute associated with the given DN.

If the current directory is not available, the method searches through the directories to find the first one available to perform the operation. It returns null if no attribute is found or no directory is available.

Specified by:

getAttr in interface LdapDirectory

Parameters:

dn - distinguished name of the entry

attributeToFind - attribute to be extracted from the entry

Returns:

The attributes as a byte array, or null if no attribute is found or no directory is available.

Throws:

javax.naming.NamingException - if the search expression is malformed or no directory can be connected to.

See Also:

LdapDirectory.getAttr(String, String), JNDIDirectory.getAttr(String, String)

getCRLs

public X509CRL[] getCRLs(java.lang.String distributionPoint,
                         boolean wantARL)
                  throws javax.naming.NamingException,
                         java.security.cert.CRLException

Searches for the CRLs or ARLs from the given distribution point.

If the current directory is not available, the method searches through the directories to find the first one available to perform the operation. It returns null if no directory is available.

Specified by:

getCRLs in interface LdapDirectory

Parameters:

distributionPoint - name of the distribution point

wantARL - flag indicating whether an ARL (true) or CRL (false) is required

Returns:

The array of CRLs or ARLs found at the distribution point; null if no CRL, ARL, nor directory are found.

Throws:

javax.naming.NamingException - if the search expression is malformed or no directory can be connected to.

java.security.cert.CRLException - if the retrieved CRLs cannot be parsed.

See Also:

LdapDirectory.getCRLs(String, boolean), JNDIDirectory.getCRLs(String, boolean)

isAvailable

public boolean isAvailable()

Determines whether a directory is available.

Specified by:

isAvailable in interface LdapDirectory

Returns:

true if a directory is available, false otherwise.

See Also:

LdapDirectory.isAvailable(), JNDIDirectory.isAvailable()

setClientCredentials

public void setClientCredentials(java.security.cert.X509Certificate verificationCertificate,
                                 java.security.cert.X509Certificate caCertificate,
                                 java.security.PrivateKey signingKey)

Not available.

Specified by:

setClientCredentials in interface LdapDirectory

Parameters:

verificationCertificate - a verification certificate

caCertificate - the CA certificate that issued verificationCertificate

signingKey - the private signing key that signs messages verified by verificationCertificate

getDirectory

public JNDIDirectory getDirectory()

Returns the directory in use.

Returns:

JNDIDirectory, the directory in use; null if no directory is available.