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
    }
 

Version:

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

Author:

Middleware Services

Field Summary

static String

OID OID of this control.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

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

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.
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

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()

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)

Initializes this response control with the supplied BER encoded data.

Specified by:

decode in interface ResponseControl

Parameters:

berValue - BER encoded response control