org.forgerock.opendj.ldap.messages

Interface DeleteRequest

All Superinterfaces:

ChangeRecord, ProtocolOp, Request

public interface DeleteRequest
extends Request, ChangeRecord

The Delete operation allows a client to request the removal of an entry from the Directory.

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);
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.opendj.ldap.messages.Request

Request.RequestType

Method Summary

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> C	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.

Methods inherited from interface org.forgerock.opendj.ldap.messages.Request

accept, getType

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

containsControl, getControl

Method Detail

addControl

DeleteRequest addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ChangeRecord

Specified by:

addControl in interface ProtocolOp

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

DeleteRequest addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ChangeRecord

Specified by:

addControls in interface ProtocolOp

Specified by:

addControls in interface Request

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.

getControl

<C extends Control> C getControl(ControlDecoder<C> decoder,
                                 DecodeOptions options)
                          throws DecodeException

Description copied from interface: ProtocolOp

Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface ProtocolOp

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

options - The set of decode options which should be used when decoding the control.

Returns:

The decoded control, or null if the control is not included with this protocol-op.

Throws:

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).

getControls

List<Control> getControls()

Description copied from interface: ProtocolOp

Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.

Specified by:

getControls in interface ProtocolOp

Returns:

A List containing the controls.

getName

Dn getName()

Returns the distinguished name of the entry to be deleted. The server shall not dereference any aliases in locating the entry to be deleted.

Specified by:

getName in interface ChangeRecord

Returns:

The distinguished name of the entry.

setName

DeleteRequest setName(Dn dn)

Sets the distinguished name of the entry to be deleted. The server shall not dereference any aliases in locating the entry to be deleted.

Specified by:

setName in interface ChangeRecord

Parameters:

dn - The distinguished name of the entry to be deleted.

Returns:

This delete request.

Throws:

UnsupportedOperationException - If this delete request does not permit the distinguished name to be set.

NullPointerException - If dn was null.

setName

DeleteRequest setName(String dn)

Sets the distinguished name of the entry to be deleted. The server shall not dereference any aliases in locating the entry to be deleted.

Specified by:

setName in interface ChangeRecord

Parameters:

dn - The distinguished name of the entry to be deleted.

Returns:

This delete request.

Throws:

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.