Entry change notification control

The Entry change notification control explains its use with the server and provides the results.

Description

This control provides more information about the changes that caused a particular entry to be returned as the result of a persistent search.

OID

2.16.840.1.113730.3.4.7

Syntax

EntryChangeNotification ::= SEQUENCE {
                     changeType ENUMERATED {
                             add       (1),
                             delete    (2),
                             modify    (4),
                             modDN     (8)},
                     previousDN     LDAPDN OPTIONAL,
                     changeNumber   INTEGER OPTIONAL
}

Behavior

If the client set the returnECs Boolean to TRUE in the persistent search control, the server must include the entry change notification control in the controls portion of each SearchResultEntry that is returned because of an entry that is added, deleted, or modified.

The value of changeType field indicates what LDAP operation caused the entry to be returned.

The previousDN is present in modifyDN operations and is used to retrieve the DN of the entry before it was renamed or moved. The changeType optional field must be included by servers when it returns change notifications as a result of modifyDN operations.

The changeNumber field represents the change number [CHANGELOG] that is assigned by a server for the change. If a server supports an LDAP change log, it must include this field.

If the search code determines the persistent search control is present, the control is parsed and the operation is run as specified in the control. After the operation, the pBlock will be handed off to the plug-in for its record keeping, and the client search is left open. The returnECs control is returned from the plug-in and not the inline search code.

Note: It is up to the server administrator to configure change log for the client. If the change log is not set up properly, the client receives no change numbers.

This control is not supported by the Administration Server.