|
|||||||||
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.DeleteOperationBasis
public class DeleteOperationBasis
This class defines an operation that may be used to remove an entry from the Directory Server.
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 | |
---|---|
DeleteOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
ByteString rawEntryDN)
Creates a new delete operation with the provided information. |
|
DeleteOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
DN entryDN)
Creates a new delete 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. |
long |
getChangeNumber()
Retrieves the change number that has been assigned to this operation. |
DN |
getEntryDN()
Retrieves the DN of the entry to delete. |
Entry |
getEntryToDelete()
Retrieves the entry to be deleted. |
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. |
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 |
setChangeNumber(long changeNumber)
Specifies the change number that has been assigned to this operation by the synchronization mechanism. |
void |
setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
Set the proxied authorization DN for this operation if proxied authorization has been requested. |
void |
setRawEntryDN(ByteString rawEntryDN)
Specifies the raw, unprocessed entry DN for this delete operation. |
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 DeleteOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, ByteString rawEntryDN)
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 DN of the entry to delete,
as included in the client request.public DeleteOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, DN entryDN)
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 delete operation.Method Detail |
---|
public final ByteString getRawEntryDN()
getRawEntryDN
in interface DeleteOperation
getRawEntryDN
in interface PostResponseDeleteOperation
getRawEntryDN
in interface PreParseDeleteOperation
public final void setRawEntryDN(ByteString rawEntryDN)
setRawEntryDN
in interface DeleteOperation
setRawEntryDN
in interface PreParseDeleteOperation
rawEntryDN
- The raw, unprocessed entry DN for this delete
operation.public final DN getEntryDN()
getRawEntryDN
method.
getEntryDN
in interface DeleteOperation
getEntryDN
in interface PostResponseDeleteOperation
null
if the raw
entry DN has not yet been processed.public final long getChangeNumber()
getChangeNumber
in interface DeleteOperation
public final void setChangeNumber(long changeNumber)
setChangeNumber
in interface DeleteOperation
changeNumber
- The change number that has been assigned to this
operation by the synchronization mechanism.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 DeleteOperation
null
if proxied
authorization has not been requested.public 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 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 void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
setProxiedAuthorizationDN
in interface DeleteOperation
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied
authorization has been requested, or null
if proxied
authorization has not been requested.public final void run()
run
in interface java.lang.Runnable
run
in class AbstractOperation
public Entry getEntryToDelete()
getEntryToDelete
in interface PostResponseDeleteOperation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |