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

Class SyncStateValueDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue>

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

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.syncState.SyncStateValue>, org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue>, org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue, org.apache.directory.api.ldap.model.message.Control

public class SyncStateValueDecorator
extends org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue>
implements org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue

A syncStateValue 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	syncStateSeqLength Global length for the control

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.syncState.SyncStateValue

OID

Constructor Summary

Constructors

Constructor and Description
SyncStateValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec) Creates a new instance of SyncStateValueDecorator.
SyncStateValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue value) Creates a new instance of SyncStateValueDecorator.

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the SyncStateValue length.
org.apache.directory.api.asn1.Asn1Object	decode(byte[] controlBytes)
ByteBuffer	encode(ByteBuffer buffer) Encode the SyncStateValue control
byte[]	getCookie()
byte[]	getEntryUUID()
org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateTypeEnum	getSyncStateType()
byte[]	getValue()
void	setCookie(byte[] cookie)
void	setEntryUUID(byte[] entryUUID)
void	setSyncStateType(org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateTypeEnum syncStateType)

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

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

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

Field Detail

syncStateSeqLength

private int syncStateSeqLength

Global length for the control

DECODER

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

An instance of this decoder

Constructor Detail

SyncStateValueDecorator

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

Creates a new instance of SyncStateValueDecorator.

Parameters:

codec - The LDAP Service to use

SyncStateValueDecorator

public SyncStateValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                               org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue value)

Creates a new instance of SyncStateValueDecorator.

Parameters:

codec - The LDAP Service to use

value - The SyncState value to use

Method Detail

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue

getSyncStateType

public org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateTypeEnum getSyncStateType()

Specified by:

getSyncStateType in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue

setSyncStateType

public void setSyncStateType(org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateTypeEnum syncStateType)

Specified by:

setSyncStateType in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue

getEntryUUID

public byte[] getEntryUUID()

Specified by:

getEntryUUID in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue

setEntryUUID

public void setEntryUUID(byte[] entryUUID)

Specified by:

setEntryUUID in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue

computeLength

public int computeLength()

Compute the SyncStateValue length.
SyncStateValue :

 0x30 L1
  |
  +--> 0x0A 0x01 [0x00|0x01|0x02|0x03] (type)
 [+--> 0x04 L2 abcd...                 (entryUUID)
 [+--> 0x04 L3 abcd...                 (cookie)
 

Specified by:

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

Returns:

The computed length

encode

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

Encode the SyncStateValue control

Specified by:

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

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.syncState.SyncStateValue>

Overrides:

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

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.syncState.SyncStateValue>

Throws:

org.apache.directory.api.asn1.DecoderException