org.apache.directory.shared.ldap.codec.search.controls.entryChange

Class EntryChangeControl

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.controls.AbstractControl

org.apache.directory.shared.ldap.codec.search.controls.entryChange.EntryChangeControl

All Implemented Interfaces:

Asn1Object, CodecControl, Control

public class EntryChangeControl
extends AbstractControl

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.
 

Version:

$Rev: 918756 $, $Date: 2010-03-04 00:05:29 +0100(gio, 04 mar 2010) $,

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROL_OID The EntryChange control
static int	UNDEFINED_CHANGE_NUMBER

Fields inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl

decoder, value, valueLength

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
EntryChangeControl()

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the EntryChangeControl length 0x30 L1 | +--> 0x0A 0x0(1-4) [1|2|4|8] (changeType) [+--> 0x04 L2 previousDN] [+--> 0x02 0x0(1-4) [0..2^63-1] (changeNumber)]
ByteBuffer	encode(ByteBuffer buffer) Encodes the entry change control.
long	getChangeNumber()
ChangeType	getChangeType()
DN	getPreviousDn()
byte[]	getValue() Get the control value
void	setChangeNumber(long changeNumber)
void	setChangeType(ChangeType changeType) Set the ChangeType
void	setPreviousDn(DN previousDn)
String	toString() Return a String representing this EntryChangeControl.

Methods inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl

computeLength, getDecoder, getOid, hasValue, isCritical, setCritical, setValue

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTROL_OID

public static final String CONTROL_OID

The EntryChange control

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()

See Also:

Asn1Object#Asn1Object

Method Detail

computeLength

public int computeLength()

Compute the EntryChangeControl length 0x30 L1 | +--> 0x0A 0x0(1-4) [1|2|4|8] (changeType) [+--> 0x04 L2 previousDN] [+--> 0x02 0x0(1-4) [0..2^63-1] (changeNumber)]

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in interface CodecControl

Overrides:

computeLength in class AbstractControl

Returns:

The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encodes the entry change control.

Specified by:

encode in interface Asn1Object

Specified by:

encode in interface CodecControl

Overrides:

encode in class AbstractControl

Parameters:

buffer - The encoded sink

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

EncoderException - If anything goes wrong.

getValue

public byte[] getValue()

Get the control value

Specified by:

getValue in interface Control

Overrides:

getValue in class AbstractControl

Returns:

The control value

getChangeType

public ChangeType getChangeType()

Returns:

The ChangeType

setChangeType

public void setChangeType(ChangeType changeType)

Set the ChangeType

Parameters:

changeType - Add, Delete; Modify or ModifyDN

getPreviousDn

public DN getPreviousDn()

setPreviousDn

public void setPreviousDn(DN previousDn)

getChangeNumber

public long getChangeNumber()

setChangeNumber

public void setChangeNumber(long changeNumber)

toString

public String toString()

Return a String representing this EntryChangeControl.

Overrides:

toString in class AbstractControl