org.opends.server.core
Class PersistentSearch

java.lang.Object
  org.opends.server.core.PersistentSearch

public class PersistentSearch
extends java.lang.Object

This class defines a data structure that will be used to hold the information necessary for processing a persistent search.

Constructor Summary

PersistentSearch(SearchOperation searchOperation, java.util.Set<PersistentSearchChangeType> changeTypes, boolean returnECs)
Creates a new persistent search object with the provided information.

Method Summary

DN	getBaseDN() Retrieves the base DN for this persistent search.
java.util.Set<PersistentSearchChangeType>	getChangeTypes() Retrieves the set of change types for this persistent search.
SearchFilter	getFilter() Retrieves the filter for this persistent search.
boolean	getReturnECs() Retrieves the returnECs flag for this persistent search.
SearchScope	getScope() Retrieves the scope for this persistent search.
SearchOperation	getSearchOperation() Retrieves the search operation for this persistent search.
void	processAdd(LocalBackendAddOperation addOperation, Entry entry) Performs any necessary processing for the provided add operation.
void	processDelete(LocalBackendDeleteOperation deleteOperation, Entry entry) Performs any necessary processing for the provided delete operation.
void	processModify(LocalBackendModifyOperation modifyOperation, Entry oldEntry, Entry newEntry) Performs any necessary processing for the provided modify operation.
void	processModifyDN(LocalBackendModifyDNOperation modifyDNOperation, Entry oldEntry, Entry newEntry) Performs any necessary processing for the provided modify DN operation.
java.lang.String	toString() Retrieves a string representation of this persistent search.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this persistent search to the provided buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentSearch

public PersistentSearch(SearchOperation searchOperation,
                        java.util.Set<PersistentSearchChangeType> changeTypes,
                        boolean returnECs)

Creates a new persistent search object with the provided information.

Parameters:

searchOperation - The search operation for this persistent search.

changeTypes - The change types for which changes should be examined.

returnECs - Indicates whether to include entry change notification controls in search result entries sent to the client.

Method Detail

getSearchOperation

public SearchOperation getSearchOperation()

Retrieves the search operation for this persistent search.

Returns:

The search operation for this persistent search.

getChangeTypes

public java.util.Set<PersistentSearchChangeType> getChangeTypes()

Retrieves the set of change types for this persistent search.

Returns:

The set of change types for this persistent search.

getReturnECs

public boolean getReturnECs()

Retrieves the returnECs flag for this persistent search.

Returns:

The return ECs flag for this persistent search.

getBaseDN

public DN getBaseDN()

Retrieves the base DN for this persistent search.

Returns:

The base DN for this persistent search.

getScope

public SearchScope getScope()

Retrieves the scope for this persistent search.

Returns:

The scope for this persistent search.

getFilter

public SearchFilter getFilter()

Retrieves the filter for this persistent search.

Returns:

The filter for this persistent search.

processAdd

public void processAdd(LocalBackendAddOperation addOperation,
                       Entry entry)

Performs any necessary processing for the provided add operation.

Parameters:

addOperation - The add operation that has been processed.

entry - The entry that was added.

processDelete

public void processDelete(LocalBackendDeleteOperation deleteOperation,
                          Entry entry)

Performs any necessary processing for the provided delete operation.

Parameters:

deleteOperation - The delete operation that has been processed.

entry - The entry that was removed.

processModify

public void processModify(LocalBackendModifyOperation modifyOperation,
                          Entry oldEntry,
                          Entry newEntry)

Performs any necessary processing for the provided modify operation.

Parameters:

modifyOperation - The modify operation that has been processed.

oldEntry - The entry before the modification was applied.

newEntry - The entry after the modification was applied.

processModifyDN

public void processModifyDN(LocalBackendModifyDNOperation modifyDNOperation,
                            Entry oldEntry,
                            Entry newEntry)

Performs any necessary processing for the provided modify DN operation.

Parameters:

modifyDNOperation - The modify DN operation that has been processed.

oldEntry - The entry before the modify DN.

newEntry - The entry after the modify DN.

toString

public java.lang.String toString()

Retrieves a string representation of this persistent search.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this persistent search.

toString

public void toString(java.lang.StringBuilder buffer)

Appends a string representation of this persistent search to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.