public class CompareOperationBasis extends AbstractOperation implements PreParseCompareOperation, CompareOperation, PostResponseCompareOperation
cancelRequest, cancelResult, clientConnection, messageID, NO_RESPONSE_CONTROLS, operationID
LOCALBACKENDOPERATIONS
Constructor and Description |
---|
CompareOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
org.forgerock.opendj.ldap.messages.CompareRequest compareRequest)
Creates a new compare operation with the provided information.
|
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.
|
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.
|
org.forgerock.opendj.ldap.AttributeDescription |
getAttributeDescription()
Retrieves the attribute description for this compare operation.
|
org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.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 |
setProxiedAuthorizationDN(org.forgerock.opendj.ldap.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, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage
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
getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getProcessingStopTime, getProcessingTime, getReferralURLs, getResultCode
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getProcessingStartTime, getRequestControl, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString
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)
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, org.forgerock.opendj.ldap.messages.CompareRequest compareRequest)
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.compareRequest
- The compare request.public final org.forgerock.opendj.ldap.ByteString getRawEntryDN()
PreParseCompareOperation
getRawEntryDN
in interface CompareOperation
getRawEntryDN
in interface PostResponseCompareOperation
getRawEntryDN
in interface PreParseCompareOperation
public final void setRawEntryDN(org.forgerock.opendj.ldap.ByteString rawEntryDN)
PreParseCompareOperation
setRawEntryDN
in interface CompareOperation
setRawEntryDN
in interface PreParseCompareOperation
rawEntryDN
- The raw entry DN for this compare operation.public final org.forgerock.opendj.ldap.Dn getEntryDN()
CompareOperation
getRawEntryDN
method.getEntryDN
in interface CompareOperation
getEntryDN
in interface PostResponseCompareOperation
null
if the raw
entry DN has not yet been processed.public final String getRawAttributeType()
PreParseCompareOperation
getRawAttributeType
in interface CompareOperation
getRawAttributeType
in interface PostResponseCompareOperation
getRawAttributeType
in interface PreParseCompareOperation
public final void setRawAttributeType(String rawAttributeType)
PreParseCompareOperation
setRawAttributeType
in interface CompareOperation
setRawAttributeType
in interface PreParseCompareOperation
rawAttributeType
- The raw attribute type for this compare
operation.public final org.forgerock.opendj.ldap.AttributeDescription getAttributeDescription()
CompareOperation
getAttributeDescription
in interface CompareOperation
getAttributeDescription
in interface PostResponseCompareOperation
public final org.forgerock.opendj.ldap.ByteString getAssertionValue()
PreParseCompareOperation
getAssertionValue
in interface CompareOperation
getAssertionValue
in interface PostResponseCompareOperation
getAssertionValue
in interface PreParseCompareOperation
public final void setAssertionValue(org.forgerock.opendj.ldap.ByteString assertionValue)
PreParseCompareOperation
setAssertionValue
in interface CompareOperation
setAssertionValue
in interface PreParseCompareOperation
assertionValue
- The assertion value for this compare
operation.public final OperationType getOperationType()
PluginOperation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public org.forgerock.opendj.ldap.Dn getProxiedAuthorizationDN()
getProxiedAuthorizationDN
in interface CompareOperation
getProxiedAuthorizationDN
in interface Operation
null
if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(org.forgerock.opendj.ldap.Dn proxiedAuthorizationDN)
CompareOperation
setProxiedAuthorizationDN
in interface CompareOperation
setProxiedAuthorizationDN
in interface Operation
proxiedAuthorizationDN
- The proxied authorization target DN for
this compare operationpublic final List<Control> getResponseControls()
PluginOperation
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
public final void addResponseControl(Control control)
PreParseOperation
addResponseControl
in interface Operation
addResponseControl
in interface PreParseOperation
control
- The control to add to the set of controls to
include in the response to the client.public final void removeResponseControl(Control control)
PreParseOperation
removeResponseControl
in interface Operation
removeResponseControl
in interface PreParseOperation
control
- 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 AbstractOperation
public final void toString(StringBuilder buffer)
PluginOperation
toString
in interface Operation
toString
in interface PluginOperation
buffer
- The buffer into which a string representation of
this operation should be appended.public Entry getEntryToCompare()
getEntryToCompare
in interface PostResponseCompareOperation
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.