Package org.forgerock.opendj.ldap.controls

Class PreReadRequestControl

  • All Implemented Interfaces:
    Control
    public final class PreReadRequestControl
extends Object
implements Control
    The pre-read request control as defined in RFC 4527. This control allows the client to read the target entry of an update operation immediately before the modifications are applied. These reads are done as an atomic part of the update operation.

    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:
    PreReadResponseControl, RFC 4527 - Lightweight Directory Access Protocol (LDAP) Read Entry Controls

    • Field Detail

      • OID

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

    • Method Detail

      • newControl

        public static PreReadRequestControl newControl​(boolean isCritical,
                                               Collection<String> attributes)
        Creates a new pre-read request control.
        Parameters:
        isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored
        attributes - The list of attributes to be included with the response control. Attributes that are sub-types of listed attributes are implicitly included. The list may be empty, indicating that all user attributes should be returned.
        Returns:
        The new control.
        Throws:
        NullPointerException - If attributes was null.

      • newControl

        public static PreReadRequestControl newControl​(boolean isCritical,
                                               String... attributes)
        Creates a new pre-read request control.
        Parameters:
        isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored
        attributes - The list of attributes to be included with the response control. Attributes that are sub-types of listed attributes are implicitly included. The list may be empty, indicating that all user attributes should be returned.
        Returns:
        The new control.
        Throws:
        NullPointerException - If attributes was null.

      • getAttributes

        public List<String> getAttributes()
        Returns an unmodifiable list containing the names of attributes to be included with the response control. Attributes that are sub-types of listed attributes are implicitly included. The returned list may be empty, indicating that all user attributes should be returned.
        Returns:
        An unmodifiable list containing the names of attributes to be included with the response control.

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