org.ldaptive.provider

Class AbstractProviderConnectionFactory<T extends ProviderConfig>

java.lang.Object

org.ldaptive.provider.AbstractProviderConnectionFactory<T>

Type Parameters:

T - type of provider config for this connection factory

All Implemented Interfaces:

ProviderConnectionFactory<T>

Direct Known Subclasses:

AbstractJLdapConnectionFactory, ApacheLdapConnectionFactory, JndiConnectionFactory, JndiStartTLSConnectionFactory, OpenDJConnectionFactory, UnboundIDConnectionFactory, UnboundIDStartTLSConnectionFactory

public abstract class AbstractProviderConnectionFactory<T extends ProviderConfig>
extends Object
implements ProviderConnectionFactory<T>

Provides a basic implementation for other connection factories to inherit.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AbstractProviderConnectionFactory.DefaultConnectionFactoryMetadata Provides an object to track the connection count.

Field Summary

Fields

Modifier and Type	Field and Description
private ConnectionStrategy	connectionStrategy Connection strategy.
protected Logger	logger Logger for this class.
private AbstractProviderConnectionFactory.DefaultConnectionFactoryMetadata	metadata Factory metadata.
private T	providerConfig Provider configuration.

Constructor Summary

Constructors

Constructor and Description
AbstractProviderConnectionFactory(String url, ConnectionStrategy strategy, T config) Creates a new abstract connection factory.

Method Summary

Modifier and Type	Method and Description
ProviderConnection	create() Create a connection to an LDAP.
protected abstract ProviderConnection	createInternal(String url) Create the provider connection and prepare the connection for use.
protected ConnectionFactoryMetadata	getMetadata() Returns the connection factory metadata.
T	getProviderConfig() Returns the provider configuration.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Logger logger

Logger for this class.

providerConfig

private final T extends ProviderConfig providerConfig

Provider configuration.

metadata

private final AbstractProviderConnectionFactory.DefaultConnectionFactoryMetadata metadata

Factory metadata.

connectionStrategy

private final ConnectionStrategy connectionStrategy

Connection strategy.

Constructor Detail

AbstractProviderConnectionFactory

public AbstractProviderConnectionFactory(String url,
                                         ConnectionStrategy strategy,
                                         T config)

Creates a new abstract connection factory. Once invoked the supplied provider config is made immutable. See AbstractConfig.makeImmutable().

Parameters:

url - of the ldap to connect to

strategy - connection strategy

config - provider configuration

Method Detail

getProviderConfig

public T getProviderConfig()

Description copied from interface: ProviderConnectionFactory

Returns the provider configuration.

Specified by:

getProviderConfig in interface ProviderConnectionFactory<T extends ProviderConfig>

Returns:

provider configuration

getMetadata

protected ConnectionFactoryMetadata getMetadata()

Returns the connection factory metadata.

Returns:

metadata

create

public ProviderConnection create()
                          throws LdapException

Description copied from interface: ProviderConnectionFactory

Create a connection to an LDAP.

Specified by:

create in interface ProviderConnectionFactory<T extends ProviderConfig>

Returns:

provider connection

Throws:

LdapException - if an LDAP error occurs

createInternal

protected abstract ProviderConnection createInternal(String url)
                                              throws LdapException

Create the provider connection and prepare the connection for use.

Parameters:

url - to connect to

Returns:

provider connection

Throws:

LdapException - if a connection cannot be established

toString

public String toString()

Overrides:

toString in class Object