org.apache.directory.shared.ldap.message.control.replication
Class SyncRequestValueControl

java.lang.Object
  org.apache.directory.shared.ldap.message.control.InternalAbstractControl
      org.apache.directory.shared.ldap.message.control.replication.SyncRequestValueControl

All Implemented Interfaces:

java.io.Serializable, javax.naming.ldap.Control, InternalControl

public class SyncRequestValueControl
extends InternalAbstractControl

This class implements the Sunc Request Control, as described by RFC 4533. The structure for this control is : syncRequestValue ::= SEQUENCE { mode ENUMERATED { -- 0 unused refreshOnly (1), -- 2 reserved refreshAndPersist (3) }, cookie syncCookie OPTIONAL, reloadHint BOOLEAN DEFAULT FALSE } This control OID is 1.3.6.1.4.1.4203.1.9.1.1

Version:

$Rev: $

Author:

Apache Directory Project

See Also:

RFC 4533, Serialized Form

Field Summary

static java.lang.String

CONTROL_OID This control OID

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

SyncRequestValueControl()

Method Summary

byte[]	getCookie()
byte[]	getEncodedValue()
java.lang.String	getID() Retrieves the object identifier assigned for the LDAP control.
SynchronizationModeEnum	getMode()
boolean	isReloadHint()
void	setCookie(byte[] cookie)
void	setMode(SynchronizationModeEnum mode)
void	setReloadHint(boolean reloadHint)

Methods inherited from class org.apache.directory.shared.ldap.message.control.InternalAbstractControl

isCritical, setCritical, setID

Methods inherited from class java.lang.Object

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

Field Detail

CONTROL_OID

public static final java.lang.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 mode to set

getCookie

public byte[] getCookie()

Returns:

the cookie

setCookie

public void setCookie(byte[] cookie)

Parameters:

syncCookie - the syncCookie to set

isReloadHint

public boolean isReloadHint()

Returns:

the reloadHint

setReloadHint

public void setReloadHint(boolean reloadHint)

Parameters:

reloadHint - the reloadHint to set

getID

public java.lang.String getID()

Retrieves the object identifier assigned for the LDAP control.

Specified by:

getID in interface javax.naming.ldap.Control

Overrides:

getID in class InternalAbstractControl

Returns:

The non-null object identifier string.

getEncodedValue

public byte[] getEncodedValue()