Class LdapPersistSearchControl

java.lang.Object
netscape.ldap.LDAPControl
netscape.ldap.controls.LDAPPersistSearchControl
com.netscape.jndi.ldap.controls.LdapPersistSearchControl
All Implemented Interfaces:
Serializable, Cloneable, Control

public class LdapPersistSearchControl extends netscape.ldap.controls.LDAPPersistSearchControl implements Control
Represents an LDAP v3 server control that specifies a persistent search (an ongoing search operation), which allows your LDAP client to get notification of changes to the directory. (The OID for this control is 2.16.840.1.113730.3.4.3.) You can use this control in conjunction with an "entry change notification" control.

To use persistent searching for change notification, you create a "persistent search" control that specifies the types of changes that you want to track. You include the control in a search request. If an entry in the directory is changed, the server determines if the entry matches the search criteria in your request and if the change is the type of change that you are tracking. If both of these are true, the server sends the entry to your client.

The server can also include an "entry change notification" control with the entry. (The OID for this control is 2.16.840.1.113730.3.4.7.) This control contains additional information about the change made to the entry, including the type of change made, the change number (which corresponds to an item in the server's change log, if the server supports a change log), and, if the entry was renamed, the old DN of the entry.

When constructing an LDAPPersistSearchControl object, you can specify the following information:

  • the type of change you want to track (added, modified, deleted, or renamed entries)
  • a preference indicating whether or not you want the server to return all entries that initially matched the search criteria (rather than only the entries that change)
  • a preference indicating whether or not you want entry change notification controls included with every entry returned by the server

See Also: