org.opends.server.core
Class DeleteOperationWrapper
java.lang.Object
org.opends.server.core.OperationWrapper
org.opends.server.core.DeleteOperationWrapper
- All Implemented Interfaces:
- DeleteOperation, Operation
- Direct Known Subclasses:
- LocalBackendDeleteOperation
public abstract class DeleteOperationWrapper
- extends OperationWrapper
- implements DeleteOperation
This abstract class wraps/decorates a given delete operation.
This class will be extended by sub-classes to enhance the
functionnality of the DeleteOperationBasis.
Method Summary |
long |
getChangeNumber()
Retrieves the change number that has been assigned to this operation. |
DN |
getEntryDN()
Retrieves the DN of the entry to delete. |
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. |
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 as included in the client request. |
java.lang.String |
toString()
Retrieves a string representation of this operation. |
Methods inherited from class org.opends.server.core.OperationWrapper |
abort, addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogMessage, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getCommonLogElements, getConnectionID, getErrorMessage, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControls, getRequestLogElements, getResponseControls, getResponseLogElements, getResultCode, isInternalOperation, isSynchronizationOperation, operationCompleted, removeAttachment, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInternalOperation, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString |
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 |
abort, addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, cancel, checkIfCanceled, disconnectClient, dontSynchronize, getAdditionalLogMessage, getAttachment, getAttachments, getAuthorizationDN, getAuthorizationEntry, getCancelRequest, getCancelResult, getClientConnection, getCommonLogElements, getConnectionID, getErrorMessage, getMatchedDN, getMessageID, getOperationID, getOperationType, getProcessingNanoTime, getProcessingStartTime, getProcessingStopTime, getProcessingTime, getReferralURLs, getRequestControls, getRequestLogElements, getResponseControls, getResponseLogElements, getResultCode, isInternalOperation, isSynchronizationOperation, operationCompleted, removeAttachment, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setAttachment, setAttachments, setAuthorizationEntry, setDontSynchronize, setErrorMessage, setInternalOperation, setMatchedDN, setReferralURLs, setResponseData, setResultCode, setSynchronizationOperation, toString |
DeleteOperationWrapper
public DeleteOperationWrapper(DeleteOperation delete)
- Creates a new delete operation based on the provided delete operation.
- Parameters:
delete
- The delete operation to wrap
getEntryDN
public DN getEntryDN()
- Retrieves the DN of the entry to delete. This should not be called by
pre-parse plugins because the processed DN will not be available yet.
Instead, they should call the
getRawEntryDN
method.
- Specified by:
getEntryDN
in interface DeleteOperation
- Returns:
- The DN of the entry to delete, or
null
if the raw
entry DN has not yet been processed.
getRawEntryDN
public ByteString getRawEntryDN()
- Retrieves the raw, unprocessed entry DN as included in the client request.
The DN that is returned may or may not be a valid DN, since no validation
will have been performed upon it.
- Specified by:
getRawEntryDN
in interface DeleteOperation
- Returns:
- The raw, unprocessed entry DN as included in the client request.
setRawEntryDN
public void setRawEntryDN(ByteString rawEntryDN)
- Specifies the raw, unprocessed entry DN as included in the client request.
This should only be called by pre-parse plugins. All other code that needs
to set the entry DN should use the
setEntryDN
method.
- Specified by:
setRawEntryDN
in interface DeleteOperation
- Parameters:
rawEntryDN
- The raw, unprocessed entry DN as included in the client
request.
getChangeNumber
public final long getChangeNumber()
- Retrieves the change number that has been assigned to this operation.
- Specified by:
getChangeNumber
in interface DeleteOperation
- Returns:
- The change number that has been assigned to this operation, or -1
if none has been assigned yet or if there is no applicable
synchronization mechanism in place that uses change numbers.
setChangeNumber
public final void setChangeNumber(long changeNumber)
- Specifies the change number that has been assigned to this operation by the
synchronization mechanism.
- Specified by:
setChangeNumber
in interface DeleteOperation
- Parameters:
changeNumber
- The change number that has been assigned to this
operation by the synchronization mechanism.
toString
public java.lang.String toString()
- Retrieves a string representation of this operation.
- Specified by:
toString
in interface Operation
- Overrides:
toString
in class java.lang.Object
- Returns:
- A string representation of this operation.
getProxiedAuthorizationDN
public DN getProxiedAuthorizationDN()
- Retrieves the proxied authorization DN for this operation if proxied
authorization has been requested.
- Specified by:
getProxiedAuthorizationDN
in interface DeleteOperation
- Returns:
- The proxied authorization DN for this operation if proxied
authorization has been requested, or
null
if proxied
authorization has not been requested.
setProxiedAuthorizationDN
public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
- Set the proxied authorization DN for this operation if proxied
authorization has been requested.
- Specified by:
setProxiedAuthorizationDN
in interface DeleteOperation
- Parameters:
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied
authorization has been requested, or null
if proxied
authorization has not been requested.