BaseInterceptor

java.lang.Object
- org.apache.directory.server.core.api.interceptor.BaseInterceptor

All Implemented Interfaces:

Interceptor

Direct Known Subclasses:

AciAuthorizationInterceptor, AdministrativePointInterceptor, AuthenticationInterceptor, ChangeLogInterceptor, CollectiveAttributeInterceptor, ConfigurableHashingInterceptor, DefaultAuthorizationInterceptor, DelayInducingInterceptor, EventInterceptor, ExceptionInterceptor, JournalInterceptor, KeyDerivationInterceptor, NormalizationInterceptor, NumberIncrementingInterceptor, OperationalAttributeInterceptor, PasswordHashingInterceptor, ReferralInterceptor, SchemaInterceptor, SubentryInterceptor, TimerInterceptor, TriggerInterceptor
```
public abstract class BaseInterceptor
extends java.lang.Object
implements Interceptor
```
A easy-to-use implementation of Interceptor. All methods are implemented to pass the flow of control to next interceptor by defaults. Please override the methods you have concern in.

Field Summary

Fields
Modifier and Type	Field and Description
`protected DirectoryService`	`directoryService` A reference to the DirectoryService instance
`protected DnFactory`	`dnFactory` The DN factory
`private Interceptor`	`finalInterceptor` The final interceptor which acts as a proxy in charge to dialog with the nexus partition.
`private java.lang.String`	`name` The interceptor's name.
`protected static java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeType>`	`PWD_POLICY_STATE_ATTRIBUTE_TYPES` set of operational attribute types used for representing the password policy state of a user entry
`protected org.apache.directory.api.ldap.model.schema.SchemaManager`	`schemaManager` A reference to the SchemaManager instance

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseInterceptor()` Creates a new instance with a default name : the class name itself.
`protected`	`BaseInterceptor(InterceptorEnum interceptor)` Creates a new instance with a given name.
`protected`	`BaseInterceptor(java.lang.String name)` Creates a new instance with a given name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` This method does nothing by default.
`java.lang.String`	`getName()` default interceptor name is its class, preventing accidental duplication of interceptors by naming instances differently
`protected Interceptor`	`getNextInterceptor(OperationContext operationContext)` Computes the next interceptor to call for a given operation.
`static LdapPrincipal`	`getPrincipal(OperationContext opContext)` Returns `LdapPrincipal` of current context.
`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)` This method does nothing by default.
`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.
`protected void`	`next(AddOperationContext addContext)` Calls the next interceptor for the add operation.
`protected void`	`next(BindOperationContext bindContext)` Calls the next interceptor for the bind operation.
`protected boolean`	`next(CompareOperationContext compareContext)` Calls the next interceptor for the compare operation.
`protected void`	`next(DeleteOperationContext deleteContext)` Calls the next interceptor for the delete operation.
`protected org.apache.directory.api.ldap.model.entry.Entry`	`next(GetRootDseOperationContext getRootDseContext)` Calls the next interceptor for the getRootDse operation.
`protected boolean`	`next(HasEntryOperationContext hasEntryContext)` Calls the next interceptor for the hasEntry operation.
`protected org.apache.directory.api.ldap.model.entry.Entry`	`next(LookupOperationContext lookupContext)` Calls the next interceptor for the lookup operation.
`protected void`	`next(ModifyOperationContext modifyContext)` Calls the next interceptor for the modify operation.
`protected void`	`next(MoveAndRenameOperationContext moveAndRenameContext)` Calls the next interceptor for the moveAndRename operation.
`protected void`	`next(MoveOperationContext moveContext)` Calls the next interceptor for the move operation.
`protected void`	`next(RenameOperationContext renameContext)` Calls the next interceptor for the rename operation.
`protected EntryFilteringCursor`	`next(SearchOperationContext searchContext)` Calls the next interceptor for the search operation.
`protected void`	`next(UnbindOperationContext unbindContext)` Compute the next interceptor for the unbind operation.
`void`	`rename(RenameOperationContext renameContext)` Filters `Partition#rename( RenameOperationContext )` call.
`EntryFilteringCursor`	`search(SearchOperationContext searchContext)` Filters `Partition#search( SearchOperationContext )` call.
`void`	`unbind(UnbindOperationContext unbindContext)` Filters `Partition#unbind( UnbindOperationContext )` call.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
private java.lang.String name
```
    The interceptor's name. Default to the class name
  - directoryService
```
protected DirectoryService directoryService
```
    A reference to the DirectoryService instance
  - schemaManager
```
protected org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager
```
    A reference to the SchemaManager instance
  - dnFactory
```
protected DnFactory dnFactory
```
    The DN factory
  - PWD_POLICY_STATE_ATTRIBUTE_TYPES
```
protected static final java.util.Set<org.apache.directory.api.ldap.model.schema.AttributeType> PWD_POLICY_STATE_ATTRIBUTE_TYPES
```
    set of operational attribute types used for representing the password policy state of a user entry
  - finalInterceptor
```
private final Interceptor finalInterceptor
```
    The final interceptor which acts as a proxy in charge to dialog with the nexus partition.
- Constructor Detail
  - BaseInterceptor
```
protected BaseInterceptor()
```
    Creates a new instance with a default name : the class name itself.
  - BaseInterceptor
```
protected BaseInterceptor(java.lang.String name)
```
    Creates a new instance with a given name.
    
    Parameters:
    
    name - the Interceptor name
  - BaseInterceptor
```
protected BaseInterceptor(InterceptorEnum interceptor)
```
    Creates a new instance with a given name.
    
    Parameters:
    
    name - the Interceptor name
- Method Detail
  - getName
```
public java.lang.String getName()
```
    default interceptor name is its class, preventing accidental duplication of interceptors by naming instances differently
    
    Specified by:
    
    getName in interface Interceptor
    
    Returns:
    
    (default, class name) interceptor name
  - getPrincipal
```
public static LdapPrincipal getPrincipal(OperationContext opContext)
```
    Returns LdapPrincipal of current context.
    
    Parameters:
    
    opContext - TODO
    
    Returns:
    
    the authenticated principal
  - init
```
public void init(DirectoryService directoryService)
          throws org.apache.directory.api.ldap.model.exception.LdapException
