Package org.opends.server.core

Interface CompareOperation

All Superinterfaces:

Operation, Runnable

All Known Implementing Classes:

CompareOperationBasis, CompareOperationWrapper, LocalBackendCompareOperation

public interface CompareOperation
extends Operation

This interface defines an operation that may be used to determine whether a specified entry in the Directory Server contains a given attribute-value pair.

Field Summary

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

LOCALBACKENDOPERATIONS

Method Summary

Modifier and Type	Method	Description
ByteString	getAssertionValue()	Retrieves the assertion value for this compare operation.
AttributeDescription	getAttributeDescription()	Retrieves the attribute description 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.
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	setProxiedAuthorizationDN(DN proxiedAuthorizationDN)	Specifies the proxied authorization target DN for this compare operation.
void	setRawAttributeType(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

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

Method Detail

getRawEntryDN

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.

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. This should only be called by pre-parse plugins.

Parameters:

rawEntryDN - The raw, unprocessed entry DN as included in the client request.

getEntryDN

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.

Returns:

The DN of the entry to compare, or null if the raw entry DN has not yet been processed.

getRawAttributeType

String getRawAttributeType()

Retrieves the raw attribute type for this compare operation.

Returns:

The raw attribute type for this compare operation.

setRawAttributeType

void setRawAttributeType(String rawAttributeType)

Specifies the raw attribute type for this compare operation. This should only be called by pre-parse plugins.

Parameters:

rawAttributeType - The raw attribute type for this compare operation.

getAttributeDescription

AttributeDescription getAttributeDescription()

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

Returns:

The attribute description 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. This should only be called by pre-parse and pre-operation plugins.

Parameters:

assertionValue - The assertion value for this compare operation.

getProxiedAuthorizationDN

DN getProxiedAuthorizationDN()

Retrieves the proxied authorization target DN for this compare operation.

Specified by:

getProxiedAuthorizationDN in interface Operation

Returns:

The proxied authorization target DN for this compare operation

setProxiedAuthorizationDN

void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)

Specifies the proxied authorization target DN for this compare operation.

Specified by:

setProxiedAuthorizationDN in interface Operation

Parameters:

proxiedAuthorizationDN - The proxied authorization target DN for this compare operation