- 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 theControlinterface. It represents an LDAPv3 Control as defined in RFC 2251.- Since:
- 1.5
- See Also:
- Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected booleancriticalityThe control's criticality.protected StringidThe control's object identifier string.protected byte[]valueThe control's ASN.1 BER encoded value.- 
Fields declared in interface javax.naming.ldap.ControlCRITICAL, NONCRITICAL
 
- 
 - 
Constructor SummaryConstructors Constructor Description BasicControl(String id)Constructs a non-critical control.BasicControl(String id, boolean criticality, byte[] value)Constructs a control using the supplied arguments.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]getEncodedValue()Retrieves the control's ASN.1 BER encoded value.StringgetID()Retrieves the control's object identifier string.booleanisCritical()Determines the control's criticality.
 
- 
- 
- 
Field Detail- 
idprotected String id The control's object identifier string.
 - 
criticalityprotected boolean criticality The control's criticality.
 - 
valueprotected byte[] value The control's ASN.1 BER encoded value.
 
- 
 - 
Constructor Detail- 
BasicControlpublic BasicControl(String id) Constructs a non-critical control.- Parameters:
- id- The control's object identifier string.
 
 - 
BasicControlpublic 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- 
getIDpublic String getID() Retrieves the control's object identifier string.
 - 
isCriticalpublic boolean isCritical() Determines the control's criticality.- Specified by:
- isCriticalin interface- Control
- Returns:
- true if the control is critical; false otherwise.
 
 - 
getEncodedValuepublic 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:
- getEncodedValuein interface- Control
- 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.
 
 
- 
 
-