Package org.forgerock.opendj.ldap.controls

Class PreReadResponseControl

java.lang.Object
org.forgerock.opendj.ldap.controls.PreReadResponseControl
All Implemented Interfaces:
Control
public final class PreReadResponseControl extends Object implements Control
The pre-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 pre-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 the entry as it was before the modify operation. 

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

 ModifyRequest request =
         Requests.newModifyRequest(DN)
         .addControl(PreReadRequestControl.newControl(true, "mail"))
         .addModification(ModificationType.REPLACE,
                 "mail", "modified@example.com");

 Result result = connection.modify(request);
 PreReadResponseControl control =
             result.getControl(PreReadResponseControl.DECODER,
                     new DecodeOptions());
 Entry unmodifiedEntry = control.getEntry();
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ControlDecoder<PreReadResponseControl>
    DECODER
    A decoder which can be used for decoding the pre-read response control.
    static final String
    OID
    The IANA-assigned OID for the LDAP pre-read response control used for retrieving an entry in the state it had immediately before an update was applied.

  • Method Summary

    Modifier and Type
    Method
    Description
    Entry
    getEntry()
    Returns an unmodifiable entry whose contents reflect the state of the updated entry immediately before the update operation was performed.
    String
    getOID()
    Returns the numeric OID associated with this control.
    ByteString
    getValue()
    Returns the value, if any, associated with this control.
    boolean
    hasValue()
    Returns true if this control has a value.
    boolean
    isCritical()
    Returns true if it is unacceptable to perform the operation without applying the semantics of this control.
    static PreReadResponseControl
    newControl(Entry entry)
    Creates a new pre-read response control.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • OID

      public static final String OID
      The IANA-assigned OID for the LDAP pre-read response control used for retrieving an entry in the state it had immediately before an update was applied.
      See Also:

    • DECODER

      public static final ControlDecoder<PreReadResponseControl> DECODER
      A decoder which can be used for decoding the pre-read response control.

  • Method Details

    • newControl

      public static PreReadResponseControl newControl(Entry entry)
      Creates a new pre-read response control.
      Parameters:
      entry - The entry whose contents reflect the state of the updated entry immediately before 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 before the update operation was performed.
      Returns:
      The unmodifiable entry whose contents reflect the state of the updated entry immediately before 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