Class CompareOperation

java.lang.Object

org.opends.server.types.Operation

org.opends.server.core.CompareOperation

All Implemented Interfaces:

PluginOperation, PostCommitOperation, 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 Operation

backend, context, out, pluginConfigManager, request, result, serverContext

Constructor Summary

Constructors

Constructor	Description
CompareOperation(RequestContext context, LocalBackend<?> backend, CompareRequest request, Consumer<Response> out, ServerContext serverContext)	Creates a new compare operation.

Method Summary

Modifier and Type	Method	Description
ByteString	getAssertionValue()	Returns the assertion value for this compare operation.
AttributeDescription	getAttributeDescription()	Returns the attribute description for this compare operation.
Dn	getEntryDn()	Returns the entry DN as included in the client request.
Entry	getEntryToCompare()	Returns the entry to target with the compare operation.
CompareRequest	getRequest()	Returns the request associated to this operation.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected void	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
protected Result	runImpl()	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	toString(StringBuilder buffer)	Appends a string representation of this operation to the provided buffer.

Methods inherited from class Operation

addAdditionalLogItem, addPasswordPolicyWarningToLog, addPostReadResponse, addPreReadResponse, addRequestControl, addResponseControl, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDn, getAccessControlHandler, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDn, getAuthorizationEntry, getClientConnection, getConnectionId, getMessageId, getOperationId, getProxiedAuthorizationDN, getRequestContext, getRequestControl, getRequestControls, getResponseControls, getResult, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationToResult, removeAllDisallowedControls, removeResponseControl, run, sendIntermediateResponse, sendResult, setAttachment, setResult, setResult, toString

Methods inherited from class Object

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

Methods inherited from interface PluginOperation

checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionId, getMessageId, getOperationId, getRequestControl, getRequestControl, getRequestControls, getResponseControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString

Methods inherited from interface PostOperationOperation

addAdditionalLogItem, addResponseControl, getAdditionalLogItems, getAuthorizationDn, getResultCode, removeResponseControl, setResult, setResult

Methods inherited from interface PostResponseOperation

getAdditionalLogItems, getAuthorizationDn, getResultCode

Methods inherited from interface PreOperationOperation

addAdditionalLogItem, addResponseControl, getAdditionalLogItems, getAuthorizationDn, removeResponseControl, sendIntermediateResponse

Methods inherited from interface PreParseOperation

addAdditionalLogItem, addRequestControl, addResponseControl, getAdditionalLogItems, removeResponseControl, sendIntermediateResponse

Constructor Details

CompareOperation

public CompareOperation(RequestContext context,
 LocalBackend<?> backend,
 CompareRequest request,
 Consumer<Response> out,
 ServerContext serverContext)

Creates a new compare operation.

Parameters:

context - The context.

backend - The local backend in which this request is to be processed.

request - The request.

out - A consumer responsible for sending responses to the client.

serverContext - the server context

Method Details

setEntryDn

public void setEntryDn(Dn entryDn)

Description copied from interface: PreParseCompareOperation

Specifies the entry DN as included in the client request.

Specified by:

setEntryDn in interface PreParseCompareOperation

Parameters:

entryDn - The entry DN for this compare operation.

getEntryDn

public Dn getEntryDn()

Description copied from interface: PreParseCompareOperation

Returns the entry DN as included in the client request.

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 entry DN as included in the client request

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

Returns 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()

Description copied from interface: PreParseCompareOperation

Returns 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.

getRequest

public CompareRequest getRequest()

Description copied from class: Operation

Returns the request associated to this operation.

Specified by:

getRequest in interface PluginOperation

Overrides:

getRequest in class Operation

Returns:

the request associated to this operation

runImpl

protected Result runImpl()
                  throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

null if the result is delayed (e.g. persistent search), Result otherwise.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected void invokePreParsePlugins()
                              throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Throws:

LdapException - If an error occurred when invoking the pre-parse plugins.

invokePostResponsePlugins

protected void invokePostResponsePlugins()

Description copied from class: Operation

Invokes any applicable post-response plugins.

Specified by:

invokePostResponsePlugins in class Operation

toString

public void toString(StringBuilder buffer)

Description copied from interface: PluginOperation

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()

Description copied from interface: PreOperationCompareOperation

Returns 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