org.ldaptive.control

Class SyncDoneControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.control.SyncDoneControl

All Implemented Interfaces:

Control, ResponseControl

public class SyncDoneControl
extends AbstractControl
implements ResponseControl

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

    syncDoneValue ::= SEQUENCE {
        cookie          syncCookie OPTIONAL,
        refreshDeletes  BOOLEAN DEFAULT FALSE
    }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SyncDoneControl.CookieHandler Parse handler implementation for the cookie.
private static class	SyncDoneControl.RefreshDeletesHandler Parse handler implementation for the refresh deletes flag.

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	cookie server generated cookie.
private static int	HASH_CODE_SEED hash code seed.
static java.lang.String	OID OID of this control.
private boolean	refreshDeletes refresh deletes.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor and Description
SyncDoneControl() Default constructor.
SyncDoneControl(boolean critical) Creates a new sync done control.
SyncDoneControl(byte[] value) Creates a new sync done control.
SyncDoneControl(byte[] value, boolean critical) Creates a new sync done control.
SyncDoneControl(byte[] value, boolean refresh, boolean critical) Creates a new sync done 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 done cookie.
boolean	getRefreshDeletes() Returns whether to refresh deletes.
int	hashCode() Returns the hash code for this object.
void	setCookie(byte[] value) Sets the sync done cookie.
void	setRefreshDeletes(boolean b) Sets whether to refresh deletes.
java.lang.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 java.lang.String OID

OID of this control.

See Also:

Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

cookie

private byte[] cookie

server generated cookie.

refreshDeletes

private boolean refreshDeletes

refresh deletes.

Constructor Detail

SyncDoneControl

public SyncDoneControl()

Default constructor.

SyncDoneControl

public SyncDoneControl(boolean critical)

Creates a new sync done control.

Parameters:

critical - whether this control is critical

SyncDoneControl

public SyncDoneControl(byte[] value)

Creates a new sync done control.

Parameters:

value - sync done cookie

SyncDoneControl

public SyncDoneControl(byte[] value,
                       boolean critical)

Creates a new sync done control.

Parameters:

value - sync done cookie

critical - whether this control is critical

SyncDoneControl

public SyncDoneControl(byte[] value,
                       boolean refresh,
                       boolean critical)

Creates a new sync done control.

Parameters:

value - sync done cookie

refresh - whether to refresh deletes

critical - whether this control is critical

Method Detail

getCookie

public byte[] getCookie()

Returns the sync done cookie.

Returns:

sync done cookie

setCookie

public void setCookie(byte[] value)

Sets the sync done cookie.

Parameters:

value - sync done cookie

getRefreshDeletes

public boolean getRefreshDeletes()

Returns whether to refresh deletes.

Returns:

refresh deletes

setRefreshDeletes

public void setRefreshDeletes(boolean b)

Sets whether to refresh deletes.

Parameters:

b - refresh deletes

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 java.lang.String toString()

Overrides:

toString in class java.lang.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