BaseInterceptor (ApacheDS Core API 1.5.7 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: Interceptor

public abstract class BaseInterceptor
extends java.lang.Object
implements Interceptor
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.

Version:: $Rev: 918766 $, $Date: 2010-03-04 01:25:11 +0200 (Thu, 04 Mar 2010) $
Author:: Apache Directory Project
XBean

Constructor Summary
`protected`	`BaseInterceptor()` Creates a new instance.

Method Summary
`void`	`add(NextInterceptor next, AddOperationContext opContext)` Filters `Partition.add( AddOperationContext )` call.
`void`	`addContextPartition(NextInterceptor next, AddContextPartitionOperationContext opContext)` Filters `DefaultPartitionNexus#addContextPartition( AddContextPartitionOperationContext )` call.
`void`	`bind(NextInterceptor next, BindOperationContext opContext)` Filters `Partition.bind( BindOperationContext )` call.
`boolean`	`compare(NextInterceptor next, CompareOperationContext opContext)` Filters `DefaultPartitionNexus#compare( CompareOperationContext )` call.
`void`	`delete(NextInterceptor next, DeleteOperationContext opContext)` Filters `Partition.delete( DeleteOperationContext )` call.
`void`	`destroy()` This method does nothing by default.
`static OperationContext`	`getContext()` TODO delete this since it uses static access Returns the current JNDI `Context`.
`org.apache.directory.shared.ldap.name.DN`	`getMatchedName(NextInterceptor next, GetMatchedNameOperationContext opContext)` Filters `DefaultPartitionNexus#getMatchedName( GetMatchedNameOperationContext )` call.
`java.lang.String`	`getName()` default interceptor name is its class, preventing accidental duplication of interceptors by naming instances differently
`static LdapPrincipal`	`getPrincipal()` TODO delete this since it uses static access Returns `LdapPrincipal` of current context.
`ClonedServerEntry`	`getRootDSE(NextInterceptor next, GetRootDSEOperationContext opContext)` Filters `DefaultPartitionNexus#getRootDSE( GetRootDSEOperationContext )` call.
`org.apache.directory.shared.ldap.name.DN`	`getSuffix(NextInterceptor next, GetSuffixOperationContext opContext)` Filters `DefaultPartitionNexus#getSuffix( GetSuffixOperationContext )` call.
`boolean`	`hasEntry(NextInterceptor next, EntryOperationContext opContext)` Filters `Partition.hasEntry( EntryOperationContext )` call.
`void`	`init(DirectoryService directoryService)` This method does nothing by default.
`EntryFilteringCursor`	`list(NextInterceptor next, ListOperationContext opContext)` Filters `Partition.list( ListOperationContext )` call.
`java.util.Set<java.lang.String>`	`listSuffixes(NextInterceptor next, ListSuffixOperationContext opContext)` Filters `DefaultPartitionNexus#listSuffixes( ListSuffixOperationContext )` call.
`ClonedServerEntry`	`lookup(NextInterceptor next, LookupOperationContext opContext)` Filters `Partition.lookup( LookupOperationContext )` call.
`void`	`modify(NextInterceptor next, ModifyOperationContext opContext)` Filters `Partition.modify( ModifyOperationContext )` call.
`void`	`move(NextInterceptor next, MoveOperationContext opContext)` Filters `Partition.move( MoveOperationContext )` call.
`void`	`moveAndRename(NextInterceptor next, MoveAndRenameOperationContext opContext)` Filters `Partition.moveAndRename( MoveAndRenameOperationContext)` call.
`void`	`removeContextPartition(NextInterceptor next, RemoveContextPartitionOperationContext opContext)` Filters `DefaultPartitionNexus#removeContextPartition( RemoveContextPartitionOperationContext )` call.
`void`	`rename(NextInterceptor next, RenameOperationContext opContext)` Filters `Partition.rename( RenameOperationContext )` call.
`EntryFilteringCursor`	`search(NextInterceptor next, SearchOperationContext opContext)` Filters `Partition.search( SearchOperationContext )` call.
`void`	`unbind(NextInterceptor next, UnbindOperationContext opContext)` Filters `Partition.unbind( UnbindOperationContext )` call.

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

Constructor Detail

BaseInterceptor

protected BaseInterceptor()

Creates a new instance.

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()

TODO delete this since it uses static access Returns LdapPrincipal of current context.

Returns:: the authenticated principal

getContext

public static OperationContext getContext()

TODO delete this since it uses static access Returns the current JNDI Context.

Returns:: the context on the invocation stack

init

public void init(DirectoryService directoryService)
          throws java.lang.Exception

This method does nothing by default.

Specified by:: init in interface Interceptor

Throws:: java.lang.Exception

destroy

public void destroy()

This method does nothing by default.

Specified by:: destroy in interface Interceptor