org.apache.directory.server.core.api

Interface OperationManager

All Known Implementing Classes:

DefaultOperationManager

public interface OperationManager

An interface used by the DirectoryService to isolate operations that can be performed on it.

Author:

Apache Directory Project

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.
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.
org.apache.directory.api.ldap.model.entry.Entry	getRootDse(GetRootDseOperationContext getRootDseContext) Get the RooDse entry.
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

Method Detail

add

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

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

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

getRootDse

org.apache.directory.api.ldap.model.entry.Entry getRootDse(GetRootDseOperationContext getRootDseContext)
                                                    throws org.apache.directory.api.ldap.model.exception.LdapException

Get the RooDse entry.

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

compare

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

TODO document after determining if this method should be here.

Parameters:

compareContext - The Compare operation context

Returns:

true if the comparison is successful

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the compare failed

delete

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

TODO document after determining if this method should be here.

Parameters:

deleteContext - The Delete operation context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the delete failed

modify

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

TODO document after determining if this method should be here.

Parameters:

modifyContext - The Modify operation context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the modify failed

search

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

TODO document after determining if this method should be here.

Parameters:

searchContext - The Search operation context

Returns:

The cursor on the found entries

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the search failed

lookup

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.

Parameters:

lookupContext - The Lookup operation context

Returns:

The found entry

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the lookup failed

hasEntry

boolean hasEntry(HasEntryOperationContext hasEntryContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException

TODO document after determining if this method should be here.

Parameters:

hasEntryContext - The HasEntry operation context

Returns:

true if the entry exists

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the hasEntry failed

rename

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

TODO document after determining if this method should be here.

Parameters:

renameContext - The Rename operation context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the rename failed

move

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

TODO document after determining if this method should be here.

Parameters:

moveContext - The Move operation context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the move failed

moveAndRename

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

TODO document after determining if this method should be here.

Parameters:

moveAndRenameContext - The MoveAndRename operation context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the moveAndRename failed

bind

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

TODO document after determining if this method should be here.

Parameters:

bindContext - The Bind operation context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the bind failed

unbind

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

TODO document after determining if this method should be here.

Parameters:

unbindContext - The Unbind operation context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the unbind failed

lockWrite

void lockWrite()

Acquires a WriteLock

unlockWrite

void unlockWrite()

Releases a WriteLock

lockRead

void lockRead()

Acquires a ReadLock

unlockRead

void unlockRead()

Releases a ReadLock

getRWLock

ReadWriteLock getRWLock()

Returns:

the OperationManager R/W lock