org.opends.server.core

Class CompareOperationBasis

java.lang.Object

org.opends.server.types.AbstractOperation

org.opends.server.core.CompareOperationBasis

All Implemented Interfaces:

Runnable, CompareOperation, Operation, PluginOperation, PostResponseCompareOperation, PostResponseOperation, PreParseCompareOperation, PreParseOperation

public class CompareOperationBasis
extends AbstractOperation
implements PreParseCompareOperation, CompareOperation, 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.AbstractOperation

cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID

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

LOCALBACKENDOPERATIONS

Constructor Summary

Constructors

Constructor and Description
CompareOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, org.forgerock.opendj.ldap.ByteString rawEntryDN, String rawAttributeType, org.forgerock.opendj.ldap.ByteString assertionValue) Creates a new compare operation with the provided information.
CompareOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, DN entryDN, AttributeType attributeType, org.forgerock.opendj.ldap.ByteString assertionValue) Creates a new compare operation with the provided information.

Method Summary

Methods

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.
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.
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.
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.
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(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	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(org.forgerock.opendj.ldap.ByteString rawEntryDN) Specifies the raw, unprocessed entry DN as included in the client request.
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.AbstractOperation

abort, addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, equals, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getConnectionID, getErrorMessage, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, invokePostResponseCallbacks, isInnerOperation, isInternalOperation, isSynchronizationOperation, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResultCode, 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

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

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, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString

Constructor Detail

CompareOperationBasis

public CompareOperationBasis(ClientConnection clientConnection,
                     long operationID,
                     int messageID,
                     List<Control> requestControls,
                     org.forgerock.opendj.ldap.ByteString rawEntryDN,
                     String rawAttributeType,
                     org.forgerock.opendj.ldap.ByteString assertionValue)

Creates a new compare operation with the provided information.

Parameters:

clientConnection - The client connection with which this operation is associated.

operationID - The operation ID for this operation.

messageID - The message ID of the request with which this operation is associated.

requestControls - The set of controls included in the request.

rawEntryDN - The raw, unprocessed entry DN as provided in the client request. This may or may not be a valid DN as no validation will have been performed yet.

rawAttributeType - The raw attribute type for the compare operation.

assertionValue - The assertion value for the compare operation.

CompareOperationBasis

public CompareOperationBasis(ClientConnection clientConnection,
                     long operationID,
                     int messageID,
                     List<Control> requestControls,
                     DN entryDN,
                     AttributeType attributeType,
                     org.forgerock.opendj.ldap.ByteString assertionValue)

Creates a new compare operation with the provided information.

Parameters:

clientConnection - The client connection with which this operation is associated.

operationID - The operation ID for this operation.

messageID - The message ID of the request with which this operation is associated.

requestControls - The set of controls included in the request.

entryDN - The entry DN for this compare operation.

attributeType - The attribute type for this compare operation.

assertionValue - The assertion value for the compare operation.

Method Detail

getRawEntryDN

public final org.forgerock.opendj.ldap.ByteString getRawEntryDN()

Retrieves the raw, unprocessed entry DN as included in the client request.

Specified by:

getRawEntryDN in interface CompareOperation

Specified by:

getRawEntryDN in interface PostResponseCompareOperation

Specified by:

getRawEntryDN in interface PreParseCompareOperation

Returns:

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

setRawEntryDN

public final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)

Specifies the raw, unprocessed entry DN as included in the client request.

Specified by:

setRawEntryDN in interface CompareOperation

Specified by:

setRawEntryDN in interface PreParseCompareOperation

Parameters:

rawEntryDN - The raw entry DN for this compare operation.

getEntryDN

public final 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

Specified by:

getEntryDN in interface PostResponseCompareOperation

Returns:

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

getRawAttributeType

public final String getRawAttributeType()

Retrieves the raw attribute type for this compare operation.

Specified by:

getRawAttributeType in interface CompareOperation

Specified by:

getRawAttributeType in interface PostResponseCompareOperation

Specified by:

getRawAttributeType in interface PreParseCompareOperation

Returns:

The raw attribute type for this compare operation.

setRawAttributeType

public final void setRawAttributeType(String rawAttributeType)

Specifies the raw attribute type for this compare operation.

Specified by:

setRawAttributeType in interface CompareOperation

Specified by:

setRawAttributeType in interface PreParseCompareOperation

Parameters:

rawAttributeType - The raw attribute type for this compare operation.

getAttributeType

public final 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

Specified by:

getAttributeType in interface PostResponseCompareOperation

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 final org.forgerock.opendj.ldap.ByteString getAssertionValue()

Retrieves the assertion value for this compare operation.

Specified by:

getAssertionValue in interface CompareOperation

Specified by:

getAssertionValue in interface PostResponseCompareOperation

Specified by:

getAssertionValue in interface PreParseCompareOperation

Returns:

The assertion value for this compare operation.

setAssertionValue

public final void setAssertionValue(org.forgerock.opendj.ldap.ByteString assertionValue)

Specifies the assertion value for this compare operation.

Specified by:

setAssertionValue in interface CompareOperation

Specified by:

setAssertionValue in interface PreParseCompareOperation

Parameters:

assertionValue - The assertion value for this compare operation.

getOperationType

public final OperationType getOperationType()

Retrieves the operation type for this operation.

Specified by:

getOperationType in interface 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 interface CompareOperation

Specified by:

getProxiedAuthorizationDN in interface 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)

Specifies the proxied authorization target DN for this compare operation.

Specified by:

setProxiedAuthorizationDN in interface CompareOperation

Specified by:

setProxiedAuthorizationDN in interface Operation

Parameters:

proxiedAuthorizationDN - The proxied authorization target DN for this compare operation

getResponseControls

public final List<Control> getResponseControls()

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 Operation

Specified by:

getResponseControls in interface PluginOperation

Returns:

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

addResponseControl

public final void addResponseControl(Control control)

Adds the provided control to the set of controls to include in the response to the client.

Specified by:

addResponseControl in interface Operation

Specified by:

addResponseControl in interface PreParseOperation

Parameters:

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

removeResponseControl

public final void removeResponseControl(Control control)

Removes the provided control from the set of controls to include in the response to the client.

Specified by:

removeResponseControl in interface Operation

Specified by:

removeResponseControl in interface PreParseOperation

Parameters:

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

run

public final void run()

Performs the work of actually processing this operation. This should include all processing for the operation, including invoking plugins, logging messages, performing access control, managing synchronization, 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 interface Operation

updateOperationErrMsgAndResCode

public void updateOperationErrMsgAndResCode()

Updates the error message and the result code of the operation. This method is called because no workflow was found to process the operation.

Overrides:

updateOperationErrMsgAndResCode in class AbstractOperation

toString

public final void toString(StringBuilder buffer)

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

Specified by:

toString in interface Operation

Specified by:

toString in interface PluginOperation

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. This method always returns null.

Specified by:

getEntryToCompare in interface PostResponseCompareOperation

Returns:

The entry to target with the compare operation.