org.ldaptive.auth

Class PooledBindAuthenticationHandler

java.lang.Object

org.ldaptive.auth.AbstractAuthenticationHandler

org.ldaptive.auth.AbstractBindAuthenticationHandler

org.ldaptive.auth.PooledBindAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler, PooledConnectionFactoryManager

public class PooledBindAuthenticationHandler
extends AbstractBindAuthenticationHandler
implements PooledConnectionFactoryManager

Provides an LDAP authentication implementation that leverages a pool of LDAP connections to perform the LDAP bind operation.

Field Summary

Fields

Modifier and Type	Field and Description
private PooledConnectionFactory	factory Connection factory.

Fields inherited from class org.ldaptive.auth.AbstractAuthenticationHandler

logger

Constructor Summary

Constructors

Constructor and Description
PooledBindAuthenticationHandler() Default constructor.
PooledBindAuthenticationHandler(PooledConnectionFactory cf) Creates a new pooled bind authentication handler.

Method Summary

Modifier and Type	Method and Description
protected AuthenticationHandlerResponse	authenticateInternal(Connection c, AuthenticationCriteria criteria) Authenticate on the supplied connection using the supplied criteria.
protected Connection	getConnection() Returns a connection that the authentication operation should be performed on.
PooledConnectionFactory	getConnectionFactory() Returns the connection factory.
void	setConnectionFactory(PooledConnectionFactory cf) Sets the connection factory.
java.lang.String	toString()

Methods inherited from class org.ldaptive.auth.AbstractBindAuthenticationHandler

getAuthenticationSaslConfig, setAuthenticationSaslConfig

Methods inherited from class org.ldaptive.auth.AbstractAuthenticationHandler

authenticate, getAuthenticationControls, setAuthenticationControls

Methods inherited from class java.lang.Object

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

Field Detail

factory

private PooledConnectionFactory factory

Connection factory.

Constructor Detail

PooledBindAuthenticationHandler

public PooledBindAuthenticationHandler()

Default constructor.

PooledBindAuthenticationHandler

public PooledBindAuthenticationHandler(PooledConnectionFactory cf)

Creates a new pooled bind authentication handler.

Parameters:

cf - connection factory

Method Detail

getConnectionFactory

public PooledConnectionFactory getConnectionFactory()

Description copied from interface: PooledConnectionFactoryManager

Returns the connection factory.

Specified by:

getConnectionFactory in interface PooledConnectionFactoryManager

Returns:

connection factory

setConnectionFactory

public void setConnectionFactory(PooledConnectionFactory cf)

Description copied from interface: PooledConnectionFactoryManager

Sets the connection factory.

Specified by:

setConnectionFactory in interface PooledConnectionFactoryManager

Parameters:

cf - connection factory

getConnection

protected Connection getConnection()
                            throws LdapException

Description copied from class: AbstractAuthenticationHandler

Returns a connection that the authentication operation should be performed on.

Specified by:

getConnection in class AbstractAuthenticationHandler

Returns:

connection

Throws:

LdapException - if an error occurs provisioning the connection

authenticateInternal

protected AuthenticationHandlerResponse authenticateInternal(Connection c,
                                                             AuthenticationCriteria criteria)
                                                      throws LdapException

Description copied from class: AbstractAuthenticationHandler

Authenticate on the supplied connection using the supplied criteria.

Specified by:

authenticateInternal in class AbstractAuthenticationHandler

Parameters:

c - to authenticate on

criteria - criteria to authenticate with

Returns:

authentication handler response

Throws:

LdapException - if the authentication fails

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object