org.apache.ldap.server.authn
Interface Authenticator

All Known Implementing Classes:
AbstractAuthenticator

public interface Authenticator

Defines methods that all Authenticators must implement.

An AuthenticationService is a program that performs client authentication based on the authentication method/type that the client specifies in the JNDI properties.

To implement this interface, you can write an authenticator that extends org.apache.ldap.server.authn.AbstractAuthenticator.

Version:
$Rev$
Author:
Apache Directory Project
See Also:
AbstractAuthenticator

Method Summary
 LdapPrincipal authenticate(ServerContext ctx)
          Perform the authentication operation and return the authorization id if successfull.
 AuthenticatorConfig getAuthenticatorConfig()
           
 java.lang.String getAuthenticatorType()
           
 void init(AuthenticatorConfig authenticatorConfig)
          Called by the authenticator container to indicate that the authenticator is being placed into service.
 

Method Detail

getAuthenticatorConfig

public AuthenticatorConfig getAuthenticatorConfig()

getAuthenticatorType

public java.lang.String getAuthenticatorType()

init

public void init(AuthenticatorConfig authenticatorConfig)
          throws javax.naming.NamingException
Called by the authenticator container to indicate that the authenticator is being placed into service.

Parameters:
authenticatorConfig -
Throws:
javax.naming.NamingException

authenticate

public LdapPrincipal authenticate(ServerContext ctx)
                           throws javax.naming.NamingException
Perform the authentication operation and return the authorization id if successfull.

Parameters:
ctx -
Returns:
the authorization id
Throws:
javax.naming.NamingException