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

Class SyncRequestValueDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue>

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

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

public class SyncRequestValueDecorator
extends org.apache.directory.api.ldap.codec.api.ControlDecorator<org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue>
implements org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue

A syncRequestValue 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	syncRequestValueLength 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.syncRequest.SyncRequestValue

OID

Constructor Summary

Constructors

Constructor and Description
SyncRequestValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec) Create a new SyncRequestValueDecorator instance
SyncRequestValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue control) Create a new SyncRequestValueDecorator instance

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the SyncRequestValue length.
org.apache.directory.api.asn1.Asn1Object	decode(byte[] controlBytes)
ByteBuffer	encode(ByteBuffer buffer) Encode the SyncRequestValue control
byte[]	getCookie()
org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum	getMode()
byte[]	getValue()
boolean	isReloadHint()
void	setCookie(byte[] cookie)
void	setMode(org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum mode)
void	setReloadHint(boolean reloadHint)

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

syncRequestValueLength

private int syncRequestValueLength

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

SyncRequestValueDecorator

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

Create a new SyncRequestValueDecorator instance

Parameters:

codec - The LDAP API service to use

SyncRequestValueDecorator

public SyncRequestValueDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                                 org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue control)

Create a new SyncRequestValueDecorator instance

Parameters:

codec - The LDAP API service to use

control - The decorated SyncRequestValue control

Method Detail

getMode

public org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum getMode()

Specified by:

getMode in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue

setMode

public void setMode(org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum mode)

Specified by:

setMode in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue

isReloadHint

public boolean isReloadHint()

Specified by:

isReloadHint in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue

setReloadHint

public void setReloadHint(boolean reloadHint)

Specified by:

setReloadHint in interface org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue

computeLength

public int computeLength()

Compute the SyncRequestValue length.
SyncRequestValue :

 0x30 L1
  |
  +--> 0x0A 0x01 [0x00|0x01|0x02|0x03] (mode)
 [+--> 0x04 L2 abcd...                 (cookie)
  +--> 0x01 0x01 [0x00|0xFF]           (reloadHint)
 

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 SyncRequestValue 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.syncRequest.SyncRequestValue>

Overrides:

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

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.syncRequest.SyncRequestValue>

Throws:

org.apache.directory.api.asn1.DecoderException