public class CompareOperationBasis extends AbstractOperation implements PreParseCompareOperation, CompareOperation, PostResponseCompareOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationIDLOCALBACKENDOPERATIONS| 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.
|
| 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.
|
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, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitaddAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessageabort, 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, toStringgetAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCodecheckIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toStringpublic CompareOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, org.forgerock.opendj.ldap.ByteString rawEntryDN, String rawAttributeType, org.forgerock.opendj.ldap.ByteString assertionValue)
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.public CompareOperationBasis(ClientConnection clientConnection, long operationID, int messageID, List<Control> requestControls, DN entryDN, AttributeType attributeType, org.forgerock.opendj.ldap.ByteString assertionValue)
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.public final org.forgerock.opendj.ldap.ByteString getRawEntryDN()
getRawEntryDN in interface CompareOperationgetRawEntryDN in interface PostResponseCompareOperationgetRawEntryDN in interface PreParseCompareOperationpublic final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)
setRawEntryDN in interface CompareOperationsetRawEntryDN in interface PreParseCompareOperationrawEntryDN - The raw entry DN for this compare operation.public final DN getEntryDN()
getRawEntryDN method.getEntryDN in interface CompareOperationgetEntryDN in interface PostResponseCompareOperationnull if the raw
entry DN has not yet been processed.public final String getRawAttributeType()
getRawAttributeType in interface CompareOperationgetRawAttributeType in interface PostResponseCompareOperationgetRawAttributeType in interface PreParseCompareOperationpublic final void setRawAttributeType(String rawAttributeType)
setRawAttributeType in interface CompareOperationsetRawAttributeType in interface PreParseCompareOperationrawAttributeType - The raw attribute type for this compare
operation.public final AttributeType getAttributeType()
getAttributeType in interface CompareOperationgetAttributeType in interface PostResponseCompareOperationpublic void setAttributeType(AttributeType attributeType)
setAttributeType in interface CompareOperationattributeType - The attribute type for this compare operation.public Set<String> getAttributeOptions()
getAttributeOptions in interface CompareOperationpublic void setAttributeOptions(Set<String> attributeOptions)
setAttributeOptions in interface CompareOperationattributeOptions - The attribute options for this compare operation.public final org.forgerock.opendj.ldap.ByteString getAssertionValue()
getAssertionValue in interface CompareOperationgetAssertionValue in interface PostResponseCompareOperationgetAssertionValue in interface PreParseCompareOperationpublic final void setAssertionValue(org.forgerock.opendj.ldap.ByteString assertionValue)
setAssertionValue in interface CompareOperationsetAssertionValue in interface PreParseCompareOperationassertionValue - The assertion value for this compare
operation.public final OperationType getOperationType()
getOperationType in interface OperationgetOperationType in interface PluginOperationpublic DN getProxiedAuthorizationDN()
getProxiedAuthorizationDN in interface CompareOperationgetProxiedAuthorizationDN in interface Operationnull if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN in interface CompareOperationsetProxiedAuthorizationDN in interface OperationproxiedAuthorizationDN - The proxied authorization target DN for
this compare operationpublic final List<Control> getResponseControls()
getResponseControls in interface OperationgetResponseControls in interface PluginOperationpublic final void addResponseControl(Control control)
addResponseControl in interface OperationaddResponseControl in interface PreParseOperationcontrol - The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
removeResponseControl in interface OperationremoveResponseControl in interface PreParseOperationcontrol - The control to remove from the set of controls
to include in the response to the client.public final void run()
public void updateOperationErrMsgAndResCode()
updateOperationErrMsgAndResCode in class AbstractOperationpublic final void toString(StringBuilder buffer)
toString in interface OperationtoString in interface PluginOperationbuffer - The buffer into which a string representation of
this operation should be appended.public Entry getEntryToCompare()
getEntryToCompare in interface PostResponseCompareOperationCopyright © 2010-2015 ForgeRock AS. All Rights Reserved.