Control Interface Reference

Inherits java::io::Serializable.

Inherited by BasicControl.

List of all members.

---

Detailed Description

A Control corresponds to a control used in LDAPv3.

Controls are specified in RFC2251. A control provides extra information related to an operation on the server. It may be a request control which is sent when a request is made to the LDAPv3 server or it may be a response control which is received from the LDAPv3 server.

Public Member Functions
String	getID ()
	Returns the object ID assigned to this Control instance.
boolean	isCritical ()
	Indicates whether this Control instance is critical.
byte[]	getEncodedValue ()
	Returns the value of this Control instance encoded using ASN.1 Basic Encoding Rules (BER).
Static Public Attributes
static final boolean	CRITICAL = true
	The constant indicating that a Control is critical.
static final boolean	NONCRITICAL = false
	The constant indicating that a Control is not critical.

---

Member Function Documentation

String getID

(

)

Returns the object ID assigned to this Control instance.

(see RFC2251).

Returns:

the object ID assigned to the control

Implemented in BasicControl.

boolean isCritical

(

)

Indicates whether this Control instance is critical.

Returns:

true if critical, otherwise false

Implemented in BasicControl.

byte [] getEncodedValue

(

)

Returns the value of this Control instance encoded using ASN.1 Basic Encoding Rules (BER).

Returns:

the encoded value of this Control instance

Implemented in BasicControl.

---

Member Data Documentation

final boolean CRITICAL = true [static]

The constant indicating that a Control is critical.

final boolean NONCRITICAL = false [static]

The constant indicating that a Control is not critical.