org.apache.directory.server.core.exception

Class ExceptionInterceptor

java.lang.Object

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

org.apache.directory.server.core.exception.ExceptionInterceptor

All Implemented Interfaces:

Interceptor

public class ExceptionInterceptor
extends BaseInterceptor

An Interceptor that detects any operations that breaks integrity of Partition and terminates the current invocation chain by throwing a Exception. Those operations include when an entry already exists at a Dn and is added once again to the same Dn.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_CACHE_SIZE Declare a default for this cache.
private PartitionNexus	nexus
private org.apache.commons.collections.map.LRUMap	notAliasCache A cache to store entries which are not aliases.
private org.apache.directory.api.ldap.model.name.Dn	subschemSubentryDn

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
ExceptionInterceptor() Creates an interceptor that is also the exception handling service.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) In the pre-invocation state this interceptor method checks to see if the entry to be added already exists.
private void	assertHasEntry(OperationContext opContext, java.lang.String msg) Asserts that an entry is present and as a side effect if it is not, creates a LdapNoSuchObjectException, which is used to set the before exception on the invocation - eventually the exception is thrown.
void	delete(DeleteOperationContext deleteContext) Checks to make sure the entry being deleted exists, and has no children, otherwise throws the appropriate LdapException.
void	destroy() This method does nothing by default.
void	init(DirectoryService directoryService) This method does nothing by default.
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.

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

bind, compare, getName, getNextInterceptor, getPrincipal, getRootDse, hasEntry, lookup, next, next, next, next, next, next, next, next, next, next, next, next, next, search, unbind

Methods inherited from class java.lang.Object

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

Field Detail

nexus

private PartitionNexus nexus

subschemSubentryDn

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

notAliasCache

private final org.apache.commons.collections.map.LRUMap notAliasCache

A cache to store entries which are not aliases. It's a speedup, we will be able to avoid backend lookups. Note that the backend also use a cache mechanism, but for performance gain, it's good to manage a cache here. The main problem is that when a user modify the parent, we will have to update it at three different places : - in the backend, - in the partition cache, - in this cache. The update of the backend and partition cache is already correctly handled, so we will just have to offer an access to refresh the local cache. This should be done in delete, modify and move operations. We need to be sure that frequently used DNs are always in cache, and not discarded. We will use a LRU cache for this purpose.

DEFAULT_CACHE_SIZE

private static final int DEFAULT_CACHE_SIZE

Declare a default for this cache. 100 entries seems to be enough

See Also:

Constant Field Values

Constructor Detail

ExceptionInterceptor

public ExceptionInterceptor()

Creates an interceptor that is also the exception handling service.

Method Detail

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

Overrides:

init in class BaseInterceptor

Throws:

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

destroy

public void destroy()

Description copied from class: BaseInterceptor

This method does nothing by default.

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

In the pre-invocation state this interceptor method checks to see if the entry to be added already exists. If it does an exception is raised.

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

delete

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

Checks to make sure the entry being deleted exists, and has no children, otherwise throws the appropriate LdapException.

Specified by:

delete in interface Interceptor

Overrides:

delete 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

assertHasEntry

private void assertHasEntry(OperationContext opContext,
                            java.lang.String msg)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Asserts that an entry is present and as a side effect if it is not, creates a LdapNoSuchObjectException, which is used to set the before exception on the invocation - eventually the exception is thrown.

Parameters:

msg - the message to prefix to the distinguished name for explanation

nextInterceptor - the next interceptor in the chain

Throws:

java.lang.Exception - if the entry does not exist

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