org.forgerock.opendj.ldap.controls

Class SubtreeDeleteRequestControl

java.lang.Object

org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl

All Implemented Interfaces:

Control

public final class SubtreeDeleteRequestControl
extends Object
implements Control

The tree delete request control as defined in draft-armijo-ldap-treedelete. This control allows a client to delete an entire subtree of a container entry in a single delete operation.

 Connection connection = ...;
 String baseDN = ...;

 DeleteRequest request =
         Requests.newDeleteRequest(baseDN)
             .addControl(SubtreeDeleteRequestControl.newControl(true));
 connection.delete(request);
 

See Also:

draft-armijo-ldap-treedelete - Tree Delete Control

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<SubtreeDeleteRequestControl>	DECODER A decoder which can be used for decoding the sub-tree delete request control.
static String	OID The OID for the subtree delete request control.

Method Summary

Modifier and Type	Method and Description
String	getOid() Returns the numeric OID associated with this control.
ByteString	getValue() Returns the value, if any, associated with this control.
boolean	hasValue() Returns true if this control has a value.
boolean	isCritical() Returns true if it is unacceptable to perform the operation without applying the semantics of this control.
static SubtreeDeleteRequestControl	newControl(boolean isCritical) Creates a new tree delete request control having the provided criticality.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OID

public static final String OID

The OID for the subtree delete request control.

See Also:

Constant Field Values

DECODER

public static final ControlDecoder<SubtreeDeleteRequestControl> DECODER

A decoder which can be used for decoding the sub-tree delete request control.

Method Detail

newControl

public static SubtreeDeleteRequestControl newControl(boolean isCritical)

Creates a new tree delete request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

The new control.

getOid

public String getOid()

Description copied from interface: Control

Returns the numeric OID associated with this control.

Specified by:

getOid in interface Control

Returns:

The numeric OID associated with this control.

getValue

public ByteString getValue()

Description copied from interface: Control

Returns the value, if any, associated with this control. Its format is defined by the specification of this control.

Specified by:

getValue in interface Control

Returns:

The value associated with this control, or null if there is no value.

hasValue

public boolean hasValue()

Description copied from interface: Control

Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface Control

Returns:

true if this control has a value, or false if there is no value.

isCritical

public boolean isCritical()

Description copied from interface: Control

Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

Specified by:

isCritical in interface Control

Returns:

true if this control must be processed by the Directory Server, or false if it can be ignored.

toString

public String toString()

Overrides:

toString in class Object