- java.lang.Object
-
- javax.naming.ldap.BasicControl
-
- All Implemented Interfaces:
- Serializable, Control
- Direct Known Subclasses:
- ManageReferralControl, PagedResultsControl, PagedResultsResponseControl, SortControl, SortResponseControl
public class BasicControl extends Object implements Control
This class provides a basic implementation of the Control interface. It represents an LDAPv3 Control as defined in RFC 2251.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description 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.-
Fields inherited from interface javax.naming.ldap.Control
CRITICAL, NONCRITICAL
-
-
Constructor Summary
Constructors Constructor and Description BasicControl(String id)
Constructs a non-critical control.BasicControl(String id, boolean criticality, byte[] value)
Constructs a control using the supplied arguments.
-
Method Summary
Methods Modifier and Type Method and Description 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.
-
-
-
Field Detail
-
id
protected String id
The control's object identifier string.
-
criticality
protected boolean criticality
The control's criticality.
-
value
protected byte[] value
The control's ASN.1 BER encoded value.
-
-
Constructor Detail
-
BasicControl
public BasicControl(String id)
Constructs a non-critical control.- Parameters:
id
- The control's object identifier string.
-
BasicControl
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.
-
-
Method Detail
-
getID
public String getID()
Retrieves the control's object identifier string.
-
isCritical
public boolean isCritical()
Determines the control's criticality.- Specified by:
isCritical
in interfaceControl
- Returns:
- true if the control is critical; false otherwise.
-
getEncodedValue
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.- Specified by:
getEncodedValue
in interfaceControl
- 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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/naming/ldap/BasicControl.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.