Interface PreParseModifyOperation
- All Superinterfaces:
PluginOperation,PreParseOperation
- All Known Implementing Classes:
ModifyOperation
This class defines a set of methods that are available for use by pre-parse plugins for modify 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
Modifier and TypeMethodDescriptionvoidaddModification(Modification modification) Adds the provided modification to the set of modifications for this modify operation.Retrieves the entry DN as included in the client request.Retrieves the set of modifications as included in the client request.voidsetEntryDN(Dn entryDN) Specifies the entry DN as included in the client request.voidsetModifications(List<Modification> modifications) Specifies the set of modifications for this modify operation.Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getRequest, getRequestControl, getRequestControl, getRequestControls, getResponseControls, hasPrivilege, isInternalOperation, isSynchronizationOperation, setAttachment, toString, toStringMethods inherited from interface org.opends.server.types.operation.PreParseOperation
addAdditionalLogItem, addRequestControl, addResponseControl, appendErrorMessage, getAdditionalLogItems, getErrorMessage, removeResponseControl, sendResponses, setErrorMessage
-
Method Details
-
getEntryDN
Dn getEntryDN()Retrieves the entry DN as included in the client request.- Returns:
- The entry DN as included in the client request.
-
setEntryDN
Specifies the entry DN as included in the client request.- Parameters:
entryDN- The entry DN as included in the client request.
-
getModifications
List<Modification> getModifications()Retrieves the set of modifications as included in the client request. The list returned must not be altered by the caller.- Returns:
- The set of modifications as included in the client request.
-
addModification
Adds the provided modification to the set of modifications for this modify operation.- Parameters:
modification- The modification to add to the set of modifications for this modify operation.- Throws:
LdapException- If an unexpected problem occurs while applying the modification to the entry.
-
setModifications
Specifies the set of modifications for this modify operation.- Parameters:
modifications- The modifications for this modify operation.
-