org.apache.directory.shared.ldap.message
Class EntryChangeControl

java.lang.Object
  extended byorg.apache.directory.shared.ldap.message.ControlImpl
      extended byorg.apache.directory.shared.ldap.message.EntryChangeControl
All Implemented Interfaces:
Control, javax.naming.ldap.Control, java.io.Serializable

public class EntryChangeControl
extends ControlImpl

A response control that may be returned by Persistent Search entry responses. It contains addition change information to descrive the exact change that occured 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.
 

Version:
$Rev: 379008 $
Author:
Apache Directory Project
See Also:
Serialized Form

Field Summary
static java.lang.String CONTROL_OID
           
static int UNDEFINED_CHANGE_NUMBER
           
 
Fields inherited from interface javax.naming.ldap.Control
CRITICAL, NONCRITICAL
 
Constructor Summary
EntryChangeControl()
           
 
Method Summary
 int getChangeNumber()
           
 ChangeType getChangeType()
           
 byte[] getEncodedValue()
           
 java.lang.String getPreviousDn()
           
 void setChangeNumber(int changeNumber)
           
 void setChangeType(ChangeType changeType)
           
 void setPreviousDn(LdapString previousDn)
           
 void setPreviousDn(java.lang.String previousDn)
           
 
Methods inherited from class org.apache.directory.shared.ldap.message.ControlImpl
getID, getType, getValue, isCritical, setCritical, setType, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTROL_OID

public static final java.lang.String CONTROL_OID
See Also:
Constant Field Values

UNDEFINED_CHANGE_NUMBER

public static final int UNDEFINED_CHANGE_NUMBER
See Also:
Constant Field Values
Constructor Detail

EntryChangeControl

public EntryChangeControl()
Method Detail

getChangeType

public ChangeType getChangeType()

setChangeType

public void setChangeType(ChangeType changeType)

getPreviousDn

public java.lang.String getPreviousDn()

setPreviousDn

public void setPreviousDn(java.lang.String previousDn)

setPreviousDn

public void setPreviousDn(LdapString previousDn)

getChangeNumber

public int getChangeNumber()

setChangeNumber

public void setChangeNumber(int changeNumber)

getEncodedValue

public byte[] getEncodedValue()


Copyright © 2003-2006 . All Rights Reserved.