Interface PostOperationModifyDNOperation
-
- All Superinterfaces:
PluginOperation
,PostOperationOperation
- All Known Implementing Classes:
ModifyDnOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PostOperationModifyDNOperation extends PostOperationOperation
This class defines a set of methods that are available for use by post-operation plugins for modify DN operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
deleteOldRDN()
Indicates whether the current RDN value should be removed from the entry.Dn
getEntryDN()
Retrieves the DN of the entry to rename.List<Modification>
getModifications()
Retrieves the set of modifications applied to attributes of the target entry in the course of processing this modify DN operation.Rdn
getNewRDN()
Retrieves the new RDN to use for the entry.Dn
getNewSuperior()
Retrieves the newSuperior DN for the entry.Entry
getOriginalEntry()
Retrieves the current entry, before it is renamed.Entry
getUpdatedEntry()
Retrieves the new entry, as it will appear after it is renamed.-
Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getRequestControl, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
-
Methods inherited from interface org.opends.server.types.operation.PostOperationOperation
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode
-
-
-
-
Method Detail
-
getEntryDN
Dn getEntryDN()
Retrieves the DN of the entry to rename.- Returns:
- The DN of the entry to rename.
-
getNewRDN
Rdn getNewRDN()
Retrieves the new RDN to use for the entry.- Returns:
- The new RDN to use for the entry.
-
deleteOldRDN
boolean deleteOldRDN()
Indicates whether the current RDN value should be removed from the entry.- Returns:
true
if the current RDN value should be removed from the entry, orfalse
if not.
-
getNewSuperior
Dn getNewSuperior()
Retrieves the newSuperior DN for the entry.- Returns:
- The newSuperior DN for the entry, or
null
if there is no newSuperior DN for this request.
-
getModifications
List<Modification> getModifications()
Retrieves the set of modifications applied to attributes of the target entry in the course of processing this modify DN operation. This will include attribute-level changes from the modify DN itself (e.g., removing old RDN values if deleteOldRDN is set, or adding new RDN values that don't already exist), but it may also be used by pre-operation plugins to cause additional changes in the entry. In this case, those plugins may add modifications to this list through theaddModification
method (the list returned from this method should not be modified directly) if any changes should be processed in addition to the core modify DN processing. Backends may read this list to identify which attribute-level changes were applied in order to more easily apply updates to attribute indexes.- Returns:
- The set of modifications applied to attributes during the course of the modify DN processing, or
null
if that information is not yet available (e.g., during pre-parse plugins).
-
getOriginalEntry
Entry getOriginalEntry()
Retrieves the current entry, before it is renamed. This will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.- Returns:
- The current entry, or
null
if it is not yet available.
-
getUpdatedEntry
Entry getUpdatedEntry()
Retrieves the new entry, as it will appear after it is renamed. This will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.- Returns:
- The updated entry, or
null
if it is not yet available.
-
-