This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.naming.ldap
class BasicControl

java.lang.Object extended by javax.naming.ldap.BasicControl
All Implemented Interfaces:
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.

Field Summary
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.
 
Constructor Summary
BasicControl(String id)

          Constructs a non-critical control.
BasicControl(String id, boolean criticality, byte[] value)

          Constructs a control using the supplied arguments.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

criticality

protected boolean criticality
The control's criticality.

id

protected String id
The control's object identifier string.

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

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.

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.

getID

public String getID()
Retrieves the control's object identifier string.

Returns:
The non-null object identifier string.

isCritical

public boolean isCritical()
Determines the control's criticality.

Returns:
true if the control is critical; false otherwise.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.