public class EntryChangeControl extends AbstractControl
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.
Modifier and Type | Field and Description |
---|---|
static String |
CONTROL_OID
The EntryChange control
|
static int |
UNDEFINED_CHANGE_NUMBER |
decoder, value, valueLength
parent
Constructor and Description |
---|
EntryChangeControl() |
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.
|
computeLength, getDecoder, getOid, hasValue, isCritical, setCritical, setValue
addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent
public static final String CONTROL_OID
public static final int UNDEFINED_CHANGE_NUMBER
public int computeLength()
computeLength
in interface Asn1Object
computeLength
in interface CodecControl
computeLength
in class AbstractControl
public ByteBuffer encode(ByteBuffer buffer) throws EncoderException
encode
in interface Asn1Object
encode
in interface CodecControl
encode
in class AbstractControl
buffer
- The encoded sinkEncoderException
- If anything goes wrong.public byte[] getValue()
getValue
in interface Control
getValue
in class AbstractControl
public ChangeType getChangeType()
public void setChangeType(ChangeType changeType)
changeType
- Add, Delete; Modify or ModifyDNpublic DN getPreviousDn()
public void setPreviousDn(DN previousDn)
public long getChangeNumber()
public void setChangeNumber(long changeNumber)
public String toString()
toString
in class AbstractControl
Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.