org.opends.server.core
Class CompareOperationWrapper

java.lang.Object
  extended by org.opends.server.core.OperationWrapper
      extended by org.opends.server.core.CompareOperationWrapper
All Implemented Interfaces:
CompareOperation, Operation
Direct Known Subclasses:
LocalBackendCompareOperation

public abstract class CompareOperationWrapper
extends OperationWrapper
implements CompareOperation

This abstract class wraps/decorates a given compare operation. This class will be extended by sub-classes to enhance the functionnality of the CompareOperationBasis.


Field Summary
 
Fields inherited from interface org.opends.server.types.Operation
LOCALBACKENDOPERATIONS
 
Constructor Summary
CompareOperationWrapper(CompareOperation compare)
          Creates a new compare operation based on the provided compare operation.
 
Method Summary
 ByteString getAssertionValue()
          Retrieves the assertion value for this compare operation.
 AttributeType getAttributeType()
          Retrieves the attribute type for this compare operation.
 DN getEntryDN()
          Retrieves the DN of the entry to compare.
 DN getProxiedAuthorizationDN()
          Retrieves the proxied authorization target DN 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 setAttributeType(AttributeType attributeType)
          Specifies the attribute type for this compare operation.
 void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
          Specifies the proxied authorization target DN 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 class org.opends.server.core.OperationWrapper
abort, addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogMessage, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getCommonLogElements, getConnectionID, getErrorMessage, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControls, getRequestLogElements, getResponseControls, getResponseLogElements, getResultCode, isInternalOperation, isSynchronizationOperation, operationCompleted, removeAttachment, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInternalOperation, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opends.server.types.Operation
abort, addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogMessage, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getCommonLogElements, getConnectionID, getErrorMessage, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControls, getRequestLogElements, getResponseControls, getResponseLogElements, getResultCode, isInternalOperation, isSynchronizationOperation, operationCompleted, removeAttachment, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInternalOperation, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, toString
 

Constructor Detail

CompareOperationWrapper

public CompareOperationWrapper(CompareOperation compare)
Creates a new compare operation based on the provided compare operation.

Parameters:
compare - The compare operation to wrap
Method Detail

getRawEntryDN

public ByteString getRawEntryDN()
Retrieves the raw, unprocessed entry DN as included in the client request. The DN that is returned may or may not be a valid DN, since no validation will have been performed upon it.

Specified by:
getRawEntryDN in interface CompareOperation
Returns:
The raw, unprocessed entry DN as included in the client request.

setRawEntryDN

public void setRawEntryDN(ByteString rawEntryDN)
Specifies the raw, unprocessed entry DN as included in the client request. This should only be called by pre-parse plugins.

Specified by:
setRawEntryDN in interface CompareOperation
Parameters:
rawEntryDN - The raw, unprocessed entry DN as included in the client request.

getEntryDN

public DN getEntryDN()
Retrieves the DN of the entry to compare. This should not be called by pre-parse plugins because the processed DN will not be available yet. Instead, they should call the getRawEntryDN method.

Specified by:
getEntryDN in interface CompareOperation
Returns:
The DN of the entry to compare, or null if the raw entry DN has not yet been processed.

getRawAttributeType

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

Specified by:
getRawAttributeType in interface CompareOperation
Returns:
The raw attribute type for this compare operation.

setRawAttributeType

public void setRawAttributeType(java.lang.String rawAttributeType)
Specifies the raw attribute type for this compare operation. This should only be called by pre-parse plugins.

Specified by:
setRawAttributeType in interface CompareOperation
Parameters:
rawAttributeType - The raw attribute type for this compare operation.

getAttributeType

public AttributeType getAttributeType()
Retrieves the attribute type for this compare operation. This should not be called by pre-parse plugins because the processed attribute type will not be available yet.

Specified by:
getAttributeType in interface CompareOperation
Returns:
The attribute type for this compare operation.

setAttributeType

public void setAttributeType(AttributeType attributeType)
Specifies the attribute type for this compare operation.

Specified by:
setAttributeType in interface CompareOperation
Parameters:
attributeType - The attribute type for this compare operation.

getAssertionValue

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

Specified by:
getAssertionValue in interface CompareOperation
Returns:
The assertion value for this compare operation.

setAssertionValue

public void setAssertionValue(ByteString assertionValue)
Specifies the assertion value for this compare operation. This should only be called by pre-parse and pre-operation plugins.

Specified by:
setAssertionValue in interface CompareOperation
Parameters:
assertionValue - The assertion value for this compare operation.

getProxiedAuthorizationDN

public DN getProxiedAuthorizationDN()
Retrieves the proxied authorization target DN for this compare operation.

Specified by:
getProxiedAuthorizationDN in interface CompareOperation
Returns:
The proxied authorization target DN for this compare operation

setProxiedAuthorizationDN

public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
Specifies the proxied authorization target DN for this compare operation.

Specified by:
setProxiedAuthorizationDN in interface CompareOperation
Parameters:
proxiedAuthorizationDN - The proxied authorization target DN for this compare operation