org.ldaptive.auth

Class BindAuthenticationHandler

java.lang.Object

org.ldaptive.auth.AbstractAuthenticationHandler

org.ldaptive.auth.AbstractBindAuthenticationHandler

org.ldaptive.auth.BindAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler, ConnectionFactoryManager

public class BindAuthenticationHandler
extends AbstractBindAuthenticationHandler
implements ConnectionFactoryManager

Provides an LDAP authentication implementation that leverages the LDAP bind operation.

Field Summary

Fields

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

Fields inherited from class org.ldaptive.auth.AbstractAuthenticationHandler

logger

Constructor Summary

Constructors

Constructor and Description
BindAuthenticationHandler() Default constructor.
BindAuthenticationHandler(ConnectionFactory cf) Creates a new 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.
ConnectionFactory	getConnectionFactory() Returns the connection factory.
void	setConnectionFactory(ConnectionFactory 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 ConnectionFactory factory

Connection factory.

Constructor Detail

BindAuthenticationHandler

public BindAuthenticationHandler()

Default constructor.

BindAuthenticationHandler

public BindAuthenticationHandler(ConnectionFactory cf)

Creates a new bind authentication handler.

Parameters:

cf - connection factory

Method Detail

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Description copied from interface: ConnectionFactoryManager

Returns the connection factory.

Specified by:

getConnectionFactory in interface ConnectionFactoryManager

Returns:

connection factory

setConnectionFactory

public void setConnectionFactory(ConnectionFactory cf)

Description copied from interface: ConnectionFactoryManager

Sets the connection factory.

Specified by:

setConnectionFactory in interface ConnectionFactoryManager

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