org.ldaptive.control
Class SyncRequestControl

java.lang.Object
  org.ldaptive.control.AbstractControl
      org.ldaptive.control.SyncRequestControl

All Implemented Interfaces:

Control, RequestControl

public class SyncRequestControl
extends AbstractControl
implements RequestControl

Request control for ldap content synchronization. See RFC 4533. Control is defined as:

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

Version:

$Revision: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

Author:

Middleware Services

Nested Class Summary

static class

SyncRequestControl.Mode Types of request modes.

Field Summary

static String

OID OID of this control.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

SyncRequestControl()
Default constructor.

SyncRequestControl(SyncRequestControl.Mode mode)
Creates a new sync request control.

SyncRequestControl(SyncRequestControl.Mode mode, boolean critical)
Creates a new sync request control.

SyncRequestControl(SyncRequestControl.Mode mode, byte[] value, boolean critical)
Creates a new sync request control.

SyncRequestControl(SyncRequestControl.Mode mode, byte[] value, boolean hint, boolean critical)
Creates a new sync request control.

Method Summary

byte[]	encode() Provides the BER encoding of this control.
byte[]	getCookie() Returns the sync request cookie.
boolean	getReloadHint() Returns the reload hint.
SyncRequestControl.Mode	getRequestMode() Returns the request mode.
int	hashCode() Returns the hash code for this object.
void	setCookie(byte[] value) Sets the sync request cookie.
void	setReloadHint(boolean b) Sets the reload hint.
void	setRequestMode(SyncRequestControl.Mode mode) Sets the request mode.
String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

equals, getCriticality, getOID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.control.Control

getCriticality, getOID

Field Detail

OID

public static final String OID

OID of this control.

See Also:

Constant Field Values

Constructor Detail

SyncRequestControl

public SyncRequestControl()

Default constructor.

SyncRequestControl

public SyncRequestControl(SyncRequestControl.Mode mode)

Creates a new sync request control.

Parameters:

mode - request mode

SyncRequestControl

public SyncRequestControl(SyncRequestControl.Mode mode,
                          boolean critical)

Creates a new sync request control.

Parameters:

mode - request mode

critical - whether this control is critical

SyncRequestControl

public SyncRequestControl(SyncRequestControl.Mode mode,
                          byte[] value,
                          boolean critical)

Creates a new sync request control.

Parameters:

mode - request mode

value - sync request cookie

critical - whether this control is critical

SyncRequestControl

public SyncRequestControl(SyncRequestControl.Mode mode,
                          byte[] value,
                          boolean hint,
                          boolean critical)

Creates a new sync request control.

Parameters:

mode - request mode

value - sync request cookie

hint - reload hint

critical - whether this control is critical

Method Detail

getRequestMode

public SyncRequestControl.Mode getRequestMode()

Returns the request mode.

Returns:

request mode

setRequestMode

public void setRequestMode(SyncRequestControl.Mode mode)

Sets the request mode.

Parameters:

mode - request mode

getCookie

public byte[] getCookie()

Returns the sync request cookie.

Returns:

sync request cookie

setCookie

public void setCookie(byte[] value)

Sets the sync request cookie.

Parameters:

value - sync request cookie

getReloadHint

public boolean getReloadHint()

Returns the reload hint.

Returns:

reload hint

setReloadHint

public void setReloadHint(boolean b)

Sets the reload hint.

Parameters:

b - reload hint

hashCode

public int hashCode()

Returns the hash code for this object.

Specified by:

hashCode in class AbstractControl

Returns:

hash code

toString

public String toString()

Overrides:

toString in class Object

encode

public byte[] encode()

Provides the BER encoding of this control.

Specified by:

encode in interface RequestControl

Returns:

BER encoded request control