public interface ModifyRequest extends Request
Creation of Modify requests is provided by
newModifyRequest(DN)
and
newModifyRequest(String)
Modifier and Type | Method and Description |
---|---|
ModifyRequest |
addControl(Control control)
Adds the provided control to this request.
|
ModifyRequest |
addModification(Modification modification)
Appends the provided modification to the list of modifications included
with this modify request.
|
ModifyRequest |
addModification(ModificationType type,
java.lang.String attributeDescription,
java.lang.Object... values)
Appends the provided modification to the list of modifications included
with this modify request.
|
java.util.List<Modification> |
getModifications()
Returns a
List containing the modifications included with this
modify request. |
DN |
getName()
Returns the distinguished name of the entry to be modified.
|
ModifyRequest |
setName(DN dn)
Sets the distinguished name of the entry to be modified.
|
ModifyRequest |
setName(java.lang.String dn)
Sets the distinguished name of the entry to be modified.
|
getControl, getControls, isInternal, removeControl
getAttachment, getAttachmentNames, removeAttachment, setAttachment
ModifyRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
addControl
in interface Request
control
- The control to be added to this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be added.java.lang.NullPointerException
- If control
was null
.ModifyRequest addModification(Modification modification) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
modification
- The modification to be performed.java.lang.UnsupportedOperationException
- If this modify request does not permit modifications to be added.java.lang.NullPointerException
- If modification
was null
.ModifyRequest addModification(ModificationType type, java.lang.String attributeDescription, java.lang.Object... values) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
If the attribute value is not an instance of ByteString
then it
will be converted using the ByteString.valueOf(Object)
method.
type
- The type of modification to be performed.attributeDescription
- The name of the attribute to be modified.values
- The attribute values to be modified.PluginException
- If attributeDescription
could not be decoded.java.lang.UnsupportedOperationException
- If this modify request does not permit modifications to be added.java.lang.NullPointerException
- If type
, attributeDescription
, or value
was null
.java.util.List<Modification> getModifications()
List
containing the modifications included with this
modify request. The returned List
may be modified if permitted by
this modify request.List
containing the modifications.DN getName()
ModifyRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The the distinguished name of the entry to be modified.java.lang.UnsupportedOperationException
- If this modify request does not permit the distinguished name to
be set.java.lang.NullPointerException
- If dn
was null
.ModifyRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The the distinguished name of the entry to be modified.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this modify request does not permit the distinguished name to
be set.java.lang.NullPointerException
- If dn
was null
.