org.opends.server.types.operation
Interface PreParseSearchOperation

All Superinterfaces:
PluginOperation, PreParseOperation
All Known Implementing Classes:
InternalSearchOperation, SearchOperationBasis

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface PreParseSearchOperation
extends PreParseOperation

This class defines a set of methods that are available for use by pre-parse plugins for search operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.


Method Summary
 java.util.LinkedHashSet<java.lang.String> getAttributes()
          Retrieves the set of requested attributes for this search operation.
 DereferencePolicy getDerefPolicy()
          Retrieves the alias dereferencing policy for this search operation.
 ByteString getRawBaseDN()
          Retrieves the raw, unprocessed base DN as included in the request from the client.
 RawFilter getRawFilter()
          Retrieves the raw, unprocessed search filter as included in the request from the client.
 SearchScope getScope()
          Retrieves the scope for this search operation.
 int getSizeLimit()
          Retrieves the size limit for this search operation.
 int getTimeLimit()
          Retrieves the time limit for this search operation.
 boolean getTypesOnly()
          Retrieves the typesOnly flag for this search operation.
 boolean returnEntry(Entry entry, java.util.List<Control> controls)
          Returns the provided entry to the client.
 boolean returnReference(DN dn, SearchResultReference reference)
          Returns the provided search result reference to the client.
 void setAttributes(java.util.LinkedHashSet<java.lang.String> attributes)
          Specifies the set of requested attributes for this search operation.
 void setDerefPolicy(DereferencePolicy derefPolicy)
          Specifies the alias dereferencing policy for this search operation.
 void setRawBaseDN(ByteString rawBaseDN)
          Specifies the raw, unprocessed base DN for this search operation.
 void setRawFilter(RawFilter rawFilter)
          Specifies the raw, unprocessed search filter as included in the request from the client.
 void setScope(SearchScope scope)
          Specifies the scope for this search operation.
 void setSizeLimit(int sizeLimit)
          Specifies the size limit for this search operation.
 void setTimeLimit(int timeLimit)
          Specifies the time limit for this search operation.
 void setTypesOnly(boolean typesOnly)
          Specifies the typesOnly flag for this search operation.
 
Methods inherited from interface org.opends.server.types.operation.PreParseOperation
addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setErrorMessage
 
Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
 

Method Detail

getRawBaseDN

ByteString getRawBaseDN()
Retrieves the raw, unprocessed base DN as included in the request from the client. This may or may not contain a valid DN, as no validation will have been performed.

Returns:
The raw, unprocessed base DN as included in the request from the client.

setRawBaseDN

void setRawBaseDN(ByteString rawBaseDN)
Specifies the raw, unprocessed base DN for this search operation.

Parameters:
rawBaseDN - The raw, unprocessed base DN for this search operation.

getScope

SearchScope getScope()
Retrieves the scope for this search operation.

Returns:
The scope for this search operation.

setScope

void setScope(SearchScope scope)
Specifies the scope for this search operation.

Parameters:
scope - The scope for this search operation.

getDerefPolicy

DereferencePolicy getDerefPolicy()
Retrieves the alias dereferencing policy for this search operation.

Returns:
The alias dereferencing policy for this search operation.

setDerefPolicy

void setDerefPolicy(DereferencePolicy derefPolicy)
Specifies the alias dereferencing policy for this search operation.

Parameters:
derefPolicy - The alias dereferencing policy for this search operation.

getSizeLimit

int getSizeLimit()
Retrieves the size limit for this search operation.

Returns:
The size limit for this search operation.

setSizeLimit

void setSizeLimit(int sizeLimit)
Specifies the size limit for this search operation.

Parameters:
sizeLimit - The size limit for this search operation.

getTimeLimit

int getTimeLimit()
Retrieves the time limit for this search operation.

Returns:
The time limit for this search operation.

setTimeLimit

void setTimeLimit(int timeLimit)
Specifies the time limit for this search operation.

Parameters:
timeLimit - The time limit for this search operation.

getTypesOnly

boolean getTypesOnly()
Retrieves the typesOnly flag for this search operation.

Returns:
The typesOnly flag for this search operation.

setTypesOnly

void setTypesOnly(boolean typesOnly)
Specifies the typesOnly flag for this search operation.

Parameters:
typesOnly - The typesOnly flag for this search operation.

getRawFilter

RawFilter getRawFilter()
Retrieves the raw, unprocessed search filter as included in the request from the client. It may or may not contain a valid filter (e.g., unsupported attribute types or values with an invalid syntax) because no validation will have been performed on it.

Returns:
The raw, unprocessed search filter as included in the request from the client.

setRawFilter

void setRawFilter(RawFilter rawFilter)
Specifies the raw, unprocessed search filter as included in the request from the client.

Parameters:
rawFilter - The raw, unprocessed search filter.

getAttributes

java.util.LinkedHashSet<java.lang.String> getAttributes()
Retrieves the set of requested attributes for this search operation. Its contents should not be be altered.

Returns:
The set of requested attributes for this search operation.

setAttributes

void setAttributes(java.util.LinkedHashSet<java.lang.String> attributes)
Specifies the set of requested attributes for this search operation.

Parameters:
attributes - The set of requested attributes for this search operation.

returnEntry

boolean returnEntry(Entry entry,
                    java.util.List<Control> controls)
Returns the provided entry to the client.

Parameters:
entry - The entry that should be returned.
controls - The set of controls to include with the entry (may be null if no controls should be included with the entry).
Returns:
true if the caller should continue processing the search request and sending additional entries and references, or false if not for some reason (e.g., the size limit has been reached or the search has been abandoned).

returnReference

boolean returnReference(DN dn,
                        SearchResultReference reference)
Returns the provided search result reference to the client.

Parameters:
reference - The search reference that should be returned.
dn - A DN related to the specified search reference.
Returns:
true if the caller should continue processing the search request and sending additional entries and references, or false if not for some reason (e.g., the size limit has been reached or the search has been abandoned).