Package com.nimbusds.common.ldap

Class LDAPConnectionPoolFactory

java.lang.Object

com.nimbusds.common.ldap.LDAPConnectionPoolFactory

public class LDAPConnectionPoolFactory
extends Object

Factory for establishing LDAP connection pools to a directory server.

Constructor Summary

Constructors

Constructor	Description
LDAPConnectionPoolFactory(LDAPServerConnectionPoolDetails ldapServer, CustomTrustStoreConfiguration customTrustStore, CustomKeyStoreConfiguration customKeyStore, DirectoryUser dirUser)	Creates a LDAP connection pool factory.

Method Summary

Modifier and Type	Method	Description
com.unboundid.ldap.sdk.LDAPConnectionPool	createLDAPConnectionPool()	Creates a new LDAP connection pool.

Methods inherited from class java.lang.Object

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

Constructor Details

LDAPConnectionPoolFactory

public LDAPConnectionPoolFactory(LDAPServerConnectionPoolDetails ldapServer,
 CustomTrustStoreConfiguration customTrustStore,
 CustomKeyStoreConfiguration customKeyStore,
 DirectoryUser dirUser)

Creates a LDAP connection pool factory.

Parameters:

ldapServer - The LDAP server connect details. Must specify a URL and must not be null.

customTrustStore - The custom trust store configuration. Must not be null.

customKeyStore - The custom key store configuration. Must not be null.

dirUser - The directory user to bind to for each LDAP connection. If null connections will be unauthenticated.

Method Details

createLDAPConnectionPool

public com.unboundid.ldap.sdk.LDAPConnectionPool createLDAPConnectionPool()
                                                                   throws GeneralSecurityException,
com.unboundid.ldap.sdk.LDAPException

Creates a new LDAP connection pool. No initial connections are established, to prevent connect exceptions if the backend is offline at the time the pool is created.

Returns:

The LDAP connection pool.

Throws:

KeyStoreException - If the key store could not be unlocked (for SSL/StartTLS connections).

GeneralSecurityException - On a general security exception (for SSL/StartTLS connections).

com.unboundid.ldap.sdk.LDAPException - If an LDAP exception is encountered (during creation of the initial pooled LDAP connections).