com.rsa.certj.provider.db

Class LDAPDatabase

java.lang.Object
  |
  +--com.rsa.certj.Provider
        |
        +--com.rsa.certj.provider.db.LDAPDatabase

public final class LDAPDatabase

extends Provider

This class implements an LDAP database service provider that is based on the Netscape Directory SDK 4.0 for Java. The LDAP database service provider can retrieve certificates and CRLs from an LDAP repository.

LDAP repositories vary widely on their schema and usage conventions. Cert-J addresses this problem by recording configuration information for each LDAP repository in a separate LDAPConfiguration object, and registering a separate database provider for each LDAP server.

The LDAP database provider implements all of the search functions in the Database SPI, except the search functions for private keys. The LDAP database provider is a read-only implementation of the Database SPI; it does not implement any write functions.

The LDAP database provider does not require any LDAP v3 functionality. All of the LDAP calls made are in the LDAP v2 specification. However, the LDAP database provider will operate with both v2 and v3 servers, because LDAP v3 is fully backward compatible with LDAP v2.

Searches may fail due to some constraints set either by the user or by the server. One example of such constraints is the maximum number of entries returned from a search. You can adjust the size limit inside a LDAPConfiguration object when you constructs an LDAPDatabase object. However, if the server side limit were set to a low value, setting it to a higher value from the client side would not take effect. In this case, you need to ask the server administrator to raise the limit.

Copyright © RSA Security Inc., 1999-2001. All rights reserved.

Constructor Summary

LDAPDatabase(String name, LDAPConfiguration configuration, String userDN, String password)

Constructs an LDAPDatabase object and initializes it with configuration information about the LDAP host, and the userDN and password that are used for authentication when connecting to the server.

Method Summary

ProviderImplementation

instantiate(CertJ certJ) Creates a ProviderImplementation object that handles LDAP database SPI methods.

Methods inherited from class com.rsa.certj.Provider

getName, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPDatabase

public LDAPDatabase(String name,
                    LDAPConfiguration configuration,
                    String userDN,
                    String password)
             throws InvalidParameterException

Constructs an LDAPDatabase object and initializes it with configuration information about the LDAP host, and the userDN and password that are used for authentication when connecting to the server.

Parameters

	name		A String that contains the database name.
	configuration		An LDAPConfiguration that holds configuration information.
	userDN		A String that contains the user DN to be used when connecting to the LDAP database server.
	password		A byte array that contains the password to be used when connecting to the LDAP database server.

Throws

InvalidParameterException - If configuration is null, or if userDN or password is null when authType of the configuration is LDAP_AUTH_SIMPLE.

Method Detail

instantiate

public ProviderImplementation instantiate(CertJ certJ)
                                   throws ProviderManagementException

Creates a ProviderImplementation object that handles LDAP database SPI methods. This method is called by CertJ.registerService when registering an object of the LDAPDatabase class; applications do not have to call this method.

Overrides

instantiate in class Provider

Parameters

certJ

A CertJ object for which the created provider is registered.

Returns

A ProviderImplementation object that handles the LDAP database SPI implementations.

Throws

ProviderManagementException - If instantiation of the LDAP database provider fails.