Package org.ldaptive.extended

Class SyncInfoMessage

java.lang.Object

org.ldaptive.AbstractMessage

org.ldaptive.extended.IntermediateResponse

org.ldaptive.extended.SyncInfoMessage

All Implemented Interfaces:

Message

public class SyncInfoMessage
extends IntermediateResponse

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

   IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
     responseName     [0] LDAPOID OPTIONAL,
     responseValue    [1] OCTET STRING OPTIONAL }


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

Author:

Middleware Services

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyncInfoMessage.Builder
static class	SyncInfoMessage.Type	Types of request modes.

Nested classes/interfaces inherited from class org.ldaptive.extended.IntermediateResponse

IntermediateResponse.ResponseNameHandler, IntermediateResponse.ResponseValueHandler

Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage

AbstractMessage.AbstractBuilder<B,T extends AbstractMessage>, AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	OID	OID of this response.

Fields inherited from class org.ldaptive.extended.IntermediateResponse

PROTOCOL_OP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SyncInfoMessage()	Default constructor.
	SyncInfoMessage(DERBuffer buffer)	Creates a new sync info message.

Method Summary

Modifier and Type	Method	Description
void	addEntryUuids(java.util.UUID... uuids)	Adds the supplied UUIDs to this message.
static SyncInfoMessage.Builder	builder()	Creates a builder for this class.
boolean	equals(java.lang.Object o)
byte[]	getCookie()	Returns the sync request cookie.
java.util.Set<java.util.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.
protected ParseHandler	getResponseValueParseHandler()	Returns the parse handler for the response value.
int	hashCode()	Returns the hash code for this object.
void	setCookie(byte[] value)	Sets the sync request cookie.
void	setEntryUuids(java.util.Set<java.util.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.
java.lang.String	toString()

Methods inherited from class org.ldaptive.extended.IntermediateResponse

getResponseName, getResponseValue, setResponseName, setResponseValue

Methods inherited from class org.ldaptive.AbstractMessage

addControls, copyValues, getControls, getMessageID, setMessageID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.Message

getControl

Field Detail

OID

public static final java.lang.String OID

OID of this response.

See Also:

Constant Field Values

Constructor Detail

SyncInfoMessage

protected SyncInfoMessage()

Default constructor.

SyncInfoMessage

public SyncInfoMessage(DERBuffer buffer)

Creates a new sync info message.

Parameters:

buffer - to decode

Method Detail

getResponseValueParseHandler

protected ParseHandler getResponseValueParseHandler()

Returns the parse handler for the response value.

Overrides:

getResponseValueParseHandler in class IntermediateResponse

Returns:

parse handler

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 java.util.Set<java.util.UUID> getEntryUuids()

Returns the entry uuids.

Returns:

entry uuids

addEntryUuids

public void addEntryUuids(java.util.UUID... uuids)

Adds the supplied UUIDs to this message.

Parameters:

uuids - to add

setEntryUuids

public void setEntryUuids(java.util.Set<java.util.UUID> uuids)

Sets the entry uuids.

Parameters:

uuids - entry uuids

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class IntermediateResponse

hashCode

public int hashCode()

Description copied from class: AbstractMessage

Returns the hash code for this object.

Overrides:

hashCode in class IntermediateResponse

Returns:

hash code

toString

public java.lang.String toString()

Overrides:

toString in class IntermediateResponse

builder

public static SyncInfoMessage.Builder builder()

Creates a builder for this class.

Returns:

new builder