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

Class SyncDoneValueDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue>

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

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

public class SyncDoneValueDecorator
extends org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue>
implements org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue

A syncDoneValue object as described in rfc4533.

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	syncDoneValueLength The global length for this 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.syncDone.SyncDoneValue

OID

Constructor Summary

Constructors

Constructor and Description
SyncDoneValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec) Creates a new instance of SyncDoneValueControlCodec.
SyncDoneValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue control) Creates a new instance of SyncDoneValueDecorator.

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the syncDoneValue length.
org.apache.directory.api.asn1.Asn1Object	decode(byte[] controlBytes)
ByteBuffer	encode(ByteBuffer buffer) Encode the SyncDoneValue control
byte[]	getCookie()
byte[]	getValue()
boolean	isRefreshDeletes()
void	setCookie(byte[] cookie)
void	setRefreshDeletes(boolean refreshDeletes)

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

syncDoneValueLength

private int syncDoneValueLength

The global length for this control

DECODER

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

An instance of this decoder

Constructor Detail

SyncDoneValueDecorator

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

Creates a new instance of SyncDoneValueControlCodec.

Parameters:

codec - The LDAP Service to use

SyncDoneValueDecorator

public SyncDoneValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                              org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue control)

Creates a new instance of SyncDoneValueDecorator.

Parameters:

codec - The LDAP codec

control - The control to be decorated

Method Detail

computeLength

public int computeLength()

Compute the syncDoneValue length.

 0x30 L1
 |
 +--> 0x04 L2 xkcd!!!...     (cookie)
 +--> 0x01 0x01 [0x00|0xFF]  (refreshDeletes)
 

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 SyncDoneValue 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 while encoding.

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.syncDone.SyncDoneValue>

Overrides:

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

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue

isRefreshDeletes

public boolean isRefreshDeletes()

Specified by:

isRefreshDeletes in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue

setRefreshDeletes

public void setRefreshDeletes(boolean refreshDeletes)

Specified by:

setRefreshDeletes in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue

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.syncDone.SyncDoneValue>

Throws:

org.apache.directory.api.asn1.DecoderException