Class PostReadResponseControl

java.lang.Object
org.forgerock.opendj.ldap.controls.PostReadResponseControl
All Implemented Interfaces:
Control

public final class PostReadResponseControl extends Object implements Control
The post-read response control as defined in RFC 4527. This control is returned by the server in response to a successful update operation which included a post-read request control. The control contains a Search Result Entry containing, subject to access controls and other constraints, values of the requested attributes.

The following example gets a modified entry from the result of a modify operation.

 Connection connection = ...;
 String DN = ...;

 ModifyRequest request =
         Requests.newModifyRequest(DN)
         .addControl(PostReadRequestControl.newControl(true, "description"))
         .addModification(ModificationType.REPLACE,
                 "description", "Using the PostReadRequestControl");

 Result result = connection.modify(request);
 PostReadResponseControl control =
         result.getControl(PostReadResponseControl.DECODER,
                 new DecodeOptions());
 Entry modifiedEntry = control.getEntry();
 
See Also:
  • Field Details

  • Method Details

    • newControl

      public static PostReadResponseControl newControl(Entry entry)
      Creates a new post-read response control.
      Parameters:
      entry - The entry whose contents reflect the state of the updated entry immediately after the update operation was performed.
      Returns:
      The new control.
      Throws:
      NullPointerException - If entry was null.
    • getEntry

      public Entry getEntry()
      Returns an unmodifiable entry whose contents reflect the state of the updated entry immediately after the update operation was performed.
      Returns:
      The unmodifiable entry whose contents reflect the state of the updated entry immediately after the update operation was performed.
    • 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.