public class

BasicControl

extends Object
implements Control
java.lang.Object
   ↳ com.sun.jndi.ldap.BasicControl
Known Direct Subclasses

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface javax.naming.ldap.Control
Fields
protected boolean criticality The control's criticality.
protected String id The control's object identifier string.
protected byte[] value The control's ASN.1 BER encoded value.
Public Constructors
BasicControl(String id)
Constructs a new instance of BasicControl.
BasicControl(String id, boolean criticality, byte[] value)
Constructs a new instance of BasicControl.
Public Methods
byte[] getEncodedValue()
Retrieves the control's ASN.1 BER encoded value.
String getID()
Retrieves the control's object identifier string.
boolean isCritical()
Determines the control's criticality.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.naming.ldap.Control

Fields

protected boolean criticality

The control's criticality.

protected String id

The control's object identifier string.

protected byte[] value

The control's ASN.1 BER encoded value.

Public Constructors

public BasicControl (String id)

Constructs a new instance of BasicControl. It is a non-critical control.

Parameters
id The control's object identifier string.

public BasicControl (String id, boolean criticality, byte[] value)

Constructs a new instance of BasicControl.

Parameters
id The control's object identifier string.
criticality The control's criticality.
value The control's ASN.1 BER encoded value. May be null.

Public Methods

public byte[] getEncodedValue ()

Retrieves the control's ASN.1 BER encoded value. The result is the raw BER bytes including the tag and length of the control's value. It does not include the control's object identifier string or criticality.

Returns
  • A possibly null byte array representing the control's ASN.1 BER encoded value.

public String getID ()

Retrieves the control's object identifier string.

Returns
  • The non-null object identifier string.

public boolean isCritical ()

Determines the control's criticality.

Returns
  • true if the control is critical; false otherwise.