AuthenticationHandler (VT LDAP Libraries 3.3.8 API)

All Known Implementing Classes:

AbstractAuthenticationHandler, BindAuthenticationHandler, CompareAuthenticationHandler
```
public interface AuthenticationHandler
```
AuthenticationHandler provides an interface for LDAP authentication implementations.

Version:

$Revision: 1330 $

Author:

Middleware Services

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`authenticate(ConnectionHandler ch, AuthenticationCriteria ac)`	Perform an ldap authentication.
`AuthenticationHandler`	`newInstance()`	Returns a separate instance of this authentication handler.
`void`	`setAuthenticatorConfig(AuthenticatorConfig ac)`	Sets the authenticator configuration.

- Method Detail
  - setAuthenticatorConfig
```
void setAuthenticatorConfig(AuthenticatorConfig ac)
```
    Sets the authenticator configuration.
    
    Parameters:
    
    ac - authenticator config
  - authenticate
```
void authenticate(ConnectionHandler ch,
                  AuthenticationCriteria ac)
           throws javax.naming.NamingException
```
    Perform an ldap authentication. Implementations should throw AuthenticationException to indicate an authentication failure. The resulting LdapContext can be retrieved from the connection handler if it is needed.
    
    Parameters:
    
    ch - ConnectionHandler to communicate with the LDAP
    
    ac - AuthenticationCriteria to perform the authentication with
    
    Throws:
    
    AuthenticationException - if authentication fails
    
    javax.naming.NamingException - if an LDAP error occurs
  - newInstance
```
AuthenticationHandler newInstance()
```
    Returns a separate instance of this authentication handler.
    
    Returns:
    
    authentication handler