org.apache.directory.shared.ldap.message.control.replication
Class SyncStateValueControl

java.lang.Object
  extended by org.apache.directory.shared.ldap.message.control.InternalAbstractControl
      extended by org.apache.directory.shared.ldap.message.control.replication.SyncStateValueControl
All Implemented Interfaces:
java.io.Serializable, javax.naming.ldap.Control, InternalControl

public class SyncStateValueControl
extends InternalAbstractControl

This class implements the SyncStateValue Control, as described by RFC 4533. The structure for this control is : syncStateValue ::= SEQUENCE { state ENUMERATED { present (0), add (1), modify (2), delete (3) }, entryUUID syncUUID, cookie syncCookie OPTIONAL } This control OID is 1.3.6.1.4.1.4203.1.9.1.2

Version:
$Rev: $
Author:
Apache Directory Project
See Also:
RFC 4533, Serialized Form

Field Summary
static java.lang.String CONTROL_OID
          This control OID
 
Fields inherited from interface javax.naming.ldap.Control
CRITICAL, NONCRITICAL
 
Constructor Summary
SyncStateValueControl()
           
 
Method Summary
 byte[] getCookie()
           
 byte[] getEncodedValue()
          
 byte[] getEntryUUID()
           
 java.lang.String getID()
          Retrieves the object identifier assigned for the LDAP control.
 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 class org.apache.directory.shared.ldap.message.control.InternalAbstractControl
isCritical, setCritical, setID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTROL_OID

public static final java.lang.String CONTROL_OID
This control OID

See Also:
Constant Field Values
Constructor Detail

SyncStateValueControl

public SyncStateValueControl()
Method Detail

getSyncStateType

public SyncStateTypeEnum getSyncStateType()
Returns:
the syncState's type

setSyncStateType

public void setSyncStateType(SyncStateTypeEnum syncStateType)
set the syncState's type

Parameters:
syncStateType - the syncState's type

getEntryUUID

public byte[] getEntryUUID()
Returns:
the entryUUID

setEntryUUID

public void setEntryUUID(byte[] entryUUID)
set the entryUUID

Parameters:
entryUUID - the entryUUID

getCookie

public byte[] getCookie()
Returns:
the cookie

setCookie

public void setCookie(byte[] cookie)
Parameters:
syncCookie - the syncCookie to set

getID

public java.lang.String getID()
Retrieves the object identifier assigned for the LDAP control.

Specified by:
getID in interface javax.naming.ldap.Control
Overrides:
getID in class InternalAbstractControl
Returns:
The non-null object identifier string.

getEncodedValue

public byte[] getEncodedValue()



Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.