Package org.ldaptive.control

Class SyncDoneControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.control.AbstractResponseControl

org.ldaptive.control.SyncDoneControl

All Implemented Interfaces:

Control, ResponseControl, Freezable

public class SyncDoneControl
extends AbstractResponseControl

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	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	Description
private byte[]	cookie	server generated cookie.
private static final int	HASH_CODE_SEED	hash code seed.
static final String	OID	OID of this control.
private boolean	refreshDeletes	refresh deletes.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor	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	Description
void	decode(DERBuffer encoded)	Initializes this response control with the supplied BER encoded data.
boolean	equals(Object o)
byte[]	getCookie()	Returns the sync done cookie.
boolean	getRefreshDeletes()	Returns whether to refresh deletes.
int	hashCode()	Returns the hash code for this object.
String	toString()

Methods inherited from class org.ldaptive.control.AbstractResponseControl

assertMutable, freeze, freezeAndAssertMutable, isFrozen

Methods inherited from class org.ldaptive.control.AbstractControl

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 Details

OID

public static final 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 Details

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 Details

getCookie

public byte[] getCookie()

Returns the sync done cookie.

Returns:

sync done cookie

getRefreshDeletes

public boolean getRefreshDeletes()

Returns whether to refresh deletes.

Returns:

refresh deletes

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractControl

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 AbstractControl

decode

public void decode(DERBuffer encoded)

Description copied from interface: ResponseControl

Initializes this response control with the supplied BER encoded data.

Parameters:

encoded - BER encoded response control