public interface DeleteRequest extends Request, ChangeRecord
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.
Connection connection = ...; String baseDN = ...; DeleteRequest request = Requests.newDeleteRequest(baseDN) .addControl(SubtreeDeleteRequestControl.newControl(true)); connection.delete(request);
Request.RequestType
Modifier and Type | Method and Description |
---|---|
DeleteRequest |
addControl(Control control)
Adds the provided control to this protocol-op.
|
DeleteRequest |
addControls(Iterable<? extends Control> controls)
Adds the provided controls to this protocol-op.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this protocol-op having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
protocol-op. |
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(String dn)
Sets the distinguished name of the entry to be deleted.
|
containsControl, getControl
DeleteRequest addControl(Control control)
ProtocolOp
addControl
in interface ChangeRecord
addControl
in interface ProtocolOp
addControl
in interface Request
control
- The control to be added to this protocol-op.DeleteRequest addControls(Iterable<? extends Control> controls)
ProtocolOp
addControls
in interface ChangeRecord
addControls
in interface ProtocolOp
addControls
in interface Request
controls
- The controls to be added to this protocol-op.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
ProtocolOp
getControl
in interface ProtocolOp
C
- The type of control to be decoded and returned.decoder
- The control decoder.options
- The set of decode options which should be used when decoding
the control.null
if the control is not
included with this protocol-op.DecodeException
- If the control could not be decoded because it was malformed in some way
(e.g. the control value was missing, or its content could not be decoded).List<Control> getControls()
ProtocolOp
List
containing the controls included with this
protocol-op. The returned List
may be modified if permitted by this
protocol-op.getControls
in interface ProtocolOp
List
containing the controls.Dn getName()
getName
in interface ChangeRecord
DeleteRequest setName(Dn dn)
setName
in interface ChangeRecord
dn
- The distinguished name of the entry to be deleted.UnsupportedOperationException
- If this delete request does not permit the distinguished name
to be set.NullPointerException
- If dn
was null
.DeleteRequest setName(String dn)
setName
in interface ChangeRecord
dn
- The distinguished name of the entry to be deleted.LocalizedIllegalArgumentException
- If dn
could not be decoded using the default schema.UnsupportedOperationException
- If this delete request does not permit the distinguished name
to be set.NullPointerException
- If dn
was null
.Copyright 2010-2022 ForgeRock AS.