Interface EntryChange
-
- All Superinterfaces:
Control
- All Known Implementing Classes:
EntryChangeImpl
public interface EntryChange extends Control
A response control that may be returned by Persistent Search entry responses. It contains addition change information to describe the exact change that occurred to an entry. The exact details of this control are covered in section 5 of this (yes) expired draft: Persistent Search Draft v03 which is printed out below for convenience:5. Entry Change Notification Control This control provides additional information about the change the caused a particular entry to be returned as the result of a persistent search. The controlType is "2.16.840.1.113730.3.4.7". If the client set the returnECs boolean to TRUE in the PersistentSearch control, servers MUST include an EntryChangeNotification control in the Controls portion of each SearchResultEntry that is returned due to an entry being added, deleted, or modified. EntryChangeNotification ::= SEQUENCE { changeType ENUMERATED { add (1), delete (2), modify (4), modDN (8) }, previousDN LDAPDN OPTIONAL, -- modifyDN ops. only changeNumber INTEGER OPTIONAL -- if supported } changeType indicates what LDAP operation caused the entry to be returned. previousDN is present only for modifyDN operations and gives the Dn of the entry before it was renamed and/or moved. Servers MUST include this optional field only when returning change notifications as a result of modifyDN operations. changeNumber is the change number [CHANGELOG] assigned by a server for the change. If a server supports an LDAP Change Log it SHOULD include this field.
- Author:
- Apache Directory Project
-
-
Field Summary
Fields Modifier and Type Field Description static String
OID
The EntryChange controlstatic int
UNDEFINED_CHANGE_NUMBER
No defined change number
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getChangeNumber()
ChangeType
getChangeType()
Dn
getPreviousDn()
void
setChangeNumber(long changeNumber)
Sets the ChangeNumbervoid
setChangeType(ChangeType changeType)
Set the ChangeTypevoid
setPreviousDn(Dn previousDn)
Sets the previous DN-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Control
getOid, isCritical, setCritical
-
-
-
-
Field Detail
-
UNDEFINED_CHANGE_NUMBER
static final int UNDEFINED_CHANGE_NUMBER
No defined change number- See Also:
- Constant Field Values
-
OID
static final String OID
The EntryChange control- See Also:
- Constant Field Values
-
-
Method Detail
-
getChangeType
ChangeType getChangeType()
- Returns:
- The ChangeType
-
setChangeType
void setChangeType(ChangeType changeType)
Set the ChangeType- Parameters:
changeType
- Add, Delete; Modify or ModifyDN
-
getPreviousDn
Dn getPreviousDn()
- Returns:
- The previous DN
-
setPreviousDn
void setPreviousDn(Dn previousDn)
Sets the previous DN- Parameters:
previousDn
- The previous DN
-
getChangeNumber
long getChangeNumber()
- Returns:
- The change number
-
setChangeNumber
void setChangeNumber(long changeNumber)
Sets the ChangeNumber- Parameters:
changeNumber
- The ChanegNumber
-
-