org.ldaptive.auth

Class AbstractCompareAuthenticationHandler

java.lang.Object

org.ldaptive.auth.AbstractAuthenticationHandler

org.ldaptive.auth.AbstractCompareAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler

Direct Known Subclasses:

CompareAuthenticationHandler, PooledCompareAuthenticationHandler

public abstract class AbstractCompareAuthenticationHandler
extends AbstractAuthenticationHandler

Provides implementation common to compare authentication handlers.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_SCHEME Default password scheme.
private java.lang.String	passwordScheme Password scheme.

Fields inherited from class org.ldaptive.auth.AbstractAuthenticationHandler

logger

Constructor Summary

Constructors

Constructor and Description
AbstractCompareAuthenticationHandler()

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 abstract Connection	getConnection() Returns a connection that the compare operation should be performed on.
java.lang.String	getPasswordScheme() Returns the password scheme.
void	setPasswordScheme(java.lang.String s) Sets the password scheme.

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, toString, wait, wait, wait

Field Detail

DEFAULT_SCHEME

protected static final java.lang.String DEFAULT_SCHEME

Default password scheme. Value is "SHA".

See Also:

Constant Field Values

passwordScheme

private java.lang.String passwordScheme

Password scheme.

Constructor Detail

AbstractCompareAuthenticationHandler

public AbstractCompareAuthenticationHandler()

Method Detail

getPasswordScheme

public java.lang.String getPasswordScheme()

Returns the password scheme.

Returns:

password scheme

setPasswordScheme

public void setPasswordScheme(java.lang.String s)

Sets the password scheme. Must equal a known message digest algorithm.

Parameters:

s - password scheme

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

getConnection

protected abstract Connection getConnection()
                                     throws LdapException

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

Specified by:

getConnection in class AbstractAuthenticationHandler

Returns:

connection

Throws:

LdapException - if an error occurs provisioning the connection