Package org.ldaptive.auth
Class AbstractAuthenticationHandler
java.lang.Object
org.ldaptive.auth.AbstractAuthenticationHandler
- All Implemented Interfaces:
AuthenticationHandler,ConnectionFactoryManager
- Direct Known Subclasses:
CompareAuthenticationHandler,SimpleBindAuthenticationHandler
public abstract class AbstractAuthenticationHandler
extends Object
implements AuthenticationHandler, ConnectionFactoryManager
Base class for an LDAP authentication implementations.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate RequestControl[]controls used by this handler.private ConnectionFactoryConnection factory.protected final org.slf4j.LoggerLogger for this class. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionPerform an ldap authentication.protected abstract AuthenticationHandlerResponseauthenticateInternal(Connection c, AuthenticationCriteria criteria) Authenticate on the supplied connection using the supplied criteria.Returns the controls for this authentication handler.Returns the connection factory.protected RequestControl[]processRequestControls(AuthenticationCriteria criteria) Combines request controls in theAuthenticationRequestwithauthenticationControls.voidsetAuthenticationControls(RequestControl... cntrls) Sets the controls for this authentication handler.voidSets the connection factory.
-
Field Details
-
logger
protected final org.slf4j.Logger loggerLogger for this class. -
factory
Connection factory. -
authenticationControls
controls used by this handler.
-
-
Constructor Details
-
AbstractAuthenticationHandler
public AbstractAuthenticationHandler()
-
-
Method Details
-
getConnectionFactory
Description copied from interface:ConnectionFactoryManagerReturns the connection factory.- Specified by:
getConnectionFactoryin interfaceConnectionFactoryManager- Returns:
- connection factory
-
setConnectionFactory
Description copied from interface:ConnectionFactoryManagerSets the connection factory.- Specified by:
setConnectionFactoryin interfaceConnectionFactoryManager- Parameters:
cf- connection factory
-
getAuthenticationControls
Returns the controls for this authentication handler.- Returns:
- controls
-
setAuthenticationControls
Sets the controls for this authentication handler.- Parameters:
cntrls- controls to set
-
authenticate
Description copied from interface:AuthenticationHandlerPerform an ldap authentication.- Specified by:
authenticatein interfaceAuthenticationHandler- Parameters:
ac- to perform the authentication with- Returns:
- authentication handler response
- Throws:
LdapException- if ldap operation fails
-
authenticateInternal
protected abstract AuthenticationHandlerResponse authenticateInternal(Connection c, AuthenticationCriteria criteria) throws LdapException Authenticate on the supplied connection using the supplied criteria.- Parameters:
c- to authenticate oncriteria- criteria to authenticate with- Returns:
- authentication handler response
- Throws:
LdapException- if the authentication fails
-
processRequestControls
Combines request controls in theAuthenticationRequestwithauthenticationControls.- Parameters:
criteria- containing request controls- Returns:
- combined request controls or null
-