```
    This method does nothing by default.
    
    Specified by:
    
    init in interface Interceptor
    
    Throws:
    
    java.lang.Exception
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - destroy
```
public void destroy()
```
    This method does nothing by default.
    
    Specified by:
    
    destroy in interface Interceptor
  - getNextInterceptor
```
protected Interceptor getNextInterceptor(OperationContext operationContext)
```
    Computes the next interceptor to call for a given operation. If we find none, we return the proxy to the nexus.
    
    Parameters:
    
    operationContext - The operation context
    
    Returns:
    
    The next interceptor in the list for this operation
  - 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
    
    Parameters:
    
    addContext - The AddOperationContext instance
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If we had some error while processing the Add operation
  - next
```
protected final void next(AddOperationContext addContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the add operation.
    
    Parameters:
    
    addContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final void next(BindOperationContext bindContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the bind operation.
    
    Parameters:
    
    bindContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - compare
```
public boolean compare(CompareOperationContext compareContext)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Description copied from interface: Interceptor
    
    Filters DefaultPartitionNexus#compare( CompareOperationContext ) call.
    
    Specified by:
    
    compare in interface Interceptor
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final boolean next(CompareOperationContext compareContext)
                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the compare operation.
    
    Parameters:
    
    compareContext - The context in which we are executing this operation
    
    Returns:
    
    a boolean indicating if the comparison is successfull
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final void next(DeleteOperationContext deleteContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the delete operation.
    
    Parameters:
    
    deleteContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    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
  - next
```
protected final org.apache.directory.api.ldap.model.entry.Entry next(GetRootDseOperationContext getRootDseContext)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the getRootDse operation.
    
    Parameters:
    
    getRootDseContext - The context in which we are executing this operation
    
    Returns:
    
    the rootDSE
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final boolean next(HasEntryOperationContext hasEntryContext)
                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the hasEntry operation.
    
    Parameters:
    
    hasEntryContext - The context in which we are executing this operation
    
    Returns:
    
    a boolean indicating if the entry exists on the server
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final org.apache.directory.api.ldap.model.entry.Entry next(LookupOperationContext lookupContext)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the lookup operation.
    
    Parameters:
    
    lookupContext - The context in which we are executing this operation
    
    Returns:
    
    the Entry containing the found entry
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final void next(ModifyOperationContext modifyContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the modify operation.
    
    Parameters:
    
    modifyContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final void next(MoveOperationContext moveContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the move operation.
    
    Parameters:
    
    moveContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - moveAndRename
```
public void moveAndRename(MoveAndRenameOperationContext moveAndRenameContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Description copied from interface: Interceptor
    
    Filters Partition#moveAndRename( MoveAndRenameOperationContext) call.
    
    Specified by:
    
    moveAndRename in interface Interceptor
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final void next(MoveAndRenameOperationContext moveAndRenameContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the moveAndRename operation.
    
    Parameters:
    
    moveAndRenameContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final void next(RenameOperationContext renameContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the rename operation.
    
    Parameters:
    
    renameContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final EntryFilteringCursor next(SearchOperationContext searchContext)
                                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Calls the next interceptor for the search operation.
    
    Parameters:
    
    searchContext - The context in which we are executing this operation
    
    Returns:
    
    the cursor containing the found entries
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong
  - 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
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - next
```
protected final void next(UnbindOperationContext unbindContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Compute the next interceptor for the unbind operation.
    
    Parameters:
    
    unbindContext - The context in which we are executing this operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If something went wrong

Class BaseInterceptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

directoryService

schemaManager

dnFactory

PWD_POLICY_STATE_ATTRIBUTE_TYPES

finalInterceptor

Constructor Detail

BaseInterceptor

BaseInterceptor

BaseInterceptor

Method Detail

getName

getPrincipal

init

destroy

getNextInterceptor

add

next

bind

next

compare

next

delete

next

getRootDse

next

hasEntry

next

lookup

next

modify

next

move

next

moveAndRename

next

rename

next

search

next

unbind

next