Package org.forgerock.opendj.ldap.controls

Class PersistentSearchRequestControl

  • All Implemented Interfaces:
    Control
    public final class PersistentSearchRequestControl
extends Object
implements Control
    The persistent search request control as defined in draft-ietf-ldapext-psearch. This control allows a client to receive notification of changes that occur in an LDAP server.

    You can examine the entry change notification response control to get more information about a change returned by the persistent search. 

     Connection connection = ...;

 SearchRequest request =
         Requests.newSearchRequest(
                 "dc=example,dc=com", SearchScope.WHOLE_SUBTREE,
                 "(objectclass=inetOrgPerson)", "cn")
                 .addControl(PersistentSearchRequestControl.newControl(
                             true, true, true, // critical,changesOnly,returnECs
                             PersistentSearchChangeType.ADD,
                             PersistentSearchChangeType.DELETE,
                             PersistentSearchChangeType.MODIFY,
                             PersistentSearchChangeType.MODIFYDN));

 ConnectionEntryReader reader = connection.search(request);

 while (reader.hasNext()) {
     if (!reader.isReference()) {
         SearchResultEntry entry = reader.readEntry(); // Entry that changed

         EntryChangeNotificationResponseControl control = entry.getControl(
                 EntryChangeNotificationResponseControl.DECODER,
                 new DecodeOptions());

         PersistentSearchChangeType type = control.getChangeType();
         if (type.equals(PersistentSearchChangeType.MODIFYDN)) {
             // Previous DN: control.getPreviousName()
         }
         // Change number: control.getChangeNumber());
     }
 }
    See Also:
    EntryChangeNotificationResponseControl, PersistentSearchChangeType, draft-ietf-ldapext-psearch - Persistent Search: A Simple LDAP Change Notification Mechanism

    • Method Detail

      • newControl

        public static PersistentSearchRequestControl newControl​(boolean isCritical,
                                                        boolean changesOnly,
                                                        boolean returnEntryChangeNotificationControl,
                                                        Collection<PersistentSearchChangeType> changeTypes)
        Creates a new persistent search 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
        changesOnly - Indicates whether only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation). If this parameter is false then the search will initially return all the existing entries which match the filter.
        returnEntryChangeNotificationControl - Indicates whether the entry change notification response control should be included in updated entries that match the associated search criteria.
        changeTypes - The types of update operation for which change notifications should be returned.
        Returns:
        The new control.
        Throws:
        NullPointerException - If changeTypes was null.

      • newControl

        public static PersistentSearchRequestControl newControl​(boolean isCritical,
                                                        boolean changesOnly,
                                                        boolean returnEntryChangeNotificationControl,
                                                        PersistentSearchChangeType... changeTypes)
        Creates a new persistent search 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
        changesOnly - Indicates whether only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation). If this parameter is false then the search will initially return all the existing entries which match the filter.
        returnEntryChangeNotificationControl - Indicates whether the entry change notification response control should be included in updated entries that match the associated search criteria.
        changeTypes - The types of update operation for which change notifications should be returned.
        Returns:
        The new control.
        Throws:
        NullPointerException - If changeTypes was null.

      • getChangeTypes

        public Set<PersistentSearchChangeType> getChangeTypes()
        Returns an unmodifiable set containing the types of update operation for which change notifications should be returned.
        Returns:
        An unmodifiable set containing the types of update operation for which change notifications should be returned.

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

      • isChangesOnly

        public boolean isChangesOnly()
        Returns true if only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation), otherwise false if the search will initially return all the existing entries which match the filter.
        Returns:
        true if only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation), otherwise false if the search will initially return all the existing entries which match the filter.

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

      • isReturnEntryChangeNotificationControls

        public boolean isReturnEntryChangeNotificationControls()
        Returns true if the entry change notification response control should be included in updated entries that match the associated search criteria.
        Returns:
        true if the entry change notification response control should be included in updated entries that match the associated search criteria.