org.ldaptive.control

Class SyncStateControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.control.SyncStateControl

All Implemented Interfaces:

Control, ResponseControl

public class SyncStateControl
extends AbstractControl
implements ResponseControl

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

     syncStateValue ::= SEQUENCE {
         state ENUMERATED {
             present (0),
             add (1),
             modify (2),
             delete (3)
         },
         entryUUID syncUUID,
         cookie    syncCookie OPTIONAL
     }
 

Author:

Middleware Services

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncStateControl.State Types of states.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OID OID of this control.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor and Description
SyncStateControl() Default constructor.
SyncStateControl(boolean critical) Creates a new sync state control.
SyncStateControl(SyncStateControl.State state) Creates a new sync state control.
SyncStateControl(SyncStateControl.State state, boolean critical) Creates a new sync state control.
SyncStateControl(SyncStateControl.State state, UUID uuid, boolean critical) Creates a new sync state control.
SyncStateControl(SyncStateControl.State state, UUID uuid, byte[] value, boolean critical) Creates a new sync state control.

Method Summary

Modifier and Type	Method and Description
void	decode(byte[] berValue) Initializes this response control with the supplied BER encoded data.
byte[]	getCookie() Returns the sync state cookie.
UUID	getEntryUuid() Returns the entry uuid.
SyncStateControl.State	getSyncState() Returns the sync state.
int	hashCode() Returns the hash code for this object.
void	setCookie(byte[] value) Sets the sync state cookie.
void	setEntryUuid(UUID uuid) Sets the entry uuid.
void	setSyncState(SyncStateControl.State state) Sets the sync state.
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

SyncStateControl

public SyncStateControl()

Default constructor.

SyncStateControl

public SyncStateControl(boolean critical)

Creates a new sync state control.

Parameters:

critical - whether this control is critical

SyncStateControl

public SyncStateControl(SyncStateControl.State state)

Creates a new sync state control.

Parameters:

state - sync state

SyncStateControl

public SyncStateControl(SyncStateControl.State state,
                        boolean critical)

Creates a new sync state control.

Parameters:

state - sync state

critical - whether this control is critical

SyncStateControl

public SyncStateControl(SyncStateControl.State state,
                        UUID uuid,
                        boolean critical)

Creates a new sync state control.

Parameters:

state - sync state

uuid - sync entry uuid

critical - whether this control is critical

SyncStateControl

public SyncStateControl(SyncStateControl.State state,
                        UUID uuid,
                        byte[] value,
                        boolean critical)

Creates a new sync state control.

Parameters:

state - sync state

uuid - sync entry uuid

value - sync state cookie

critical - whether this control is critical

Method Detail

getSyncState

public SyncStateControl.State getSyncState()

Returns the sync state.

Returns:

sync state

setSyncState

public void setSyncState(SyncStateControl.State state)

Sets the sync state.

Parameters:

state - sync state

getEntryUuid

public UUID getEntryUuid()

Returns the entry uuid.

Returns:

entry uuid

setEntryUuid

public void setEntryUuid(UUID uuid)

Sets the entry uuid.

Parameters:

uuid - entry uuid

getCookie

public byte[] getCookie()

Returns the sync state cookie.

Returns:

sync state cookie

setCookie

public void setCookie(byte[] value)

Sets the sync state cookie.

Parameters:

value - sync state cookie

hashCode

public int hashCode()

Description copied from class: AbstractControl

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

decode

public void decode(byte[] berValue)

Description copied from interface: ResponseControl

Initializes this response control with the supplied BER encoded data.

Specified by:

decode in interface ResponseControl

Parameters:

berValue - BER encoded response control