Package com.nimbusds.common.ldap

Class PresetLDAPConnectionFactory

java.lang.Object

com.nimbusds.common.ldap.LDAPConnectionFactory

com.nimbusds.common.ldap.PresetLDAPConnectionFactory

public class PresetLDAPConnectionFactory
extends LDAPConnectionFactory

Factory for establishing LDAP connections to a preset directory server.

Constructor Summary

Constructors

Constructor	Description
PresetLDAPConnectionFactory(LDAPServerDetails ldapServer, CustomTrustStoreConfiguration customTrustStore, CustomKeyStoreConfiguration customKeyStore)	Creates a new preset LDAP connection factory.

Method Summary

Modifier and Type	Method	Description
com.unboundid.ldap.sdk.LDAPConnection	createLDAPConnection()	Creates a new LDAP connection to the preset directory server.
LDAPServerDetails	getLDAPServerDetails()	Gets the LDAP server details.

Methods inherited from class com.nimbusds.common.ldap.LDAPConnectionFactory

createLDAPConnection, createLDAPConnection, getCustomKeyStoreConfiguration, getCustomTrustStoreConfiguration, getSocketFactory, initSecureConnectionContext

Methods inherited from class java.lang.Object

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

Constructor Details

PresetLDAPConnectionFactory

public PresetLDAPConnectionFactory(LDAPServerDetails ldapServer,
 CustomTrustStoreConfiguration customTrustStore,
 CustomKeyStoreConfiguration customKeyStore)
                            throws LDAPConnectionException

Creates a new preset LDAP connection factory.

Parameters:

ldapServer - The LDAP server details. Must not be null.

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

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

Throws:

LDAPConnectionException - If a SSL socket factory is required and couldn't be established.

Method Details

getLDAPServerDetails

public LDAPServerDetails getLDAPServerDetails()

Gets the LDAP server details.

Returns:

The LDAP server details.

createLDAPConnection

public com.unboundid.ldap.sdk.LDAPConnection createLDAPConnection()
                                                           throws LDAPConnectionException

Creates a new LDAP connection to the preset directory server.

Returns:

A new established unauthenticated LDAP connection ready for use.

Throws:

LDAPConnectionException - If a new LDAP connection could not be created.