org.apache.ldap.server.authn
Interface Authenticator

All Known Implementing Classes:
AbstractAuthenticator, AnonymousAuthenticator, SimpleAuthenticator

public interface Authenticator

Authenticates users who access DirectoryPartitionNexus.

Authenticators are registered to and configured by AuthenticationService interceptor.

AuthenticationService authenticates users by calling authenticate(ServerContext), and then Authenticator checks JNDI Context environment properties (Context.SECURITY_PRINCIPAL and Context.SECURITY_CREDENTIALS) of current Context.

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

Method Summary
 LdapPrincipal authenticate(ServerContext ctx)
          Performs authentication and returns the principal if succeeded.
 void destroy()
          Called by AuthenticationService to indicate that this authenticator is being removed from service.
 java.lang.String getAuthenticatorType()
          Returns the type of this authenticator (e.g.
 void init(DirectoryServiceConfiguration factoryCfg, AuthenticatorConfiguration cfg)
          Called by AuthenticationService to indicate that this authenticator is being placed into service.
 

Method Detail

getAuthenticatorType

java.lang.String getAuthenticatorType()
Returns the type of this authenticator (e.g. 'simple', 'none',...).


init

void init(DirectoryServiceConfiguration factoryCfg,
          AuthenticatorConfiguration cfg)
          throws javax.naming.NamingException
Called by AuthenticationService to indicate that this authenticator is being placed into service.

Throws:
javax.naming.NamingException

destroy

void destroy()
Called by AuthenticationService to indicate that this authenticator is being removed from service.


authenticate

LdapPrincipal authenticate(ServerContext ctx)
                           throws javax.naming.NamingException
Performs authentication and returns the principal if succeeded.

Throws:
javax.naming.NamingException