org.opends.server.types.operation
Interface PreParseCompareOperation

All Superinterfaces:
PluginOperation, PreParseOperation
All Known Implementing Classes:
CompareOperationBasis

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

This class defines a set of methods that are available for use by pre-parse plugins for compare 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
 ByteString getAssertionValue()
          Retrieves the assertion value for this compare operation.
 java.lang.String getRawAttributeType()
          Retrieves the raw attribute type for this compare operation.
 ByteString getRawEntryDN()
          Retrieves the raw, unprocessed entry DN as included in the client request.
 void setAssertionValue(ByteString assertionValue)
          Specifies the assertion value for this compare operation.
 void setRawAttributeType(java.lang.String rawAttributeType)
          Specifies the raw attribute type for this compare operation.
 void setRawEntryDN(ByteString rawEntryDN)
          Specifies the raw, unprocessed entry DN as included in the client request.
 
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

getRawEntryDN

ByteString getRawEntryDN()
Retrieves the raw, unprocessed entry DN as included in the client request.

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

setRawEntryDN

void setRawEntryDN(ByteString rawEntryDN)
Specifies the raw, unprocessed entry DN as included in the client request.

Parameters:
rawEntryDN - The raw entry DN for this compare operation.

getRawAttributeType

java.lang.String getRawAttributeType()
Retrieves the raw attribute type for this compare operation.

Returns:
The raw attribute type for this compare operation.

setRawAttributeType

void setRawAttributeType(java.lang.String rawAttributeType)
Specifies the raw attribute type for this compare operation.

Parameters:
rawAttributeType - The raw attribute type for this compare operation.

getAssertionValue

ByteString getAssertionValue()
Retrieves the assertion value for this compare operation.

Returns:
The assertion value for this compare operation.

setAssertionValue

void setAssertionValue(ByteString assertionValue)
Specifies the assertion value for this compare operation.

Parameters:
assertionValue - The assertion value for this compare operation.