org.apache.directory.server.core.authn

Class AbstractAuthenticator

java.lang.Object

org.apache.directory.server.core.authn.AbstractAuthenticator

All Implemented Interfaces:

Authenticator

Direct Known Subclasses:

AnonymousAuthenticator, DelegatingAuthenticator, SimpleAuthenticator, StrongAuthenticator

public abstract class AbstractAuthenticator
extends java.lang.Object
implements Authenticator

Base class for all Authenticators.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.constants.AuthenticationLevel	authenticatorType authenticator type
private org.apache.directory.api.ldap.model.name.Dn	baseDn The base DN which will be the starting point from which we use the authenticator
private DirectoryService	directoryService The associated DirectoryService
protected static org.slf4j.Logger	LOG A logger for the extending classes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAuthenticator(org.apache.directory.api.ldap.model.constants.AuthenticationLevel type) Creates a new instance.
protected	AbstractAuthenticator(org.apache.directory.api.ldap.model.constants.AuthenticationLevel type, org.apache.directory.api.ldap.model.name.Dn baseDn) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	checkPwdPolicy(org.apache.directory.api.ldap.model.entry.Entry userEntry) performs checks on the given entry based on the specified password policy configuration
void	destroy() Calls doDestroy() method, and clears default properties (factoryConfiguration and configuration).
protected void	doDestroy() Implement your deinitialization code here.
protected void	doInit() Implement your initialization code here.
org.apache.directory.api.ldap.model.constants.AuthenticationLevel	getAuthenticatorType() Returns the type of this authenticator (e.g.
org.apache.directory.api.ldap.model.name.Dn	getBaseDn()
DirectoryService	getDirectoryService() Returns DirectoryService for this authenticator.
void	init(DirectoryService directoryService) Initializes (directoryService and and calls doInit() method.
void	invalidateCache(org.apache.directory.api.ldap.model.name.Dn bindDn) Does nothing leaving it so subclasses can override.
boolean	isValid(org.apache.directory.api.ldap.model.name.Dn bindDn) Check that this selector is a valid one.
void	setBaseDn(org.apache.directory.api.ldap.model.name.Dn baseDn) Set the baseDN into the Authenticator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.directory.server.core.authn.Authenticator

authenticate

Field Detail

LOG

protected static final org.slf4j.Logger LOG

A logger for the extending classes

directoryService

private DirectoryService directoryService

The associated DirectoryService

authenticatorType

private final org.apache.directory.api.ldap.model.constants.AuthenticationLevel authenticatorType

authenticator type

baseDn

private org.apache.directory.api.ldap.model.name.Dn baseDn

The base DN which will be the starting point from which we use the authenticator

Constructor Detail

AbstractAuthenticator

protected AbstractAuthenticator(org.apache.directory.api.ldap.model.constants.AuthenticationLevel type)

Creates a new instance.

Parameters:

type - the type of this authenticator (e.g. 'simple', 'none'...)

AbstractAuthenticator

protected AbstractAuthenticator(org.apache.directory.api.ldap.model.constants.AuthenticationLevel type,
                                org.apache.directory.api.ldap.model.name.Dn baseDn)

Creates a new instance.

Parameters:

type - the type of this authenticator (e.g. 'simple', 'none'...)

baseDn - The base DN for this authenticator

Method Detail

getDirectoryService

public DirectoryService getDirectoryService()

Returns DirectoryService for this authenticator.

Returns:

the directory service core

getAuthenticatorType

public org.apache.directory.api.ldap.model.constants.AuthenticationLevel getAuthenticatorType()

Returns the type of this authenticator (e.g. 'simple', 'none',...).

Specified by:

getAuthenticatorType in interface Authenticator

init

public final void init(DirectoryService directoryService)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Initializes (directoryService and and calls doInit() method. Please put your initialization code into doInit().

Specified by:

init in interface Authenticator

Parameters:

directoryService - the directory core for this authenticator

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there is a problem starting up the authenticator

doInit

protected void doInit()

Implement your initialization code here.

destroy

public final void destroy()

Calls doDestroy() method, and clears default properties (factoryConfiguration and configuration). Please put your deinitialization code into doDestroy().

Specified by:

destroy in interface Authenticator

doDestroy

protected void doDestroy()

Implement your deinitialization code here.

invalidateCache

public void invalidateCache(org.apache.directory.api.ldap.model.name.Dn bindDn)

Does nothing leaving it so subclasses can override.

Specified by:

invalidateCache in interface Authenticator

Parameters:

bindDn - the already normalized distinguished name of the bind principal

isValid

public boolean isValid(org.apache.directory.api.ldap.model.name.Dn bindDn)

Check that this selector is a valid one. The DN we want to authenticate has to be part of the DIT selection associated with teh Authenticator

Specified by:

isValid in interface Authenticator

Parameters:

bindDn - The DN we want to authenticate

Returns:

true if the Auhenticator is supporting the DN

getBaseDn

public org.apache.directory.api.ldap.model.name.Dn getBaseDn()

Specified by:

getBaseDn in interface Authenticator

Returns:

The Authenticator base DN

setBaseDn

public void setBaseDn(org.apache.directory.api.ldap.model.name.Dn baseDn)

Set the baseDN into the Authenticator

Specified by:

setBaseDn in interface Authenticator

Parameters:

baseDn - The Base DN to set

checkPwdPolicy

public void checkPwdPolicy(org.apache.directory.api.ldap.model.entry.Entry userEntry)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

performs checks on the given entry based on the specified password policy configuration

Specified by:

checkPwdPolicy in interface Authenticator

Parameters:

userEntry - the user entry to be checked for authentication

Throws:

org.apache.directory.api.ldap.model.exception.LdapException