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

All Superinterfaces:

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

All Known Implementing Classes:

SyncStateValueImpl

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

A syncStateValue object, as defined in RFC 4533 :

 2.3.  Sync State Control

    The Sync State Control is an LDAP Control [RFC4511] where the
    controlType is the object identifier 1.3.6.1.4.1.4203.1.9.1.2 and the
    controlValue, an OCTET STRING, contains a BER-encoded syncStateValue.
    The criticality is FALSE.

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

    The Sync State Control is only applicable to SearchResultEntry and
    SearchResultReference Messages.
 

Author:

Apache Directory Project

Field Summary

static String

OID This control OID

Method Summary

byte[]	getCookie()
byte[]	getEntryUUID()
SyncStateTypeEnum	getSyncStateType()
void	setCookie(byte[] cookie)
void	setEntryUUID(byte[] entryUUID) set the entryUUID
void	setSyncStateType(SyncStateTypeEnum syncStateType) set the syncState's type

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 - the cookie to set

getSyncStateType

SyncStateTypeEnum getSyncStateType()

Returns:

the syncState's type

setSyncStateType

void setSyncStateType(SyncStateTypeEnum syncStateType)

set the syncState's type

Parameters:

syncStateType - the syncState's type

getEntryUUID

byte[] getEntryUUID()

Returns:

the entryUUID

setEntryUUID

void setEntryUUID(byte[] entryUUID)

set the entryUUID

Parameters:

entryUUID - the entryUUID