public interface DeleteRequest extends Request
Only leaf entries (those with no subordinate entries) can be deleted with
this operation. However, addition of the SubtreeDeleteControl
permits
whole sub-trees to be deleted using a single Delete request.
Creation of Delete requests is provided by
newDeleteRequest(DN)
and
newDeleteRequest(String)
Modifier and Type | Method and Description |
---|---|
DeleteRequest |
addControl(Control control)
Adds the provided control to this request.
|
DN |
getName()
Returns the distinguished name of the entry to be deleted.
|
DeleteRequest |
setName(DN dn)
Sets the distinguished name of the entry to be deleted.
|
DeleteRequest |
setName(java.lang.String dn)
Sets the distinguished name of the entry to be deleted.
|
getControl, getControls, isInternal, removeControl
getAttachment, getAttachmentNames, removeAttachment, setAttachment
DeleteRequest 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
.DN getName()
DeleteRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the entry to be deleted.java.lang.UnsupportedOperationException
- If this delete request does not permit the distinguished name to
be set.java.lang.NullPointerException
- If dn
was null
.DeleteRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the entry to be deleted.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this delete request does not permit the distinguished name to
be set.java.lang.NullPointerException
- If dn
was null
.