org.opends.server.core

Class CompareOperationWrapper

java.lang.Object

org.opends.server.core.OperationWrapper<CompareOperation>

org.opends.server.core.CompareOperationWrapper

All Implemented Interfaces:

Runnable, CompareOperation, Operation

Direct Known Subclasses:

LocalBackendCompareOperation

public abstract class CompareOperationWrapper
extends OperationWrapper<CompareOperation>
implements CompareOperation

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

Field Summary

Fields inherited from interface org.opends.server.types.Operation

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor and Description
CompareOperationWrapper(CompareOperation compare) Creates a new compare operation based on the provided compare operation.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.ldap.ByteString	getAssertionValue() Retrieves the assertion value for this compare operation.
Set<String>	getAttributeOptions() Retrieves the attribute options for this compare operation.
AttributeType	getAttributeType() Retrieves the attribute type for this compare operation.
DN	getEntryDN() Retrieves the DN of the entry to compare.
String	getRawAttributeType() Retrieves the raw attribute type for this compare operation.
org.forgerock.opendj.ldap.ByteString	getRawEntryDN() Retrieves the raw, unprocessed entry DN as included in the client request.
void	setAssertionValue(org.forgerock.opendj.ldap.ByteString assertionValue) Specifies the assertion value for this compare operation.
void	setAttributeOptions(Set<String> attributeOptions) Specifies the attribute options for this compare operation.
void	setAttributeType(AttributeType attributeType) Specifies the attribute type for this compare operation.
void	setRawAttributeType(String rawAttributeType) Specifies the raw attribute type for this compare operation.
void	setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN) Specifies the raw, unprocessed entry DN as included in the client request.

Methods inherited from class org.opends.server.core.OperationWrapper

abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperation, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getProxiedAuthorizationDN, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, hashCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProxiedAuthorizationDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opends.server.core.CompareOperation

getProxiedAuthorizationDN, setProxiedAuthorizationDN

Methods inherited from interface org.opends.server.types.Operation

abort, addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResponseControls, getResultCode, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, registerPostResponseCallback, removeAttachment, removeResponseControl, run, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, 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 org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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 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(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.

getAttributeOptions

public Set<String> getAttributeOptions()

Retrieves the attribute options for this compare operation. This should not be called by the pre-parse plugins because the processed attribute options will not be available yet.

Specified by:

getAttributeOptions in interface CompareOperation

Returns:

The attribute options for this compare operation.

setAttributeOptions

public void setAttributeOptions(Set<String> attributeOptions)

Specifies the attribute options for this compare operation.

Specified by:

setAttributeOptions in interface CompareOperation

Parameters:

attributeOptions - The attribute options for this compare operation.

getAssertionValue

public org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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.