Package org.forgerock.opendj.ldap.controls

Class GenericControl

java.lang.Object
org.forgerock.opendj.ldap.controls.GenericControl
All Implemented Interfaces:
Control
public final class GenericControl extends Object implements Control
A generic control which can be used to represent arbitrary raw request and response controls.

  • Method Details

    • newControl

      public static GenericControl newControl(Control control)
      Creates a new control having the same OID, criticality, and value as the provided control.
      Parameters:
      control - The control to be copied.
      Returns:
      The new control.
      Throws:
      NullPointerException - If control was null.

    • newControl

      public static GenericControl newControl(String oid)
      Creates a new non-critical control having the provided OID and no value.
      Parameters:
      oid - The numeric OID associated with this control.
      Returns:
      The new control.
      Throws:
      NullPointerException - If oid was null.

    • newControl

      public static GenericControl newControl(String oid, boolean isCritical)
      Creates a new control having the provided OID and criticality, but no value.
      Parameters:
      oid - The numeric OID associated with this control.
      isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.
      Returns:
      The new control.
      Throws:
      NullPointerException - If oid was null.

    • newControl

      public static GenericControl newControl(String oid, boolean isCritical, Object value)
      Creates a new control having the provided OID, criticality, and value.

      If value is not an instance of ByteString then it will be converted using the ByteString.valueOfObject(Object) method.

      Parameters:
      oid - The numeric OID associated with this control.
      isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.
      value - The value associated with this control, or null if there is no value. Its format is defined by the specification of this control.
      Returns:
      The new control.
      Throws:
      NullPointerException - If oid was null.

    • newControl

      public static GenericControl newControl(String oid, boolean isCritical, Object value, String alias)
      Creates a new control having the provided OID, criticality, and value.

      If value is not an instance of ByteString then it will be converted using the ByteString.valueOfObject(Object) method.

      Parameters:
      oid - The numeric OID associated with this control.
      isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.
      value - The value associated with this control, or null if there is no value. Its format is defined by the specification of this control.
      alias - The user-friendly name associated with this control.
      Returns:
      The new control.
      Throws:
      NullPointerException - If oid was null.

    • getOid

      public String getOid()
      Description copied from interface: Control
      Returns the numeric OID associated with this control.
      Specified by:
      getOid in interface Control
      Returns:
      The numeric OID associated with this control.

    • getValue

      public ByteString getValue()
      Description copied from interface: Control
      Returns the value, if any, associated with this control. Its format is defined by the specification of this control.
      Specified by:
      getValue in interface Control
      Returns:
      The value associated with this control, or null if there is no value.

    • hasValue

      public boolean hasValue()
      Description copied from interface: Control
      Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.
      Specified by:
      hasValue in interface Control
      Returns:
      true if this control has a value, or false if there is no value.

    • isCritical

      public boolean isCritical()
      Description copied from interface: Control
      Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

      The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

      Specified by:
      isCritical in interface Control
      Returns:
      true if this control must be processed by the Directory Server, or false if it can be ignored.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getAlias

      public String getAlias()
      Description copied from interface: Control
      Returns the control "friendly name" alias for the control.
      Specified by:
      getAlias in interface Control
      Returns:
      "Friendly name" alias for the control.