|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.AbstractOperation
org.opends.server.core.CompareOperationBasis
public class CompareOperationBasis
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, useNanoTime |
Fields inherited from interface org.opends.server.types.Operation |
---|
LOCALBACKENDOPERATIONS |
Constructor Summary | |
---|---|
CompareOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
ByteString rawEntryDN,
java.lang.String rawAttributeType,
ByteString assertionValue)
Creates a new compare operation with the provided information. |
|
CompareOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
DN entryDN,
AttributeType attributeType,
ByteString assertionValue)
Creates a new compare operation with the provided information. |
Method Summary | |
---|---|
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. |
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. |
java.lang.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. |
java.lang.String[][] |
getRequestLogElements()
Retrieves a standard set of elements that should be logged in requests for this type of operation. |
java.util.List<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the client. |
java.lang.String[][] |
getResponseLogElements()
Retrieves a standard set of elements that should be logged in responses for this type of operation. |
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 |
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(java.lang.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(java.lang.StringBuilder buffer)
Appends a string representation of this operation to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opends.server.types.operation.PreParseOperation |
---|
addRequestControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, setAdditionalLogMessage, setErrorMessage |
Methods inherited from interface org.opends.server.types.operation.PostResponseOperation |
---|
getAdditionalLogMessage, 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, getRequestControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString |
Constructor Detail |
---|
public CompareOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, ByteString rawEntryDN, java.lang.String rawAttributeType, 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, java.util.List<Control> requestControls, DN entryDN, AttributeType attributeType, 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.Method Detail |
---|
public final ByteString getRawEntryDN()
getRawEntryDN
in interface CompareOperation
getRawEntryDN
in interface PostResponseCompareOperation
getRawEntryDN
in interface PreParseCompareOperation
public final void setRawEntryDN(ByteString rawEntryDN)
setRawEntryDN
in interface CompareOperation
setRawEntryDN
in interface PreParseCompareOperation
rawEntryDN
- The raw entry DN for this compare operation.public final DN getEntryDN()
getRawEntryDN
method.
getEntryDN
in interface CompareOperation
getEntryDN
in interface PostResponseCompareOperation
null
if the raw
entry DN has not yet been processed.public final java.lang.String getRawAttributeType()
getRawAttributeType
in interface CompareOperation
getRawAttributeType
in interface PostResponseCompareOperation
getRawAttributeType
in interface PreParseCompareOperation
public final void setRawAttributeType(java.lang.String rawAttributeType)
setRawAttributeType
in interface CompareOperation
setRawAttributeType
in interface PreParseCompareOperation
rawAttributeType
- The raw attribute type for this compare
operation.public final AttributeType getAttributeType()
getAttributeType
in interface CompareOperation
getAttributeType
in interface PostResponseCompareOperation
public void setAttributeType(AttributeType attributeType)
setAttributeType
in interface CompareOperation
attributeType
- The attribute type for this compare operation.public final ByteString getAssertionValue()
getAssertionValue
in interface CompareOperation
getAssertionValue
in interface PostResponseCompareOperation
getAssertionValue
in interface PreParseCompareOperation
public final void setAssertionValue(ByteString assertionValue)
setAssertionValue
in interface CompareOperation
setAssertionValue
in interface PreParseCompareOperation
assertionValue
- The assertion value for this compare
operation.public final OperationType getOperationType()
getOperationType
in interface Operation
getOperationType
in interface PluginOperation
getOperationType
in class AbstractOperation
public final java.lang.String[][] getRequestLogElements()
null
if there is no value for that
field.
getRequestLogElements
in interface Operation
getRequestLogElements
in class AbstractOperation
public final java.lang.String[][] getResponseLogElements()
null
if there is no value for that
field.
getResponseLogElements
in interface Operation
getResponseLogElements
in class AbstractOperation
public DN getProxiedAuthorizationDN()
getProxiedAuthorizationDN
in interface CompareOperation
null
if proxied
authorization has not been requested.public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN
in interface CompareOperation
proxiedAuthorizationDN
- The proxied authorization target DN for
this compare operationpublic final java.util.List<Control> getResponseControls()
getResponseControls
in interface Operation
getResponseControls
in interface PluginOperation
getResponseControls
in class AbstractOperation
public final void addResponseControl(Control control)
addResponseControl
in interface Operation
addResponseControl
in interface PreParseOperation
addResponseControl
in class AbstractOperation
control
- 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 Operation
removeResponseControl
in interface PreParseOperation
removeResponseControl
in class AbstractOperation
control
- The control to remove from the set of controls
to include in the response to the client.public final void run()
run
in interface java.lang.Runnable
run
in class AbstractOperation
public final void toString(java.lang.StringBuilder buffer)
toString
in interface Operation
toString
in interface PluginOperation
toString
in class AbstractOperation
buffer
- The buffer into which a string representation of
this operation should be appended.public Entry getEntryToCompare()
getEntryToCompare
in interface PostResponseCompareOperation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |