org.opends.admin.ads
Class SubtreeDeleteControl

java.lang.Object
  org.opends.admin.ads.SubtreeDeleteControl

All Implemented Interfaces:

java.io.Serializable, javax.naming.ldap.Control

public class SubtreeDeleteControl
extends java.lang.Object
implements javax.naming.ldap.Control

This class implements the LDAP subtree delete control for JNDI.

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

SubtreeDeleteControl()

Method Summary

byte[]	getEncodedValue() Retrieves the ASN.1 BER encoded value of the LDAP control.
java.lang.String	getID() Retrieves the object identifier assigned for the LDAP control.
boolean	isCritical() Determines the criticality of the LDAP control.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubtreeDeleteControl

public SubtreeDeleteControl()

Method Detail

getID

public java.lang.String getID()

Retrieves the object identifier assigned for the LDAP control.

Specified by:

getID in interface javax.naming.ldap.Control

Returns:

The non-null object identifier string.

isCritical

public boolean isCritical()

Determines the criticality of the LDAP control. A critical control must not be ignored by the server. In other words, if the server receives a critical control that it does not support, regardless of whether the control makes sense for the operation, the operation will not be performed and an OperationNotSupportedException will be thrown.

Specified by:

isCritical in interface javax.naming.ldap.Control

Returns:

true if this control is critical; false otherwise.

getEncodedValue

public byte[] getEncodedValue()

Retrieves the ASN.1 BER encoded value of the LDAP control. The result is the raw BER bytes including the tag and length of the control's value. It does not include the controls OID or criticality. Null is returned if the value is absent.

Specified by:

getEncodedValue in interface javax.naming.ldap.Control

Returns:

A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.