Package org.opends.server.controls

Class InternalModificationsRequestControl

java.lang.Object
org.opends.server.controls.InternalModificationsRequestControl
All Implemented Interfaces:
Control
public final class InternalModificationsRequestControl extends Object implements Control
A control providing additional modifications to a request.

Legacy ModifyDNOperation class allow to provide modifications to perform along with the DN modification. As it is not possible to do this with a ModifyDnRequest, this control can be used for this purpose.

  • Field Details

  • Constructor Details

    • InternalModificationsRequestControl

      public InternalModificationsRequestControl(boolean isCritical, String origin, List<Modification> mods)
      Constructs a new control.
      Parameters:
      isCritical - Indicates whether support for this control should be considered a critical part of the server processing.
      origin - the non-null origin of the modifications.
      mods - the non-null modifications to perform.

  • Method Details

    • 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.

    • getModifications

      public List<Modification> getModifications()
      Returns the modifications to perform.
      Returns:
      the non-null modifications

    • getOrigin

      public String getOrigin()
      Returns the origin of the modifications.
      Returns:
      the non-null origin of the modifications

    • 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.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • 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.