Package org.opends.server.core

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

backend, context, out, pluginConfigManager, request, serverContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
CompareRequest	getRequest()	Returns the request associated to this operation.
List<Control>	getResponseControls()	Retrieves the set of controls to include in the response to the client.
protected void	invokePostResponsePlugins()	Invokes any applicable post-response plugins.
protected boolean	invokePreParsePlugins()	Invokes any applicable pre-parse plugins.
void	removeResponseControl(Control control)	Removes the provided control from the set of controls to include in the response to the client.
protected boolean	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 org.opends.server.types.Operation

addAdditionalLogItem, addPasswordPolicyWarningToLog, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, createLdapException, equals, evaluateProxyAuthControls, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getErrorMessage, getLargestEntrySize, getMatchedDN, getMessageID, getOperationID, getProxiedAuthorizationDN, getReferralURLs, getRequestContext, getRequestControl, getRequestControls, getResultCode, hashCode, hasPrivilege, hasRequestControl, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, operationToResult, processOperationResult, removeAllDisallowedControls, run, sendResponses, sendResult, setAttachment, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, toString, trySetLargestEntrySize

Methods inherited from class java.lang.Object

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

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

checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequestControl, getRequestControl, getRequestControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString

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

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

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

getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode

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

addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, sendResponses, setErrorMessage

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

addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, sendResponses, setErrorMessage

Constructor Details

CompareOperation

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

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.

Method Details

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 for this compare operation.

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

Description copied from interface: PreParseCompareOperation

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.

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.

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.

runImpl

protected boolean runImpl()
                   throws LdapException

Description copied from class: Operation

Performs the work of actually processing this operation.

Specified by:

runImpl in class Operation

Returns:

true if the result should be sent immediately, or false if it will be sent later, e.g. as part of a persistent search.

Throws:

LdapException - If an error occurred when processing the operation.

invokePreParsePlugins

protected boolean invokePreParsePlugins()
                                 throws LdapException

Description copied from class: Operation

Invokes any applicable pre-parse plugins.

Specified by:

invokePreParsePlugins in class Operation

Returns:

true if processing should continue.

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

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.