org.apache.directory.api.ldap.extras.controls
Class SyncRequestValueImpl

java.lang.Object
  org.apache.directory.api.ldap.model.message.controls.AbstractControl
      org.apache.directory.api.ldap.extras.controls.SyncRequestValueImpl

All Implemented Interfaces:

SyncRequestValue, org.apache.directory.api.ldap.model.message.Control

public class SyncRequestValueImpl
extends org.apache.directory.api.ldap.model.message.controls.AbstractControl
implements SyncRequestValue

A syncRequestValue object, as defined in RFC 4533 :

 2.2.  Sync Request Control

    The Sync Request Control is an LDAP Control [RFC4511] where the
    controlType is the object identifier 1.3.6.1.4.1.4203.1.9.1.1 and the
    controlValue, an OCTET STRING, contains a BER-encoded
    syncRequestValue.  The criticality field is either TRUE or FALSE.

       syncRequestValue ::= SEQUENCE {
           mode ENUMERATED {
               -- 0 unused
               refreshOnly       (1),
               -- 2 reserved
               refreshAndPersist (3)
           },
           cookie     syncCookie OPTIONAL,
           reloadHint BOOLEAN DEFAULT FALSE
       }

    The Sync Request Control is only applicable to the SearchRequest
    Message.
 

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.api.ldap.extras.controls.SyncRequestValue

OID

Constructor Summary

SyncRequestValueImpl()
Creates a new instance of SyncRequestValueImpl.

SyncRequestValueImpl(boolean isCritical)
Creates a new instance of SyncRequestValueImpl.

Method Summary

boolean	equals(Object o)
byte[]	getCookie()
SynchronizationModeEnum	getMode()
int	hashCode()
boolean	isReloadHint()
void	setCookie(byte[] cookie)
void	setMode(SynchronizationModeEnum mode)
void	setReloadHint(boolean reloadHint)
String	toString()

Methods inherited from class org.apache.directory.api.ldap.model.message.controls.AbstractControl

getOid, isCritical, setCritical

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

Constructor Detail

SyncRequestValueImpl

public SyncRequestValueImpl()

Creates a new instance of SyncRequestValueImpl.

SyncRequestValueImpl

public SyncRequestValueImpl(boolean isCritical)

Creates a new instance of SyncRequestValueImpl.

Parameters:

isCritical - The critical flag

Method Detail

getCookie

public byte[] getCookie()

Specified by:

getCookie in interface SyncRequestValue

Returns:

the cookie

setCookie

public void setCookie(byte[] cookie)

Specified by:

setCookie in interface SyncRequestValue

Parameters:

cookie - the cookie to set

getMode

public SynchronizationModeEnum getMode()

Specified by:

getMode in interface SyncRequestValue

Returns:

the mode

setMode

public void setMode(SynchronizationModeEnum mode)

Specified by:

setMode in interface SyncRequestValue

isReloadHint

public boolean isReloadHint()

Specified by:

isReloadHint in interface SyncRequestValue

Returns:

the reloadHint

setReloadHint

public void setReloadHint(boolean reloadHint)

Specified by:

setReloadHint in interface SyncRequestValue

Parameters:

reloadHint - the reloadHint to set

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.hashCode()

equals

public boolean equals(Object o)

Overrides:

equals in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.equals(Object)

toString

public String toString()

Overrides:

toString in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.toString()