Interceptor (ApacheDS 2.0.0-M21 API)

All Known Implementing Classes:

AciAuthorizationInterceptor, AdministrativePointInterceptor, AuthenticationInterceptor, BaseInterceptor, ChangeLogInterceptor, CollectiveAttributeInterceptor, ConfigurableHashingInterceptor, CryptPasswordHashingInterceptor, DefaultAuthorizationInterceptor, DelayInducingInterceptor, EventInterceptor, ExceptionInterceptor, JournalInterceptor, KeyDerivationInterceptor, Md5PasswordHashingInterceptor, NormalizationInterceptor, NumberIncrementingInterceptor, OperationalAttributeInterceptor, PasswordHashingInterceptor, Pkcs5s2PasswordHashingInterceptor, ReferralInterceptor, SchemaInterceptor, Sha256PasswordHashingInterceptor, Sha384PasswordHashingInterceptor, Sha512PasswordHashingInterceptor, ShaPasswordHashingInterceptor, Smd5PasswordHashingInterceptor, Ssha256PasswordHashingInterceptor, Ssha384PasswordHashingInterceptor, Ssha512PasswordHashingInterceptor, SshaPasswordHashingInterceptor, SubentryInterceptor, TimerInterceptor, TriggerInterceptor
```
public interface Interceptor
```
Filters invocations on DefaultPartitionNexus. Interceptor filters most method calls performed on DefaultPartitionNexus just like Servlet filters do.

Interceptor Chaining
Interceptors should usually pass the control of current invocation to the next interceptor by calling an appropriate method on NextInterceptor. The flow control is returned when the next interceptor's filter method returns. You can therefore implement pre-, post-, around- invocation handler by how you place the statement. Otherwise, you can transform the invocation into other(s).

Pre-invocation Filtering
```
 public void delete( NextInterceptor nextInterceptor, Name name )
 {
     System.out.println( "Starting invocation." );
     nextInterceptor.delete( name );
 }
 
```
Post-invocation Filtering
```
 public void delete( NextInterceptor nextInterceptor, Name name )
 {
     nextInterceptor.delete( name );
     System.out.println( "Invocation ended." );
 }
 
```
Around-invocation Filtering
```
 public void delete( NextInterceptor nextInterceptor, Name name )
 {
     long startTime = System.currentTimeMillis();
     try
     {
         nextInterceptor.delete( name );
     }
     finally
     {
         long endTime = System.currentTimeMillis();
         System.out.println( ( endTime - startTime ) + "ms elapsed." );
     }
 }
 
```
Transforming invocations
```
 public void delete( NextInterceptor nextInterceptor, Name name )
 {
     // transform deletion into modification.
     Attribute mark = new AttributeImpl( "entryDeleted", "true" );
     nextInterceptor.modify( name, DirIteratorContext.REPLACE_ATTRIBUTE, mark );
 }
 
```
Author:

Apache Directory Project

Method Summary

All Methods Instance Methods Abstract 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()` Deinitializes this interceptor.
`String`	`getName()` Name that must be unique in an interceptor chain
`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)` Intializes this interceptor.
`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`	`unbind(UnbindOperationContext unbindContext)` Filters `Partition#unbind( UnbindOperationContext )` call.

- Method Detail
  - getName
```
String getName()
```
    Name that must be unique in an interceptor chain
    
    Returns:
    
    name of this interceptor, must be unique in an interceptor chain.
  - init
```
void init(DirectoryService directoryService)
   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Intializes this interceptor.
    
    Throws:
    
    Exception
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - destroy
```
void destroy()
```
    Deinitializes this interceptor.
  - add
```
void add(AddOperationContext addContext)
  throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#add( AddOperationContext ) call.
    
    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
```
void bind(BindOperationContext bindContext)
   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#bind( BindOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - compare
```
boolean compare(CompareOperationContext compareContext)
         throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters DefaultPartitionNexus#compare( CompareOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - delete
```
void delete(DeleteOperationContext deleteContext)
     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#delete( DeleteOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getRootDse
```
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.
    
    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
```
boolean hasEntry(HasEntryOperationContext hasEntryContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#hasEntry( HasEntryOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - lookup
```
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.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - modify
```
void modify(ModifyOperationContext modifyContext)
     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#modify( ModifyOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - move
```
void move(MoveOperationContext moveContext)
   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#move( MoveOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - moveAndRename
```
void moveAndRename(MoveAndRenameOperationContext moveAndRenameContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#moveAndRename( MoveAndRenameOperationContext) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - rename
```
void rename(RenameOperationContext renameContext)
     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#rename( RenameOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - search
```
EntryFilteringCursor search(SearchOperationContext searchContext)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#search( SearchOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - unbind
```
void unbind(UnbindOperationContext unbindContext)
     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Filters Partition#unbind( UnbindOperationContext ) call.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException

Interface Interceptor

Interceptor Chaining

Pre-invocation Filtering

Post-invocation Filtering

Around-invocation Filtering

Transforming invocations

Method Summary

Method Detail

getName

init

destroy

add

bind

compare

delete

getRootDse

hasEntry

lookup

modify

move

moveAndRename

rename

search

unbind