org.opends.server.core

Class CompareOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.CompareOperation

All Implemented Interfaces:

Runnable, PluginOperation, PostOperationCompareOperation, PostOperationOperation, PostResponseCompareOperation, PostResponseOperation, PreOperationCompareOperation, PreOperationOperation, PreParseCompareOperation, PreParseOperation

public final class CompareOperation
extends Operation
implements PreParseCompareOperation, PreOperationCompareOperation, PostOperationCompareOperation, PostResponseCompareOperation

This class 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 class org.opends.server.types.Operation

NO_RESPONSE_CONTROLS, requestContext

Constructor Summary

Constructors

Constructor and Description
CompareOperation(org.forgerock.services.context.Context context, CompareRequest compareRequest) Creates a new compare operation with the provided information.

Method Summary

Modifier and Type	Method and Description
void	addResponseControl(Control control) Adds the provided control to the set of controls to include in the response to the client.
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.
Entry	getEntryToCompare() Retrieves the entry to target with the compare operation.
OperationType	getOperationType() Retrieves the operation type for this operation.
Dn	getProxiedAuthorizationDN() Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.
List<Control>	getResponseControls() Retrieves the set of controls to include in the response to the client.
void	removeResponseControl(Control control) Removes the provided control from the set of controls to include in the response to the client.
void	run() Performs the work of actually processing this operation.
void	setAssertionValue(ByteString assertionValue) Specifies the assertion value for this compare operation.
void	setAttributeDescription(AttributeDescription attributeDescription) Specifies the attribute description for this compare operation.
void	setEntryDN(Dn entryDN) Specifies the entry DN as included in the client request.
void	setProxiedAuthorizationDN(Dn proxiedAuthorizationDN) Set the proxied authorization DN for this operation if proxied authorization has been requested.
void	toString(StringBuilder buffer) Appends a string representation of this operation to the provided buffer.
void	updateOperationErrMsgAndResCode() Updates the error message and the result code of the operation.

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

addAdditionalLogItem, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, disconnectClient, dontSynchronize, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDN, findMatchedDN, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getLocalBackend, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, invokePostResponseCallbacks, isHumanReadable, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAllDisallowedControls, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, setSynchronizationOperation, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opends.server.types.operation.PreParseOperation

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage

Methods inherited from interface org.opends.server.types.operation.PreOperationOperation

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, setErrorMessage

Methods inherited from interface org.opends.server.types.operation.PostOperationOperation

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode

Methods inherited from interface org.opends.server.types.operation.PostResponseOperation

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode

Methods inherited from interface org.opends.server.types.operation.PluginOperation

checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString

Constructor Detail

CompareOperation

public CompareOperation(org.forgerock.services.context.Context context,
                        CompareRequest compareRequest)

Creates a new compare operation with the provided information.

Parameters:

context - The request context with which this operation is associated.

compareRequest - The compare request.

Method Detail

setEntryDN

public void setEntryDN(Dn entryDN)

Specifies the entry DN as included in the client request. This should only be called by preparse plugins.

Specified by:

setEntryDN in interface PreParseCompareOperation

Parameters:

entryDN - The entry DN as included in the client request.

getEntryDN

public Dn getEntryDN()

Retrieves the DN of the entry to compare.

Specified by:

getEntryDN in interface PostOperationCompareOperation

Specified by:

getEntryDN in interface PostResponseCompareOperation

Specified by:

getEntryDN in interface PreOperationCompareOperation

Specified by:

getEntryDN in interface PreParseCompareOperation

Returns:

The DN of the entry to compare.

setAttributeDescription

public void setAttributeDescription(AttributeDescription attributeDescription)

Description copied from interface: PreParseCompareOperation

Specifies the attribute description for this compare operation.

Specified by:

setAttributeDescription in interface PreParseCompareOperation

Parameters:

attributeDescription - The attribute description for this compare operation.

getAttributeDescription

public AttributeDescription getAttributeDescription()

Description copied from interface: PreParseCompareOperation

Retrieves the attribute description for this compare operation.

Specified by:

getAttributeDescription in interface PostOperationCompareOperation

