org.apache.directory.server.core.authn

Class AuthenticationInterceptor

java.lang.Object

org.apache.directory.server.core.api.interceptor.BaseInterceptor

org.apache.directory.server.core.authn.AuthenticationInterceptor

All Implemented Interfaces:

Interceptor

public class AuthenticationInterceptor
extends BaseInterceptor

An Interceptor that authenticates users.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.core.api.interceptor.BaseInterceptor

directoryService, dnFactory, PWD_POLICY_STATE_ATTRIBUTE_TYPES, schemaManager

Constructor Summary

Constructors

Constructor and Description
AuthenticationInterceptor() Creates an authentication service interceptor.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Filters Partition#add( AddOperationContext ) call.
void	bind(BindOperationContext bindContext) Filters Partition#bind( BindOperationContext ) call.
boolean	compare(CompareOperationContext compareContext) Filters DefaultPartitionNexus#compare( CompareOperationContext ) call.
void	delete(DeleteOperationContext deleteContext) Filters Partition#delete( DeleteOperationContext ) call.
void	destroy() Deinitializes and deregisters all Authenticators from this service.
Set<Authenticator>	getAuthenticators()
PasswordPolicyConfiguration	getPwdPolicy(org.apache.directory.api.ldap.model.entry.Entry userEntry) Gets the effective password policy of the given entry.
PpolicyConfigContainer	getPwdPolicyContainer()
org.apache.directory.api.ldap.model.entry.Entry	getRootDse(GetRootDseOperationContext getRootDseContext) Filters DefaultPartitionNexus#getRootDse( GetRootDseOperationContext ) call.
boolean	hasEntry(HasEntryOperationContext hasEntryContext) Filters Partition#hasEntry( HasEntryOperationContext ) call.
void	init(DirectoryService directoryService) Registers and initializes all Authenticators to this service.
boolean	isPwdPolicyEnabled()
void	loadPwdPolicyStateAttributeTypes() Initialize the PasswordPolicy attributeTypes
org.apache.directory.api.ldap.model.entry.Entry	lookup(LookupOperationContext lookupContext) Filters Partition#lookup( LookupOperationContext ) call.
void	modify(ModifyOperationContext modifyContext) Filters Partition#modify( ModifyOperationContext ) call.
void	move(MoveOperationContext moveContext) Filters Partition#move( MoveOperationContext ) call.
void	moveAndRename(MoveAndRenameOperationContext moveAndRenameContext) Filters Partition#moveAndRename( MoveAndRenameOperationContext) call.
void	rename(RenameOperationContext renameContext) Filters Partition#rename( RenameOperationContext ) call.
EntryFilteringCursor	search(SearchOperationContext searchContext) Filters Partition#search( SearchOperationContext ) call.
void	setAuthenticators(Authenticator[] authenticators)
void	setAuthenticators(Set<Authenticator> authenticators)
void	setPwdPolicies(PpolicyConfigContainer policyContainer) set all the password policies to be used by the server.
void	setPwdPolicyContainer(PpolicyConfigContainer pwdPolicyContainer)
void	unbind(UnbindOperationContext unbindContext) Filters Partition#unbind( UnbindOperationContext ) call.

Methods inherited from class org.apache.directory.server.core.api.interceptor.BaseInterceptor

getName, getNextInterceptor, getPrincipal, next, next, next, next, next, next, next, next, next, next, next, next, next

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationInterceptor

public AuthenticationInterceptor()

Creates an authentication service interceptor.

Method Detail

init

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

Registers and initializes all Authenticators to this service.

Specified by:

init in interface Interceptor

Overrides:

init in class BaseInterceptor

Throws:

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

getAuthenticators

public Set<Authenticator> getAuthenticators()

setAuthenticators

public void setAuthenticators(Set<Authenticator> authenticators)

Parameters:

authenticators - authenticators to be used by this AuthenticationInterceptor

setAuthenticators

public void setAuthenticators(Authenticator[] authenticators)

Parameters:

authenticators - authenticators to be used by this AuthenticationInterceptor

destroy

public void destroy()

Deinitializes and deregisters all Authenticators from this service.

Specified by:

destroy in interface Interceptor

Overrides:

destroy in class BaseInterceptor

add

public void add(AddOperationContext addContext)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#add( AddOperationContext ) call.

Specified by:

add in interface Interceptor

Overrides:

add in class BaseInterceptor

Parameters:

