org.apache.directory.server.ldap.handlers

Class PersistentSearchListener

java.lang.Object

org.apache.directory.server.ldap.handlers.PersistentSearchListener

All Implemented Interfaces:

org.apache.directory.api.ldap.model.message.AbandonListener, DirectoryListener

public class PersistentSearchListener
extends java.lang.Object
implements DirectoryListener, org.apache.directory.api.ldap.model.message.AbandonListener

A DirectoryListener implementation which sends back added, deleted, modified or renamed entries to a client that created this listener. This class is part of the persistent search implementation which uses the event notification scheme built into the server core. This listener is disabled only when a session closes or when an abandon request cancels it. Hence time and size limits in normal search operations do not apply here.

Field Summary

Fields

Modifier and Type	Field and Description
private LookupOperationContext	filterCtx
private static org.slf4j.Logger	LOG
(package private) org.apache.directory.api.ldap.model.message.controls.PersistentSearch	psearchControl
(package private) org.apache.directory.api.ldap.model.message.SearchRequest	req
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager
(package private) LdapSession	session

Constructor Summary

Constructors

Constructor and Description
PersistentSearchListener(LdapSession session, org.apache.directory.api.ldap.model.message.SearchRequest req)

Method Summary

Modifier and Type	Method and Description
void	abandon()
void	entryAdded(AddOperationContext addContext) Called when an entry has been added.
void	entryDeleted(DeleteOperationContext deleteContext) Called when an entry has been deleted.
void	entryModified(ModifyOperationContext modifyContext) Called when an entry has been modified.
void	entryMoved(MoveOperationContext moveContext) Called when an entry is moved.
void	entryMovedAndRenamed(MoveAndRenameOperationContext moveAndRenameContext) Called when an entry is moved and renamed at the same time.
void	entryRenamed(RenameOperationContext renameContext) Called when an entry has been renamed.
private void	filterEntry(org.apache.directory.api.ldap.model.entry.Entry entry) A convenient method to filter the contents of an entry
boolean	isSynchronous() indicates if this listener needs to be invoked synchronously
void	requestAbandoned(org.apache.directory.api.ldap.model.message.AbandonableRequest req)
private void	setECResponseControl(org.apache.directory.api.ldap.model.message.SearchResultEntry response, ChangeOperationContext opContext, org.apache.directory.api.ldap.model.message.controls.ChangeType type)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

session

final LdapSession session

req

final org.apache.directory.api.ldap.model.message.SearchRequest req

psearchControl

final org.apache.directory.api.ldap.model.message.controls.PersistentSearch psearchControl

filterCtx

private LookupOperationContext filterCtx

schemaManager

private org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

Constructor Detail

PersistentSearchListener

public PersistentSearchListener(LdapSession session,
                                org.apache.directory.api.ldap.model.message.SearchRequest req)

Method Detail

isSynchronous

public boolean isSynchronous()

Description copied from interface: DirectoryListener

indicates if this listener needs to be invoked synchronously

Specified by:

isSynchronous in interface DirectoryListener

Returns:

true if should be invoked synchronously, false otherwise

abandon

public void abandon()
             throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

requestAbandoned

public void requestAbandoned(org.apache.directory.api.ldap.model.message.AbandonableRequest req)

Specified by:

requestAbandoned in interface org.apache.directory.api.ldap.model.message.AbandonListener

setECResponseControl

private void setECResponseControl(org.apache.directory.api.ldap.model.message.SearchResultEntry response,
                                  ChangeOperationContext opContext,
                                  org.apache.directory.api.ldap.model.message.controls.ChangeType type)

entryAdded

public void entryAdded(AddOperationContext addContext)

Description copied from interface: DirectoryListener

Called when an entry has been added.

Specified by:

entryAdded in interface DirectoryListener

Parameters:

addContext - the add operation context responsible for the change

entryDeleted

public void entryDeleted(DeleteOperationContext deleteContext)

Description copied from interface: DirectoryListener

Called when an entry has been deleted.

Specified by:

entryDeleted in interface DirectoryListener

Parameters:

deleteContext - the delete operation context responsible for the change

entryModified

public void entryModified(ModifyOperationContext modifyContext)

Description copied from interface: DirectoryListener

Called when an entry has been modified.

Specified by:

entryModified in interface DirectoryListener

Parameters:

modifyContext - the modify operation context responsible for the change

entryMoved

public void entryMoved(MoveOperationContext moveContext)

Description copied from interface: DirectoryListener

Called when an entry is moved.

Specified by:

entryMoved in interface DirectoryListener

Parameters:

moveContext - the move operation context responsible for the change

entryMovedAndRenamed

public void entryMovedAndRenamed(MoveAndRenameOperationContext moveAndRenameContext)

Description copied from interface: DirectoryListener

Called when an entry is moved and renamed at the same time.

Specified by:

entryMovedAndRenamed in interface DirectoryListener

Parameters:

moveAndRenameContext - the move/rename operation context responsible for the change

entryRenamed

public void entryRenamed(RenameOperationContext renameContext)

Description copied from interface: DirectoryListener

Called when an entry has been renamed.

Specified by:

entryRenamed in interface DirectoryListener

Parameters:

renameContext - the rename operation context responsible for the change

filterEntry

private void filterEntry(org.apache.directory.api.ldap.model.entry.Entry entry)

A convenient method to filter the contents of an entry

Parameters:

entry -

See Also:

ServerEntryUtils.filterContents(SchemaManager, org.apache.directory.server.core.api.interceptor.context.FilteringOperationContext, Entry)