BasicControl (Java SE 11 & JDK 11 ) (original) (raw)

• java.lang.Object

• • javax.naming.ldap.BasicControl

• All Implemented Interfaces:
  [Serializable](../../../../java.base/java/io/Serializable.html "interface in java.io"), [Control](Control.html "interface in javax.naming.ldap")
  Direct Known Subclasses:
  [ManageReferralControl](ManageReferralControl.html "class in javax.naming.ldap"), [PagedResultsControl](PagedResultsControl.html "class in javax.naming.ldap"), [PagedResultsResponseControl](PagedResultsResponseControl.html "class in javax.naming.ldap"), [SortControl](SortControl.html "class in javax.naming.ldap"), [SortResponseControl](SortResponseControl.html "class in javax.naming.ldap")

public class BasicControl
extends Object
implements Control
This class provides a basic implementation of the Control interface. It represents an LDAPv3 Control as defined inRFC 2251.
Since:
1.5
See Also:
Serialized Form

• • Field Summary

  Fields

  Modifier and Type	Field	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 declared in interface javax.naming.ldap.[Control](Control.html "interface in javax.naming.ldap")  
     `[CRITICAL](Control.html#CRITICAL), [NONCRITICAL](Control.html#NONCRITICAL)`  

  • Constructor Summary

  Constructors

  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 Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	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.

     * ### Methods declared in class java.lang.[Object](../../../../java.base/java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long,int%29)`

• • Field Detail

     * #### id  
     protected [String](../../../../java.base/java/lang/String.html "class in java.lang") 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](../../../../java.base/java/lang/String.html "class in java.lang") id)  
    Constructs a non-critical control.  
    Parameters:  
    `id` \- The control's object identifier string.  
    * #### BasicControl  
    public BasicControl​([String](../../../../java.base/java/lang/String.html "class in java.lang") 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](../../../../java.base/java/lang/String.html "class in java.lang") getID()  
    Retrieves the control's object identifier string.  
    Specified by:  
    `[getID](Control.html#getID%28%29)` in interface `[Control](Control.html "interface in javax.naming.ldap")`  
    Returns:  
    The non-null object identifier string.  
    * #### isCritical  
    public boolean isCritical()  
    Determines the control's criticality.  
    Specified by:  
    `[isCritical](Control.html#isCritical%28%29)` in interface `[Control](Control.html "interface in javax.naming.ldap")`  
    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](Control.html#getEncodedValue%28%29)` in interface `[Control](Control.html "interface in javax.naming.ldap")`  
    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.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.