org.apache.directory.server.core

Class DefaultOperationManager

java.lang.Object

org.apache.directory.server.core.DefaultOperationManager

All Implemented Interfaces:

OperationManager

public class DefaultOperationManager
extends java.lang.Object
implements OperationManager

The default implementation of an OperationManager.

Field Summary

Fields

Modifier and Type	Field and Description
private DirectoryService	directoryService The directory service instance
private static boolean	IS_DEBUG Speedup for logs
private static boolean	IS_STAT
private static boolean	IS_TIME
private static org.slf4j.Logger	OPERATION_LOG A logger specifically for operations
private static org.slf4j.Logger	OPERATION_STAT A logger specifically for operations statistics
private static org.slf4j.Logger	OPERATION_TIME A logger specifically for operations time
private java.util.concurrent.locks.ReadWriteLock	rwLock A lock used to protect against concurrent operations

Constructor Summary

Constructors

Constructor and Description
DefaultOperationManager(DirectoryService directoryService)

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Add an entry into the backend, going through the interceptor chain
void	bind(BindOperationContext bindContext) TODO document after determining if this method should be here.
private org.apache.directory.api.ldap.model.exception.LdapPartialResultException	buildLdapPartialResultException(org.apache.directory.api.ldap.model.name.Dn childDn)
private org.apache.directory.api.ldap.model.exception.LdapReferralException	buildReferralException(org.apache.directory.api.ldap.model.entry.Entry parentEntry, org.apache.directory.api.ldap.model.name.Dn childDn)
private org.apache.directory.api.ldap.model.exception.LdapReferralException	buildReferralExceptionForSearch(org.apache.directory.api.ldap.model.entry.Entry parentEntry, org.apache.directory.api.ldap.model.name.Dn childDn, org.apache.directory.api.ldap.model.message.SearchScope scope)
boolean	compare(CompareOperationContext compareContext) TODO document after determining if this method should be here.
void	delete(DeleteOperationContext deleteContext) TODO document after determining if this method should be here.
private void	eagerlyPopulateFields(OperationContext opContext) Eagerly populates fields of operation contexts so multiple Interceptors in the processing pathway can reuse this value without performing a redundant lookup operation.
private void	ensureStarted()
private org.apache.directory.api.ldap.model.entry.Entry	getOriginalEntry(OperationContext opContext)
org.apache.directory.api.ldap.model.entry.Entry	getRootDse(GetRootDseOperationContext getRootDseContext) Get the RooDse entry.
java.util.concurrent.locks.ReadWriteLock	getRWLock()
boolean	hasEntry(HasEntryOperationContext hasEntryContext) TODO document after determining if this method should be here.
void	lockRead() Acquires a ReadLock
void	lockWrite() Acquires a WriteLock
org.apache.directory.api.ldap.model.entry.Entry	lookup(LookupOperationContext lookupContext) TODO document after determining if this method should be here.
void	modify(ModifyOperationContext modifyContext) TODO document after determining if this method should be here.
void	move(MoveOperationContext moveContext) TODO document after determining if this method should be here.
void	moveAndRename(MoveAndRenameOperationContext moveAndRenameContext) TODO document after determining if this method should be here.
void	rename(RenameOperationContext renameContext) TODO document after determining if this method should be here.
EntryFilteringCursor	search(SearchOperationContext searchContext) TODO document after determining if this method should be here.
void	unbind(UnbindOperationContext unbindContext) TODO document after determining if this method should be here.
void	unlockRead() Releases a ReadLock
void	unlockWrite() Releases a WriteLock

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_LOG

private static final org.slf4j.Logger OPERATION_LOG

A logger specifically for operations

OPERATION_TIME

private static final org.slf4j.Logger OPERATION_TIME

A logger specifically for operations time

OPERATION_STAT

private static final org.slf4j.Logger OPERATION_STAT

A logger specifically for operations statistics

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

IS_TIME

private static final boolean IS_TIME

IS_STAT

private static final boolean IS_STAT