addContext - The AddOperationContext instance

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If we had some error while processing the Add operation

bind

public void bind(BindOperationContext bindContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#bind( BindOperationContext ) call.

Specified by:

bind in interface Interceptor

Overrides:

bind in class BaseInterceptor

Throws:

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

compare

public boolean compare(CompareOperationContext compareContext)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Filters DefaultPartitionNexus#compare( CompareOperationContext ) call.

Specified by:

compare in interface Interceptor

Overrides:

compare in class BaseInterceptor

Throws:

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

delete

public void delete(DeleteOperationContext deleteContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#delete( DeleteOperationContext ) call.

Specified by:

delete in interface Interceptor

Overrides:

delete in class BaseInterceptor

Throws:

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

getRootDse

public org.apache.directory.api.ldap.model.entry.Entry getRootDse(GetRootDseOperationContext getRootDseContext)
                                                           throws org.apache.directory.api.ldap.model.exception.LdapException

Filters DefaultPartitionNexus#getRootDse( GetRootDseOperationContext ) call.

Specified by:

getRootDse in interface Interceptor

Overrides:

getRootDse in class BaseInterceptor

Parameters:

getRootDseContext - The getRoot() operation context

Returns:

The RootDSE entry, if found

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If we can't get back the RootDSE entry

hasEntry

public boolean hasEntry(HasEntryOperationContext hasEntryContext)
                 throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#hasEntry( HasEntryOperationContext ) call.

Specified by:

hasEntry in interface Interceptor

Overrides:

hasEntry in class BaseInterceptor

Throws:

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

lookup

public org.apache.directory.api.ldap.model.entry.Entry lookup(LookupOperationContext lookupContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#lookup( LookupOperationContext ) call.

Specified by:

lookup in interface Interceptor

Overrides:

lookup in class BaseInterceptor

Throws:

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

modify

public void modify(ModifyOperationContext modifyContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#modify( ModifyOperationContext ) call.

Specified by:

modify in interface Interceptor

Overrides:

modify in class BaseInterceptor

Throws:

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

move

public void move(MoveOperationContext moveContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#move( MoveOperationContext ) call.

Specified by:

move in interface Interceptor

Overrides:

move in class BaseInterceptor

Throws:

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

moveAndRename

public void moveAndRename(MoveAndRenameOperationContext moveAndRenameContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#moveAndRename( MoveAndRenameOperationContext) call.

Specified by:

moveAndRename in interface Interceptor

Overrides:

moveAndRename in class BaseInterceptor

Throws:

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

rename

public void rename(RenameOperationContext renameContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#rename( RenameOperationContext ) call.

Specified by:

rename in interface Interceptor

Overrides:

rename in class BaseInterceptor

Throws:

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

search

public EntryFilteringCursor search(SearchOperationContext searchContext)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#search( SearchOperationContext ) call.

Specified by:

search in interface Interceptor

Overrides:

search in class BaseInterceptor

Throws:

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

unbind

public void unbind(UnbindOperationContext unbindContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#unbind( UnbindOperationContext ) call.

Specified by:

unbind in interface Interceptor

Overrides:

unbind in class BaseInterceptor

Throws:

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

loadPwdPolicyStateAttributeTypes

public void loadPwdPolicyStateAttributeTypes()
                                      throws org.apache.directory.api.ldap.model.exception.LdapException

Initialize the PasswordPolicy attributeTypes

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the initialization failed

getPwdPolicy

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

Gets the effective password policy of the given entry. If the entry has defined a custom password policy by setting "pwdPolicySubentry" attribute then the password policy associated with the Dn specified at the above attribute's value will be returned. Otherwise the default password policy will be returned (if present)

Parameters:

userEntry - the user's entry

Returns:

the associated password policy

Throws:

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

setPwdPolicies

public void setPwdPolicies(PpolicyConfigContainer policyContainer)

set all the password policies to be used by the server. This includes a default(i.e applicable to all entries) and custom(a.k.a per user) password policies

Parameters:

policyContainer - the container holding all the password policies

isPwdPolicyEnabled

public boolean isPwdPolicyEnabled()

getPwdPolicyContainer

public PpolicyConfigContainer getPwdPolicyContainer()

Returns:

the pwdPolicyContainer

setPwdPolicyContainer

public void setPwdPolicyContainer(PpolicyConfigContainer pwdPolicyContainer)

Parameters:

pwdPolicyContainer - the pwdPolicyContainer to set