org.apache.directory.api.ldap.extras.controls.syncrepl_impl

Class SyncInfoValueDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncInfoValueDecorator

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object, org.apache.directory.api.ldap.codec.api.CodecControl<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>, org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>, org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue, org.apache.directory.api.ldap.model.message.Control

public class SyncInfoValueDecorator
extends org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>
implements org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

A syncInfoValue object, as defined in RFC 4533

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.codec.api.ControlDecorator

value, valueLength

Fields inherited from interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

OID

Constructor Summary

Constructors

Constructor and Description
SyncInfoValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec) The constructor for this codec.
SyncInfoValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SynchronizationInfoEnum type) The constructor for this codec.
SyncInfoValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue control) The constructor for this codec.

Method Summary

Modifier and Type	Method and Description
void	addSyncUUID(byte[] syncUUID)
int	computeLength() Compute the SyncInfoValue length.
org.apache.directory.api.asn1.Asn1Object	decode(byte[] controlBytes)
ByteBuffer	encode(ByteBuffer buffer) Encode the SyncInfoValue control
byte[]	getCookie()
List<byte[]>	getSyncUUIDs()
org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SynchronizationInfoEnum	getType()
byte[]	getValue()
boolean	isRefreshDeletes()
boolean	isRefreshDone()
void	setCookie(byte[] cookie)
void	setRefreshDeletes(boolean refreshDeletes)
void	setRefreshDone(boolean refreshDone)
void	setSyncUUIDs(List<byte[]> syncUUIDs)
void	setType(org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SynchronizationInfoEnum type)
String	toString()

Methods inherited from class org.apache.directory.api.ldap.codec.api.ControlDecorator

equals, getCodecService, getDecorated, getOid, hashCode, hasValue, isCritical, setCritical, setDecorated, setValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control

getOid, isCritical, setCritical

Constructor Detail

SyncInfoValueDecorator

public SyncInfoValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec)

The constructor for this codec. Dont't forget to set the type.

SyncInfoValueDecorator

public SyncInfoValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                              org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue control)

The constructor for this codec. Dont't forget to set the type.

SyncInfoValueDecorator

public SyncInfoValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                              org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SynchronizationInfoEnum type)

The constructor for this codec.

Parameters:

type - The kind of syncInfo we will store. Can be newCookie, refreshPresent, refreshDelete or syncIdSet

Method Detail

getType

public org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SynchronizationInfoEnum getType()

Specified by:

getType in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

setType

public void setType(org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SynchronizationInfoEnum type)

Specified by:

setType in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

isRefreshDone

public boolean isRefreshDone()

Specified by:

isRefreshDone in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

setRefreshDone

public void setRefreshDone(boolean refreshDone)

Specified by:

setRefreshDone in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

isRefreshDeletes

public boolean isRefreshDeletes()

Specified by:

isRefreshDeletes in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

setRefreshDeletes

public void setRefreshDeletes(boolean refreshDeletes)

Specified by:

setRefreshDeletes in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

getSyncUUIDs

public List<byte[]> getSyncUUIDs()

Specified by:

getSyncUUIDs in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

setSyncUUIDs

public void setSyncUUIDs(List<byte[]> syncUUIDs)

Specified by:

setSyncUUIDs in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

addSyncUUID

public void addSyncUUID(byte[] syncUUID)

Specified by:

addSyncUUID in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue

computeLength

public int computeLength()

Compute the SyncInfoValue length. SyncInfoValue : 0xA0 L1 abcd // newCookie 0xA1 L2 // refreshDelete | [+--> 0x04 L3 abcd] // cookie [+--> 0x01 0x01 (0x00|0xFF) // refreshDone 0xA2 L4 // refreshPresent | [+--> 0x04 L5 abcd] // cookie [+--> 0x01 0x01 (0x00|0xFF) // refreshDone 0xA3 L6 // syncIdSet | [+--> 0x04 L7 abcd] // cookie [+--> 0x01 0x01 (0x00|0xFF) // refreshDeletes +--> 0x31 L8 // SET OF syncUUIDs | [+--> 0x04 L9 abcd] // syncUUID public static final int AND_FILTER_TAG = 0xA0; public static final int OR_FILTER_TAG = 0xA1; public static final int NOT_FILTER_TAG = 0xA2; public static final int BIND_REQUEST_SASL_TAG = 0xA3;

Specified by:

computeLength in interface org.apache.directory.api.asn1.Asn1Object

Specified by:

computeLength in interface org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

Overrides:

computeLength in class org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws org.apache.directory.api.asn1.EncoderException

Encode the SyncInfoValue control

Specified by:

encode in interface org.apache.directory.api.asn1.Asn1Object

Specified by:

encode in interface org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

Parameters:

buffer - The encoded sink

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

org.apache.directory.api.asn1.EncoderException - If anything goes wrong.

getValue

public byte[] getValue()

Specified by:

getValue in interface org.apache.directory.api.ldap.codec.api.CodecControl<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

Overrides:

getValue in class org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

decode

public org.apache.directory.api.asn1.Asn1Object decode(byte[] controlBytes)
                                                throws org.apache.directory.api.asn1.DecoderException

Specified by:

decode in interface org.apache.directory.api.ldap.codec.api.CodecControl<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

Throws:

org.apache.directory.api.asn1.DecoderException

toString

public String toString()

Overrides:

toString in class org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue>

See Also:

Object.toString()