|
|||||||||
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.ModifyDNOperationBasis
public class ModifyDNOperationBasis
This class defines an operation that may be used to alter the DN of an entry in 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 | |
---|---|
ModifyDNOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
ByteString rawEntryDN,
ByteString rawNewRDN,
boolean deleteOldRDN,
ByteString rawNewSuperior)
Creates a new modify DN operation with the provided information. |
|
ModifyDNOperationBasis(ClientConnection clientConnection,
long operationID,
int messageID,
java.util.List<Control> requestControls,
DN entryDN,
RDN newRDN,
boolean deleteOldRDN,
DN newSuperior)
Creates a new modify DN operation with the provided information. |
Method Summary | |
---|---|
void |
addModification(Modification modification)
Adds the provided modification to the set of modifications to be applied as part of the update. |
void |
addResponseControl(Control control)
Adds the provided control to the set of controls to include in the response to the client. |
boolean |
deleteOldRDN()
Indicates whether the current RDN value should be removed from the entry. |
long |
getChangeNumber()
Retrieves the change number that has been assigned to this operation. |
DN |
getEntryDN()
Retrieves the DN of the entry to rename. |
java.util.List<Modification> |
getModifications()
Retrieves the set of modifications applied to attributes of the target entry in the course of processing this modify DN operation. |
DN |
getNewDN()
Retrieves the new DN for the entry. |
RDN |
getNewRDN()
Retrieves the new RDN to use for the entry. |
DN |
getNewSuperior()
Retrieves the newSuperior DN for the entry. |
OperationType |
getOperationType()
Retrieves the operation type for this operation. |
Entry |
getOriginalEntry()
Retrieves the current entry, before it is renamed. |
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. |
ByteString |
getRawNewRDN()
Retrieves the raw, unprocessed newRDN as included in the request from the client. |
ByteString |
getRawNewSuperior()
Retrieves the raw, unprocessed newSuperior from 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. |
Entry |
getUpdatedEntry()
Retrieves the new entry, as it will appear after it is renamed. |
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 |
setDeleteOldRDN(boolean deleteOldRDN)
Specifies whether the current RDN value should be removed from the entry. |
void |
setProxiedAuthorizationDN(DN dn)
Sets 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. |
void |
setRawNewRDN(ByteString rawNewRDN)
Specifies the raw, unprocessed newRDN as included in the request from the client. |
void |
setRawNewSuperior(ByteString rawNewSuperior)
Specifies the raw, unprocessed newSuperior for this modify DN operation, as provided in the request from the client. |
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.InProgressOperation |
---|
appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, setAdditionalLogMessage, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode |
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 |
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 |
Constructor Detail |
---|
public ModifyDNOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, ByteString rawEntryDN, ByteString rawNewRDN, boolean deleteOldRDN, ByteString rawNewSuperior)
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 included in the
client request.rawNewRDN
- The raw, unprocessed newRDN as included in the
client request.deleteOldRDN
- Indicates whether to delete the old RDN value
from the entry.rawNewSuperior
- The raw, unprocessed newSuperior as included in
the client request.public ModifyDNOperationBasis(ClientConnection clientConnection, long operationID, int messageID, java.util.List<Control> requestControls, DN entryDN, RDN newRDN, boolean deleteOldRDN, DN newSuperior)
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 current entry DN for this modify DN
operation.newRDN
- The new RDN for this modify DN operation.deleteOldRDN
- Indicates whether to delete the old RDN value
from the entry.newSuperior
- The newSuperior DN for this modify DN operation.Method Detail |
---|
public final ByteString getRawEntryDN()
getRawEntryDN
in interface ModifyDNOperation
getRawEntryDN
in interface PostResponseModifyDNOperation
getRawEntryDN
in interface PreParseModifyDNOperation
getRawEntryDN
in interface SubordinateModifyDNOperation
public final void setRawEntryDN(ByteString rawEntryDN)
setRawEntryDN
in interface ModifyDNOperation
setRawEntryDN
in interface PreParseModifyDNOperation
rawEntryDN
- The raw, unprocessed entry DN as included in the client
request.public final DN getEntryDN()
getRawEntryDN
method.
getEntryDN
in interface ModifyDNOperation
getEntryDN
in interface PostResponseModifyDNOperation
getEntryDN
in interface SubordinateModifyDNOperation
null
if the raw
entry DN has not yet been processed.public final ByteString getRawNewRDN()
getRawNewRDN
in interface ModifyDNOperation
getRawNewRDN
in interface PostResponseModifyDNOperation
getRawNewRDN
in interface PreParseModifyDNOperation
getRawNewRDN
in interface SubordinateModifyDNOperation
public final void setRawNewRDN(ByteString rawNewRDN)
setRawNewRDN
in interface ModifyDNOperation
setRawNewRDN
in interface PreParseModifyDNOperation
rawNewRDN
- The raw, unprocessed newRDN as included in the request
from the client.public final RDN getNewRDN()
getRawNewRDN
method.
getNewRDN
in interface ModifyDNOperation
getNewRDN
in interface PostResponseModifyDNOperation
getNewRDN
in interface SubordinateModifyDNOperation
null
if the raw
newRDN has not yet been processed.public final boolean deleteOldRDN()
deleteOldRDN
in interface ModifyDNOperation
deleteOldRDN
in interface PostResponseModifyDNOperation
deleteOldRDN
in interface PreParseModifyDNOperation
deleteOldRDN
in interface SubordinateModifyDNOperation
true
if the current RDN value should be removed from
the entry, or false
if not.public final void setDeleteOldRDN(boolean deleteOldRDN)
setDeleteOldRDN
in interface ModifyDNOperation
setDeleteOldRDN
in interface PreParseModifyDNOperation
deleteOldRDN
- Specifies whether the current RDN value should be
removed from the entry.public final ByteString getRawNewSuperior()
getRawNewSuperior
in interface ModifyDNOperation
getRawNewSuperior
in interface PostResponseModifyDNOperation
getRawNewSuperior
in interface PreParseModifyDNOperation
getRawNewSuperior
in interface SubordinateModifyDNOperation
null
if there is none.public final void setRawNewSuperior(ByteString rawNewSuperior)
setRawNewSuperior
in interface ModifyDNOperation
setRawNewSuperior
in interface PreParseModifyDNOperation
rawNewSuperior
- The raw, unprocessed newSuperior as provided in the
request from the client.public final DN getNewSuperior()
getRawNewSuperior
method.
getNewSuperior
in interface ModifyDNOperation
getNewSuperior
in interface PostResponseModifyDNOperation
getNewSuperior
in interface SubordinateModifyDNOperation
null
if there is
no newSuperior DN for this request or if the raw newSuperior has
not yet been processed.public final java.util.List<Modification> getModifications()
getModifications
in interface ModifyDNOperation
getModifications
in interface PostResponseModifyDNOperation
null
if that
information is not yet available (e.g., during pre-parse plugins).public final void addModification(Modification modification)
addModification
in interface ModifyDNOperation
modification
- The modification to add to the set of modifications
to apply to the entry.public final Entry getOriginalEntry()
getOriginalEntry
in interface ModifyDNOperation
getOriginalEntry
in interface PostResponseModifyDNOperation
getOriginalEntry
in interface SubordinateModifyDNOperation
null
if it is not yet
available.public final Entry getUpdatedEntry()
getUpdatedEntry
in interface ModifyDNOperation
getUpdatedEntry
in interface PostResponseModifyDNOperation
getUpdatedEntry
in interface SubordinateModifyDNOperation
null
if it is not yet
available.public final long getChangeNumber()
getChangeNumber
in interface ModifyDNOperation
public final void setChangeNumber(long changeNumber)
setChangeNumber
in interface ModifyDNOperation
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 ModifyDNOperation
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 InProgressOperation
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 InProgressOperation
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 void setProxiedAuthorizationDN(DN dn)
setProxiedAuthorizationDN
in interface ModifyDNOperation
dn
- The proxied authorization DN for this operation if proxied
authorization has been requested, or null
if proxied
authorization has not been requested.public DN getNewDN()
getNewDN
in interface ModifyDNOperation
null
if there is
neither newRDN, nor entryDN for this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |