org.apache.directory.api.ldap.extras.controls
Interface SyncDoneValue

All Superinterfaces:

org.apache.directory.api.ldap.model.message.Control

All Known Implementing Classes:

SyncDoneValueImpl

public interface SyncDoneValue
extends org.apache.directory.api.ldap.model.message.Control

A syncDoneValue object as described in rfc4533 :

 2.4.  Sync Done Control

    The Sync Done Control is an LDAP Control [RFC4511] where the
    controlType is the object identifier 1.3.6.1.4.1.4203.1.9.1.3 and the
    controlValue contains a BER-encoded syncDoneValue.  The criticality
    is FALSE (and hence absent).

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

    The Sync Done Control is only applicable to the SearchResultDone
    Message.
 

Author:

Apache Directory Project

Field Summary

static String

OID This control OID

Method Summary

byte[]	getCookie()
boolean	isRefreshDeletes()
void	setCookie(byte[] cookie)
void	setRefreshDeletes(boolean refreshDeletes)

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control

getOid, isCritical, setCritical

Field Detail

OID

static final String OID

This control OID

See Also:

Constant Field Values

Method Detail

getCookie

byte[] getCookie()

Returns:

the cookie

setCookie

void setCookie(byte[] cookie)

Parameters:

cookie - cookie to be set

isRefreshDeletes

boolean isRefreshDeletes()

Returns:

true, if refreshDeletes flag is set, false otherwise

setRefreshDeletes

void setRefreshDeletes(boolean refreshDeletes)

Parameters:

refreshDeletes - set the refreshDeletes flag