javax.naming.ldap: public class: BasicControl

javax.naming.ldap
public class: BasicControl [javadoc | source]

java.lang.Object
   javax.naming.ldap.BasicControl

All Implemented Interfaces:
Control

Direct Known Subclasses:
PagedResultsControl, ManageReferralControl, SortControl, SortResponseControl, PagedResultsResponseControl

This class provides a basic implementation of the Control interface. It represents an LDAPv3 Control as defined in RFC 2251.

since: 1.5 -

author: Vincent - Ryan

Field Summary
protected String	id	The control's object identifier string. serial:
protected boolean	criticality	The control's criticality. serial:
protected byte[]	value	The control's ASN.1 BER encoded value. serial:

Constructor:

Constructor:
public BasicControl(String id) { this.id = id; } Constructs a non-critical control. Parameters: `id` - The control's object identifier string.
public BasicControl(String id, boolean criticality, byte[] value) { this.id = id; this.criticality = criticality; this.value = value; } Constructs a control using the supplied arguments. Parameters: `id` - The control's object identifier string. `criticality` - The control's criticality. `value` - The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control. It may be null.

 public BasicControl(String id) {
                           
        this.id = id;
}

Constructs a non-critical control.

Parameters:

id - The control's object identifier string.

 public BasicControl(String id,
    boolean criticality,
    byte[] value) {
        this.id = id;
        this.criticality = criticality;
        this.value = value;
}

Constructs a control using the supplied arguments.

Parameters:

id - The control's object identifier string.

criticality - The control's criticality.

value - The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control. It may be null.

Method from javax.naming.ldap.BasicControl Summary:
getEncodedValue, getID, isCritical

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.naming.ldap.BasicControl Detail:
public byte[] getEncodedValue() { return value; } Retrieves the control's ASN.1 BER encoded value. The result includes the BER tag and length for the control's value but does not include the control's object identifier and criticality setting.
public String getID() { return id; } Retrieves the control's object identifier string.
public boolean isCritical() { return criticality; } Determines the control's criticality.

Method from javax.naming.ldap.BasicControl Detail:

 public byte[] getEncodedValue() {
        return value;
}

Retrieves the control's ASN.1 BER encoded value. The result includes the BER tag and length for the control's value but does not include the control's object identifier and criticality setting.

 public String getID() {
        return id;
}

Retrieves the control's object identifier string.

 public boolean isCritical() {
        return criticality;
}

Determines the control's criticality.