org.ldaptive.intermediate
Class SyncInfoMessage

java.lang.Object
  org.ldaptive.intermediate.AbstractIntermediateResponse
      org.ldaptive.intermediate.SyncInfoMessage

All Implemented Interfaces:

IntermediateResponse, Message<ResponseControl>, ResponseMessage

public class SyncInfoMessage
extends AbstractIntermediateResponse

Intermediate response message for ldap content synchronization. See RFC 4533. Message is defined as:

     syncInfoValue ::= CHOICE {
         newcookie      [0] syncCookie,
         refreshDelete  [1] SEQUENCE {
             cookie         syncCookie OPTIONAL,
             refreshDone    BOOLEAN DEFAULT TRUE
         },
         refreshPresent [2] SEQUENCE {
             cookie         syncCookie OPTIONAL,
             refreshDone    BOOLEAN DEFAULT TRUE
         },
         syncIdSet      [3] SEQUENCE {
             cookie         syncCookie OPTIONAL,
             refreshDeletes BOOLEAN DEFAULT FALSE,
             syncUUIDs      SET OF syncUUID
         }
     }
 

Version:

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

Author:

Middleware Services

Nested Class Summary

static class

SyncInfoMessage.Type Types of request modes.

Field Summary

static String

OID OID of this response.

Constructor Summary

SyncInfoMessage()
Default constructor.

SyncInfoMessage(ResponseControl[] responseControls, int id)
Creates a new sync info message.

Method Summary

void	decode(byte[] berValue) Initializes this response with the supplied BER encoded data.
byte[]	getCookie() Returns the sync request cookie.
Set<UUID>	getEntryUuids() Returns the entry uuids.
SyncInfoMessage.Type	getMessageType() Returns the message type.
boolean	getRefreshDeletes() Returns whether to refresh deletes.
boolean	getRefreshDone() Returns whether refreshes are done.
int	hashCode() Returns the hash code for this object.
void	setCookie(byte[] value) Sets the sync request cookie.
void	setEntryUuids(Set<UUID> uuids) Sets the entry uuids.
void	setMessageType(SyncInfoMessage.Type type) Sets the message type.
void	setRefreshDeletes(boolean b) Sets whether to refresh deletes.
void	setRefreshDone(boolean b) Sets whether refreshes are done.
String	toString()

Methods inherited from class org.ldaptive.intermediate.AbstractIntermediateResponse

equals, getControl, getControls, getMessageId, getOID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OID

public static final String OID

OID of this response.

See Also:

Constant Field Values

Constructor Detail

SyncInfoMessage

public SyncInfoMessage()

Default constructor.

SyncInfoMessage

public SyncInfoMessage(ResponseControl[] responseControls,
                       int id)

Creates a new sync info message.

Parameters:

responseControls - for this message

id - message id

Method Detail

getMessageType

public SyncInfoMessage.Type getMessageType()

Returns the message type.

Returns:

message type

setMessageType

public void setMessageType(SyncInfoMessage.Type type)

Sets the message type.

Parameters:

type - message type

getCookie

public byte[] getCookie()

Returns the sync request cookie.

Returns:

sync request cookie

setCookie

public void setCookie(byte[] value)

Sets the sync request cookie.

Parameters:

value - sync request cookie

getRefreshDone

public boolean getRefreshDone()

Returns whether refreshes are done.

Returns:

refresh done

setRefreshDone

public void setRefreshDone(boolean b)

Sets whether refreshes are done.

Parameters:

b - refresh done

getRefreshDeletes

public boolean getRefreshDeletes()

Returns whether to refresh deletes.

Returns:

whether to refresh deletes

setRefreshDeletes

public void setRefreshDeletes(boolean b)

Sets whether to refresh deletes.

Parameters:

b - whether to refresh deletes

getEntryUuids

public Set<UUID> getEntryUuids()

Returns the entry uuids.

Returns:

entry uuids

setEntryUuids

public void setEntryUuids(Set<UUID> uuids)

Sets the entry uuids.

Parameters:

uuids - entry uuids

decode

public void decode(byte[] berValue)

Initializes this response with the supplied BER encoded data.

Parameters:

berValue - BER encoded response value

hashCode

public int hashCode()

Returns the hash code for this object.

Specified by:

hashCode in class AbstractIntermediateResponse

Returns:

hash code

toString

public String toString()

Overrides:

toString in class Object