org.opends.server.core
Interface DeleteOperation
- All Superinterfaces:
- Operation
- All Known Implementing Classes:
- DeleteOperationBasis, DeleteOperationWrapper, LocalBackendDeleteOperation
public interface DeleteOperation
- extends Operation
This interface defines an operation that may be used to remove an entry from
the Directory Server.
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. |
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, toString |
getRawEntryDN
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.
- Returns:
- The raw, unprocessed entry DN as included in the client request.
setRawEntryDN
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.
- Parameters:
rawEntryDN
- The raw, unprocessed entry DN as included in the client
request.
getEntryDN
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.
- Returns:
- The DN of the entry to delete, or
null
if the raw
entry DN has not yet been processed.
getChangeNumber
long getChangeNumber()
- Retrieves the change number that has been assigned to this operation.
- 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
void setChangeNumber(long changeNumber)
- Specifies the change number that has been assigned to this operation by the
synchronization mechanism.
- Parameters:
changeNumber
- The change number that has been assigned to this
operation by the synchronization mechanism.
getProxiedAuthorizationDN
DN getProxiedAuthorizationDN()
- Retrieves the proxied authorization DN for this operation if proxied
authorization has been requested.
- Returns:
- The proxied authorization DN for this operation if proxied
authorization has been requested, or
null
if proxied
authorization has not been requested.
setProxiedAuthorizationDN
void setProxiedAuthorizationDN(DN proxiedAuthorizationDN)
- Set the proxied authorization DN for this operation if proxied
authorization has been requested.
- Parameters:
proxiedAuthorizationDN
- The proxied authorization DN for this operation if proxied
authorization has been requested, or null
if proxied
authorization has not been requested.