public final class CompareOperationBasis extends AbstractOperation implements CompareOperation, PreParseCompareOperation, PreOperationCompareOperation, PostOperationCompareOperation, PostResponseCompareOperation
NO_RESPONSE_CONTROLS, requestContext
Constructor and Description |
---|
CompareOperationBasis(org.forgerock.services.context.Context context,
CompareRequest compareRequest)
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.
|
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.
|
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.
|
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(ByteString assertionValue)
Specifies the assertion value 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(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.
|
addAdditionalLogItem, addPostReadResponse, addPreReadResponse, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, checkAttributeConformsToSyntax, checkIfBackendIsWritable, checkIfCanceled, disconnectClient, dontSynchronize, equals, evaluateProxyAuthControls, filterNonDisclosableMatchedDN, findMatchedDN, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, getErrorMessage, getLocalBackend, getMaskedErrorMessage, getMaskedResultCode, getMatchedDN, getMessageID, getOperationID, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControl, getRequestControls, getResultCode, hashCode, invokePostResponseCallbacks, isHumanReadable, isInnerOperation, isInternalOperation, isProxyAuthzControl, isSynchronizationOperation, mustCheckSchema, newDirectoryException, operationCompleted, processOperationResult, processOperationResult, registerPostResponseCallback, removeAllDisallowedControls, removeAttachment, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInnerOperation, setInternalOperation, setMaskedErrorMessage, setMaskedResultCode, setMatchedDN, setProcessingStartTime, setProcessingStopTime, setReferralURLs, setResponseData, setResult, setResultCode, setResultCodeAndMessageNoInfoDisclosure, setSynchronizationOperation, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addAdditionalLogItem, addRequestControl, appendErrorMessage, appendMaskedErrorMessage, disconnectClient, dontSynchronize, getAdditionalLogItems, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getClientConnection, getConnectionID, getContext, 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, setResult, setResultCode, setSynchronizationOperation, toString
addAdditionalLogItem, addRequestControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, setErrorMessage
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, setErrorMessage
addAdditionalLogItem, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode
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(org.forgerock.services.context.Context context, CompareRequest compareRequest)
context
- The request context with which this operation is associated.compareRequest
- The compare request.public final ByteString getRawEntryDN()
CompareOperation
getRawEntryDN
in interface CompareOperation
getRawEntryDN
in interface PostOperationCompareOperation
getRawEntryDN
in interface PostResponseCompareOperation
getRawEntryDN
in interface PreOperationCompareOperation
getRawEntryDN
in interface PreParseCompareOperation
public final void setRawEntryDN(ByteString rawEntryDN)
CompareOperation
setRawEntryDN
in interface CompareOperation
setRawEntryDN
in interface PreParseCompareOperation
rawEntryDN
- The raw, unprocessed entry DN as included in the client request.public final Dn getEntryDN()
CompareOperation
getRawEntryDN
method.getEntryDN
in interface CompareOperation
getEntryDN
in interface PostOperationCompareOperation
getEntryDN
in interface PostResponseCompareOperation
getEntryDN
in interface PreOperationCompareOperation
null
if the raw entry DN has not yet been processed.public final String getRawAttributeType()
CompareOperation
getRawAttributeType
in interface CompareOperation
getRawAttributeType
in interface PostOperationCompareOperation
getRawAttributeType
in interface PostResponseCompareOperation
getRawAttributeType
in interface PreOperationCompareOperation
getRawAttributeType
in interface PreParseCompareOperation
public final void setRawAttributeType(String rawAttributeType)
CompareOperation
setRawAttributeType
in interface CompareOperation
setRawAttributeType
in interface PreParseCompareOperation
rawAttributeType
- The raw attribute type for this compare operation.public final AttributeDescription getAttributeDescription()
CompareOperation
getAttributeDescription
in interface CompareOperation
getAttributeDescription
in interface PostOperationCompareOperation
getAttributeDescription
in interface PostResponseCompareOperation
getAttributeDescription
in interface PreOperationCompareOperation
public final ByteString getAssertionValue()
CompareOperation
getAssertionValue
in interface CompareOperation
getAssertionValue
in interface PostOperationCompareOperation
getAssertionValue
in interface PostResponseCompareOperation
getAssertionValue
in interface PreOperationCompareOperation
getAssertionValue
in interface PreParseCompareOperation
public final void setAssertionValue(ByteString assertionValue)
CompareOperation
setAssertionValue
in interface CompareOperation
setAssertionValue
in interface PreOperationCompareOperation
setAssertionValue
in interface PreParseCompareOperation
assertionValue
- The assertion value for this compare operation.public final OperationType getOperationType()
Operation
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
public Dn getProxiedAuthorizationDN()
getProxiedAuthorizationDN
in interface CompareOperation
getProxiedAuthorizationDN
in interface Operation
null
if proxied authorization has not been requested.public void setProxiedAuthorizationDN(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()
Operation
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
public final void addResponseControl(Control control)
Operation
addResponseControl
in interface Operation
addResponseControl
in interface PostOperationOperation
addResponseControl
in interface PreOperationOperation
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)
Operation
removeResponseControl
in interface Operation
removeResponseControl
in interface PostOperationOperation
removeResponseControl
in interface PreOperationOperation
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()
Operation
public void updateOperationErrMsgAndResCode()
AbstractOperation
updateOperationErrMsgAndResCode
in class AbstractOperation
public final void toString(StringBuilder buffer)
Operation
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 PostOperationCompareOperation
getEntryToCompare
in interface PostResponseCompareOperation
getEntryToCompare
in interface PreOperationCompareOperation
null
if the entry is not yet available.Copyright 2010-2020 ForgeRock AS.