Specified by:

getAttributeDescription in interface PostResponseCompareOperation

Specified by:

getAttributeDescription in interface PreOperationCompareOperation

Specified by:

getAttributeDescription in interface PreParseCompareOperation

Returns:

The attribute description for this compare operation.

getAssertionValue

public ByteString getAssertionValue()

Retrieves the assertion value for this compare operation.

Specified by:

getAssertionValue in interface PostOperationCompareOperation

Specified by:

getAssertionValue in interface PostResponseCompareOperation

Specified by:

getAssertionValue in interface PreOperationCompareOperation

Specified by:

getAssertionValue in interface PreParseCompareOperation

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 preparse and preoperation plugins.

Specified by:

setAssertionValue in interface PreOperationCompareOperation

Specified by:

setAssertionValue in interface PreParseCompareOperation

Parameters:

assertionValue - The assertion value for this compare operation.

getOperationType

public OperationType getOperationType()

Description copied from interface: PluginOperation

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface PluginOperation

Returns:

The operation type for this operation.

getProxiedAuthorizationDN

public Dn getProxiedAuthorizationDN()

Retrieves the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

getProxiedAuthorizationDN in class Operation

Returns:

The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.

setProxiedAuthorizationDN

public void setProxiedAuthorizationDN(Dn proxiedAuthorizationDN)

Description copied from class: Operation

Set the proxied authorization DN for this operation if proxied authorization has been requested.

Specified by:

setProxiedAuthorizationDN in class Operation

Parameters:

proxiedAuthorizationDN - The proxied authorization DN for this operation if proxied authorization has been requested, or null if proxied authorization has not been requested.

getResponseControls

public List<Control> getResponseControls()

Description copied from interface: PluginOperation

Retrieves the set of controls to include in the response to the client. The contents of this list must not be altered.

Specified by:

getResponseControls in interface PluginOperation

Returns:

The set of controls to include in the response to the client.

addResponseControl

public void addResponseControl(Control control)

Description copied from class: Operation

Adds the provided control to the set of controls to include in the response to the client. This method may not be called by post-response plugins.

Specified by:

addResponseControl in interface PostOperationOperation

Specified by:

addResponseControl in interface PreOperationOperation

Specified by:

addResponseControl in interface PreParseOperation

Specified by:

addResponseControl in class Operation

Parameters:

control - The control to add to the set of controls to include in the response to the client.

removeResponseControl

public void removeResponseControl(Control control)

Description copied from class: Operation

Removes the provided control from the set of controls to include in the response to the client. This method may not be called by post-response plugins.

Specified by:

removeResponseControl in interface PostOperationOperation

Specified by:

removeResponseControl in interface PreOperationOperation

Specified by:

removeResponseControl in interface PreParseOperation

Specified by:

removeResponseControl in class Operation

Parameters:

control - The control to remove from the set of controls to include in the response to the client.

run

public void run()

Description copied from class: Operation

Performs the work of actually processing this operation. This should include all processing for the operation, including invoking pre-parse and post-response plugins, logging messages and any other work that might need to be done in the course of processing.

Specified by:

run in interface Runnable

Specified by:

run in class Operation

updateOperationErrMsgAndResCode

public void updateOperationErrMsgAndResCode()

Description copied from class: Operation

Updates the error message and the result code of the operation. This method is called because the operation could not be routed to any local backends.

Overrides:

updateOperationErrMsgAndResCode in class Operation

toString

public void toString(StringBuilder buffer)

Description copied from class: Operation

Appends a string representation of this operation to the provided buffer.

Specified by:

toString in interface PluginOperation

Specified by:

toString in class Operation

Parameters:

buffer - The buffer into which a string representation of this operation should be appended.

getEntryToCompare

public Entry getEntryToCompare()

Retrieves the entry to target with the compare operation.

Specified by:

getEntryToCompare in interface PostOperationCompareOperation

Specified by:

getEntryToCompare in interface PostResponseCompareOperation

Specified by:

getEntryToCompare in interface PreOperationCompareOperation

Returns:

The entry to target with the compare operation, or null if the entry is not yet available.