org.apache.directory.shared.ldap.codec.controls.replication.syncRequestValue

Class SyncRequestValueControl

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.controls.AbstractControl

org.apache.directory.shared.ldap.codec.controls.replication.syncRequestValue.SyncRequestValueControl

All Implemented Interfaces:

Asn1Object, CodecControl, Control

public class SyncRequestValueControl
extends AbstractControl

A syncRequestValue object, as defined in RFC 4533

Version:

$Rev:$, $Date:

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROL_OID This control OID

Fields inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl

decoder, value, valueLength

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
SyncRequestValueControl()

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the SyncRequestValue length.
ByteBuffer	encode(ByteBuffer buffer) Encode the SyncRequestValue control
byte[]	getCookie()
SynchronizationModeEnum	getMode()
byte[]	getValue() Get the control value
boolean	isReloadHint()
void	setCookie(byte[] cookie)
void	setMode(SynchronizationModeEnum mode)
void	setReloadHint(boolean reloadHint)
String	toString() Return a String representing a Control

Methods inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl

computeLength, getDecoder, getOid, hasValue, isCritical, setCritical, setValue

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

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

Field Detail

CONTROL_OID

public static final String CONTROL_OID

This control OID

See Also:

Constant Field Values

Constructor Detail

SyncRequestValueControl

public SyncRequestValueControl()

Method Detail

getMode

public SynchronizationModeEnum getMode()

Returns:

the mode

setMode

public void setMode(SynchronizationModeEnum mode)

Parameters:

syncMode - the syncMode to set

getCookie

public byte[] getCookie()

Returns:

the cookie

setCookie

public void setCookie(byte[] cookie)

Parameters:

cookie - the cookie to set

isReloadHint

public boolean isReloadHint()

Returns:

the reloadHint

setReloadHint

public void setReloadHint(boolean reloadHint)

Parameters:

reloadHint - the reloadHint to set

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 Asn1Object

Specified by:

computeLength in interface CodecControl

Overrides:

computeLength in class AbstractControl

Returns:

The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the SyncRequestValue control

Specified by:

encode in interface Asn1Object

Specified by:

encode in interface CodecControl

Overrides:

encode in class AbstractControl

Parameters:

buffer - The encoded sink

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

EncoderException - If anything goes wrong.

getValue

public byte[] getValue()

Get the control value

Specified by:

getValue in interface Control

Overrides:

getValue in class AbstractControl

Returns:

The control value

toString

public String toString()

Description copied from class: AbstractControl

Return a String representing a Control

Overrides:

toString in class AbstractControl

See Also:

Object.toString()