Package org.opends.server.controls

Class EntryChangelogNotificationResponseControl

  • All Implemented Interfaces:
    Control
    public class EntryChangelogNotificationResponseControl
extends Object
implements Control
    This class implements the ECL cookie control. It may be included in entries returned in response to a search or persistent search operation to communicate the cookie that allow to uniquely position a search on the search result entry.

    • Constructor Detail

      • EntryChangelogNotificationResponseControl

        public EntryChangelogNotificationResponseControl​(boolean isCritical,
                                                 String cookie)
        Creates a new entry change notification control with the provided information.
        Parameters:
        isCritical - Indicates whether this control should be considered critical in processing the request.
        cookie - The provided cookie value.

    • Method Detail

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

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

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

      • getCookie

        public String getCookie()
        Retrieves the change type for this entry change notification control.
        Returns:
        The change type for this entry change notification control.

      • isCritical

        public final 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.