Package org.forgerock.opendj.ldap.controls

Class AssertionRequestControl

  • All Implemented Interfaces:
    Control
    public final class AssertionRequestControl
extends Object
implements Control
    The assertion request control as defined in RFC 4528. The Assertion control allows a client to specify that a directory operation should only be processed if an assertion applied to the target entry of the operation is true. It can be used to construct "test and set", "test and clear", and other conditional operations.

    The following excerpt shows how to check that no description exists on an entry before adding a description. 

     Connection connection = ...;
 connection.bind(...);

 String entryDN = ...;
 ModifyRequest request =
         Requests.newModifyRequest(entryDN)
             .addControl(AssertionRequestControl.newControl(
                     true, Filter.valueOf("!(description=*)")))
             .addModification(ModificationType.ADD, "description",
                     "Created using LDAP assertion control");

 connection.modify(request);
 ...
    See Also:
    RFC 4528 - Lightweight Directory Access Protocol (LDAP) Assertion Control

    • Method Detail

      • newControl

        public static AssertionRequestControl newControl​(boolean isCritical,
                                                 Filter filter)
        Creates a new assertion using the provided criticality and assertion filter.
        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.
        filter - The assertion filter.
        Returns:
        The new control.
        Throws:
        NullPointerException - If filter was null.

      • getFilter

        public Filter getFilter()
        Returns the assertion filter.
        Returns:
        The assertion filter.

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