org.ldaptive.provider.jldap

Class AbstractJLdapConnectionFactory<T extends JLdapConnection>

java.lang.Object

org.ldaptive.provider.AbstractProviderConnectionFactory<JLdapProviderConfig>

org.ldaptive.provider.jldap.AbstractJLdapConnectionFactory<T>

Type Parameters:

T - type of jldap connection

All Implemented Interfaces:

ProviderConnectionFactory<JLdapProviderConfig>

Direct Known Subclasses:

JLdapConnectionFactory, JLdapSSLConnectionFactory, JLdapStartTLSConnectionFactory

public abstract class AbstractJLdapConnectionFactory<T extends JLdapConnection>
extends AbstractProviderConnectionFactory<JLdapProviderConfig>

Base class for JLDAP connection factory implementations.

Field Summary

Fields

Modifier and Type	Field and Description
private com.novell.ldap.LDAPConstraints	ldapConstraints JLdap connection constraints.
private Duration	socketTimeOut Amount of time in milliseconds that operations will wait.

Fields inherited from class org.ldaptive.provider.AbstractProviderConnectionFactory

logger

Constructor Summary

Constructors

Constructor and Description
AbstractJLdapConnectionFactory(String url, ConnectionStrategy strategy, JLdapProviderConfig config, com.novell.ldap.LDAPConstraints constraints, Duration timeOut) Creates a new abstract jldap connection factory.

Method Summary

Modifier and Type	Method and Description
protected T	createInternal(String url) Create the provider connection and prepare the connection for use.
protected abstract T	createJLdapConnection(com.novell.ldap.LDAPConnection conn, JLdapProviderConfig config) Creates a jldap connection of the appropriate type for this connection factory.
protected abstract com.novell.ldap.LDAPConnection	createLDAPConnection() Creates an ldap connection for use with this connection factory.
protected void	initializeConnection(com.novell.ldap.LDAPConnection conn) Initialize the supplied connection after a connection has been established.

Methods inherited from class org.ldaptive.provider.AbstractProviderConnectionFactory

create, getMetadata, getProviderConfig, toString

Methods inherited from class java.lang.Object

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

Field Detail

ldapConstraints

private final com.novell.ldap.LDAPConstraints ldapConstraints

JLdap connection constraints.

socketTimeOut

private final Duration socketTimeOut

Amount of time in milliseconds that operations will wait.

Constructor Detail

AbstractJLdapConnectionFactory

public AbstractJLdapConnectionFactory(String url,
                                      ConnectionStrategy strategy,
                                      JLdapProviderConfig config,
                                      com.novell.ldap.LDAPConstraints constraints,
                                      Duration timeOut)

Creates a new abstract jldap connection factory.

Parameters:

url - of the ldap to connect to

strategy - connection strategy

config - provider configuration

constraints - connection constraints

timeOut - time in milliseconds that operations will wait

Method Detail

createInternal

protected T createInternal(String url)
                    throws LdapException

Description copied from class: AbstractProviderConnectionFactory

Create the provider connection and prepare the connection for use.

Specified by:

createInternal in class AbstractProviderConnectionFactory<JLdapProviderConfig>

Parameters:

url - to connect to

Returns:

provider connection

Throws:

LdapException - if a connection cannot be established

createLDAPConnection

protected abstract com.novell.ldap.LDAPConnection createLDAPConnection()
                                                                throws com.novell.ldap.LDAPException

Creates an ldap connection for use with this connection factory.

Returns:

ldap connection

Throws:

com.novell.ldap.LDAPException - if an error occurs creating the connection

initializeConnection

protected void initializeConnection(com.novell.ldap.LDAPConnection conn)
                             throws com.novell.ldap.LDAPException

Initialize the supplied connection after a connection has been established.

Parameters:

conn - to initialize

Throws:

com.novell.ldap.LDAPException - if an error occurs initializing the connection

createJLdapConnection

protected abstract T createJLdapConnection(com.novell.ldap.LDAPConnection conn,
                                           JLdapProviderConfig config)

Creates a jldap connection of the appropriate type for this connection factory.

Parameters:

conn - to create jldap connection with

config - provider configuration

Returns:

jldap connection