Interface PreParseModifyOperation
-
- All Superinterfaces:
PluginOperation
,PreParseOperation
- All Known Implementing Classes:
ModifyOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PreParseModifyOperation extends PreParseOperation
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addModification(Modification modification)
Adds the provided modification to the set of modifications for this modify operation.Dn
getEntryDN()
Retrieves the entry DN as included in the client request.List<Modification>
getModifications()
Retrieves the set of modifications as included in the client request.void
setEntryDN(Dn entryDN)
Specifies the entry DN as included in the client request.void
setModifications(List<Modification> modifications)
Specifies the set of modifications for this modify operation.-
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.- 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
void addModification(Modification modification) throws LdapException
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
void setModifications(List<Modification> modifications)
Specifies the set of modifications for this modify operation.- Parameters:
modifications
- The modifications for this modify operation.
-
-