Interface PreParseModifyDNOperation
-
- All Superinterfaces:
PluginOperation
,PreParseOperation
- All Known Implementing Classes:
ModifyDnOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreParseModifyDNOperation extends PreParseOperation
This class defines a set of methods that are available for use by pre-parse 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 entry DN as included in the client request.Rdn
getNewRDN()
Retrieves the newRDN as included in the request from the client.Dn
getNewSuperior()
Retrieves the newSuperior from the client request.void
setDeleteOldRDN(boolean deleteOldRDN)
Specifies whether the current RDN value should be removed from the entry.void
setEntryDN(Dn entryDN)
Specifies the entry DN as included in the client request.void
setNewRDN(Rdn newRDN)
Specifies the newRDN as included in the request from the client.void
setNewSuperior(Dn newSuperior)
Specifies the newSuperior for this modify DN operation, as provided in the request from the client.-
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.PreParseOperation
addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, removeResponseControl, setErrorMessage
-
-
-
-
Method Detail
-
getEntryDN
Dn getEntryDN()
Retrieves the entry DN as included in the client request.- Returns:
- The entry DN as included in the client request.
-
setEntryDN
void setEntryDN(Dn entryDN)
Specifies the entry DN as included in the client request. This should only be called by pre-parse plugins.- Parameters:
entryDN
- The entry DN as included in the client request.
-
getNewRDN
Rdn getNewRDN()
Retrieves the newRDN as included in the request from the client.- Returns:
- The newRDN as included in the request from the client.
-
setNewRDN
void setNewRDN(Rdn newRDN)
Specifies the newRDN as included in the request from the client. This should only be called by pre-parse plugins and should not be used in later stages of processing.- Parameters:
newRDN
- The newRDN as included in the request from the client.
-
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.
-
setDeleteOldRDN
void setDeleteOldRDN(boolean deleteOldRDN)
Specifies whether the current RDN value should be removed from the entry.- Parameters:
deleteOldRDN
- Specifies whether the current RDN value should be removed from the entry.
-
getNewSuperior
Dn getNewSuperior()
Retrieves the newSuperior from the client request.- Returns:
- The newSuperior from the client request, or
null
if there is none.
-
setNewSuperior
void setNewSuperior(Dn newSuperior)
Specifies the newSuperior for this modify DN operation, as provided in the request from the client. This method should only be called by pre-parse plugins.- Parameters:
newSuperior
- The newSuperior as provided in the request from the client.
-
-