Persistent search control

The Persistent search control explains its use with the server and provides the results.

Description

This control provides clients a means to receive notification of changes in the LDAP server.

OID

2.16.840.1.113730.3.4.3

Syntax

PersistentSearch ::=  SEQUENCE {
          changeTypes      INTEGER,
          changesOnly      BOOLEAN,
          returnECs        BOOLEAN}

Behavior

This control can be used by all LDAP users.

If changesOnly is TRUE, then the server does not return any existing entries that match the search criteria. Also, no entries are returned until an update on an entry occurs that matches the initial search filter. Entries are only returned after successful update operations. For example, if data is loaded in the server and a search is issued against it, the matching entries are returned. However, if the persistent search control is present the entries might or might not be returned initially. This search is determined by the changesOnly field.

If changesOnly is FALSE, then the server returns all the entries that match the search filter. Also, the connection is left open and any changes or updates on entries that match the search filter from that point triggers entries to be returned.

The changeTypes is the logical OR of one or more of these values:

• add (1)
• delete (2)
• modify (4)
• modDN (8)

If returnECs is TRUE, the server returns an entry change notification control with each entry returned as the result of changes.

This control is not supported by the Administration Server.