| java.lang.Object | |
| ↳ | javax.naming.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 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| criticality | The control's criticality. | ||||||||||
| id | The control's object identifier string. | ||||||||||
| value | The control's ASN.1 BER encoded value. | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a non-critical control.
| |||||||||||
Constructs a control using the supplied arguments.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Retrieves the control's ASN.1 BER encoded value.
| |||||||||||
Retrieves the control's object identifier string.
| |||||||||||
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 byte[] value
The control's ASN.1 BER encoded value.
Public Constructors
public BasicControl (String id)
Constructs a non-critical control.
Parameters
| id | The control's object identifier string. |
|---|
public BasicControl (String id, boolean criticality, byte[] 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 Methods
public byte[] getEncodedValue ()
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.
Returns
- A possibly null byte array representing the control's ASN.1 BER encoded value. It is not cloned - any changes to the returned value will affect the contents of the control.
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.