directoryService

private final DirectoryService directoryService

The directory service instance

rwLock

private java.util.concurrent.locks.ReadWriteLock rwLock

A lock used to protect against concurrent operations

Constructor Detail

DefaultOperationManager

public DefaultOperationManager(DirectoryService directoryService)

Method Detail

getRWLock

public java.util.concurrent.locks.ReadWriteLock getRWLock()

Specified by:

getRWLock in interface OperationManager

Returns:

the OperationManager R/W lock

lockRead

public void lockRead()

Acquires a ReadLock

Specified by:

lockRead in interface OperationManager

lockWrite

public void lockWrite()

Acquires a WriteLock

Specified by:

lockWrite in interface OperationManager

unlockWrite

public void unlockWrite()

Releases a WriteLock

Specified by:

unlockWrite in interface OperationManager

unlockRead

public void unlockRead()

Releases a ReadLock

Specified by:

unlockRead in interface OperationManager

eagerlyPopulateFields

private void eagerlyPopulateFields(OperationContext opContext)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Eagerly populates fields of operation contexts so multiple Interceptors in the processing pathway can reuse this value without performing a redundant lookup operation.

Parameters:

opContext - the operation context to populate with cached fields

Throws:

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

getOriginalEntry

private org.apache.directory.api.ldap.model.entry.Entry getOriginalEntry(OperationContext opContext)
                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

buildReferralException

private org.apache.directory.api.ldap.model.exception.LdapReferralException buildReferralException(org.apache.directory.api.ldap.model.entry.Entry parentEntry,
                                                                                                   org.apache.directory.api.ldap.model.name.Dn childDn)
                                                                                            throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

buildReferralExceptionForSearch

private org.apache.directory.api.ldap.model.exception.LdapReferralException buildReferralExceptionForSearch(org.apache.directory.api.ldap.model.entry.Entry parentEntry,
                                                                                                            org.apache.directory.api.ldap.model.name.Dn childDn,
                                                                                                            org.apache.directory.api.ldap.model.message.SearchScope scope)
                                                                                                     throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

buildLdapPartialResultException

private org.apache.directory.api.ldap.model.exception.LdapPartialResultException buildLdapPartialResultException(org.apache.directory.api.ldap.model.name.Dn childDn)

add

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

Add an entry into the backend, going through the interceptor chain

Specified by:

add in interface OperationManager

Parameters:

addContext - The context containing the information to process the addition

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the addition can't be processed successfully

bind

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

TODO document after determining if this method should be here.

Specified by:

bind in interface OperationManager

Throws:

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

compare

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

TODO document after determining if this method should be here.

Specified by:

compare in interface OperationManager

Throws:

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

delete

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

TODO document after determining if this method should be here.

Specified by:

delete in interface OperationManager

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

Get the RooDse entry.

Specified by:

getRootDse in interface OperationManager

Parameters:

getRootDseContext - The getRootDse() context

Returns:

The rootDse 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

TODO document after determining if this method should be here.

Specified by:

hasEntry in interface OperationManager

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

TODO document after determining if this method should be here.

Specified by:

lookup in interface OperationManager

Throws:

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

modify

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

TODO document after determining if this method should be here.

Specified by:

modify in interface OperationManager

Throws:

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

move

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

TODO document after determining if this method should be here.

Specified by:

move in interface OperationManager

Throws:

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

moveAndRename

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

TODO document after determining if this method should be here.

Specified by:

moveAndRename in interface OperationManager

Throws:

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

rename

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

TODO document after determining if this method should be here.

Specified by:

rename in interface OperationManager

Throws:

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

search

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

TODO document after determining if this method should be here.

Specified by:

search in interface OperationManager

Throws:

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

unbind

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

TODO document after determining if this method should be here.

Specified by:

unbind in interface OperationManager

Throws:

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

ensureStarted

private void ensureStarted()
                    throws org.apache.directory.api.ldap.model.exception.LdapServiceUnavailableException

Throws:

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