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

Class SyncInfoValueDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.MessageDecorator<M>

org.apache.directory.api.ldap.codec.decorators.ResponseDecorator<I>

org.apache.directory.api.ldap.codec.decorators.IntermediateResponseDecorator<org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue>

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

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object, org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue>, org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue, org.apache.directory.api.ldap.model.message.IntermediateResponse, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Response, org.apache.directory.api.ldap.model.message.ResultResponse

public class SyncInfoValueDecorator
extends org.apache.directory.api.ldap.codec.decorators.IntermediateResponseDecorator<org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue>
implements org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue

A syncInfoValue object, as defined in RFC 4533

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.directory.api.asn1.ber.Asn1Decoder	DECODER An instance of this decoder
private int	syncInfoValueLength The global length for this response
private int	syncUUIDsLength The syncUUIDs cumulative length
protected byte[]	value The encoded value.
protected int	valueLength The encoded value length

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

messageLength

Fields inherited from interface org.apache.directory.api.ldap.extras.intermediate.syncrepl.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.intermediate.syncrepl.SynchronizationInfoEnum type) The constructor for this codec.
SyncInfoValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue syncInfoValue) 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[] responseBytes)
ByteBuffer	encode(ByteBuffer buffer) Encode the SyncInfoValue response
byte[]	getCookie()
org.apache.directory.api.ldap.extras.intermediate.syncrepl.SynchronizationInfoEnum	getSyncInfoValueType()
List<byte[]>	getSyncUUIDs()
byte[]	getValue()
boolean	isRefreshDeletes()
boolean	isRefreshDone()
void	setCookie(byte[] cookie)
void	setRefreshDeletes(boolean refreshDeletes)
void	setRefreshDone(boolean refreshDone)
void	setSyncInfoValueType(org.apache.directory.api.ldap.extras.intermediate.syncrepl.SynchronizationInfoEnum syncInfoValueType)
void	setSyncUUIDs(List<byte[]> syncUUIDs)
String	toString()

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.IntermediateResponseDecorator

getResponseName, getResponseValue, setResponseName, setResponseValue

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ResponseDecorator

getLdapResult, setLdapResult

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

addAllControls, addControl, get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, removeControl, setControlsLength, setMessageId, setMessageLength

Methods inherited from class java.lang.Object

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

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

getResponseName, getResponseValue, setResponseName, setResponseValue

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

getLdapResult

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

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

syncUUIDsLength

private int syncUUIDsLength

The syncUUIDs cumulative length

DECODER

private static final org.apache.directory.api.asn1.ber.Asn1Decoder DECODER

An instance of this decoder

syncInfoValueLength

private int syncInfoValueLength

The global length for this response

valueLength

protected int valueLength

The encoded value length

value

protected byte[] value

The encoded value.

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.

Parameters:

codec - The LDAP Service to use

SyncInfoValueDecorator

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

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

Parameters:

codec - The LDAP Service to use

syncInfoValue - The SyncInfoValue to decorate

SyncInfoValueDecorator

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

The constructor for this codec.

Parameters:

codec - The LDAP Service to use

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

Method Detail

getSyncInfoValueType

public org.apache.directory.api.ldap.extras.intermediate.syncrepl.SynchronizationInfoEnum getSyncInfoValueType()

Specified by:

getSyncInfoValueType in interface org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue

setSyncInfoValueType

public void setSyncInfoValueType(org.apache.directory.api.ldap.extras.intermediate.syncrepl.SynchronizationInfoEnum syncInfoValueType)

Specified by:

setSyncInfoValueType in interface org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue

getCookie

public byte[] getCookie()

Specified by:

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

setCookie

public void setCookie(byte[] cookie)

Specified by:

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

isRefreshDone

public boolean isRefreshDone()

Specified by:

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

setRefreshDone

public void setRefreshDone(boolean refreshDone)

Specified by:

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

isRefreshDeletes

public boolean isRefreshDeletes()

Specified by:

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

setRefreshDeletes

public void setRefreshDeletes(boolean refreshDeletes)

Specified by:

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

getSyncUUIDs

public List<byte[]> getSyncUUIDs()

Specified by:

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

setSyncUUIDs

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

Specified by:

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

addSyncUUID

public void addSyncUUID(byte[] syncUUID)

Specified by:

addSyncUUID in interface org.apache.directory.api.ldap.extras.intermediate.syncrepl.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
 

Specified by:

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

Overrides:

computeLength in class org.apache.directory.api.ldap.codec.decorators.IntermediateResponseDecorator<org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue>

Returns:

The computed length

encode

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

Encode the SyncInfoValue response

Specified by:

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

Overrides:

encode in class org.apache.directory.api.ldap.codec.decorators.IntermediateResponseDecorator<org.apache.directory.api.ldap.extras.intermediate.syncrepl.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()

decode

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

Throws:

org.apache.directory.api.asn1.DecoderException

toString

public String toString()

Overrides:

toString in class org.apache.directory.api.ldap.codec.api.MessageDecorator<org.apache.directory.api.ldap.extras.intermediate.syncrepl.SyncInfoValue>

See Also:

Object.toString()