org.ldaptive.auth

Class CompareAuthenticationHandler

java.lang.Object

org.ldaptive.auth.AbstractAuthenticationHandler

org.ldaptive.auth.AbstractCompareAuthenticationHandler

org.ldaptive.auth.CompareAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler, ConnectionFactoryManager

public class CompareAuthenticationHandler
extends AbstractCompareAuthenticationHandler
implements ConnectionFactoryManager

Provides an LDAP authentication implementation that leverages a compare operation against the userPassword attribute. The default password scheme used is 'SHA'.

Nested Class Summary

Nested classes/interfaces inherited from class org.ldaptive.auth.AbstractCompareAuthenticationHandler

AbstractCompareAuthenticationHandler.Scheme

Field Summary

Fields

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

Fields inherited from class org.ldaptive.auth.AbstractCompareAuthenticationHandler

DEFAULT_ATTRIBUTE, DEFAULT_SCHEME

Fields inherited from class org.ldaptive.auth.AbstractAuthenticationHandler

logger

Constructor Summary

Constructors

Constructor and Description
CompareAuthenticationHandler() Default constructor.
CompareAuthenticationHandler(ConnectionFactory cf) Creates a new compare authentication handler.

Method Summary

Modifier and Type	Method and Description
protected Connection	getConnection() Returns a connection that the compare operation should be performed on.
ConnectionFactory	getConnectionFactory() Returns the connection factory.
void	setConnectionFactory(ConnectionFactory cf) Sets the connection factory.
String	toString()

Methods inherited from class org.ldaptive.auth.AbstractCompareAuthenticationHandler

authenticateInternal, digestCredential, getPasswordAttribute, getPasswordScheme, setPasswordAttribute, setPasswordScheme

Methods inherited from class org.ldaptive.auth.AbstractAuthenticationHandler

authenticate, getAuthenticationControls, processRequestControls, 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

CompareAuthenticationHandler

public CompareAuthenticationHandler()

Default constructor.

CompareAuthenticationHandler

public CompareAuthenticationHandler(ConnectionFactory cf)

Creates a new compare 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: AbstractCompareAuthenticationHandler

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

Specified by:

getConnection in class AbstractCompareAuthenticationHandler

Returns:

connection

Throws:

LdapException - if an error occurs provisioning the connection

toString

public String toString()

Overrides:

toString in class Object