Interface SubordinateModifyDNOperation
-
- All Superinterfaces:
InProgressOperation
,PluginOperation
- All Known Implementing Classes:
ModifyDnOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface SubordinateModifyDNOperation extends InProgressOperation
This class defines a set of methods that are available for use by subordinate modify DN operation plugins. 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.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.InProgressOperation
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode
-
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
-
-
-
-
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.
-
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.
-
-