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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SyncInfoMessage.Builder`
`private static class`	`SyncInfoMessage.NewCookieHandler`	Parse handler implementation for new cookie.
`private static class`	`SyncInfoMessage.RefreshDeleteCookieHandler`	Parse handler implementation for refresh delete cookie.
`private static class`	`SyncInfoMessage.RefreshDeleteDoneHandler`	Parse handler implementation for refresh delete done.
`private static class`	`SyncInfoMessage.RefreshDeleteHandler`	Parse handler implementation for refresh delete.
`private static class`	`SyncInfoMessage.RefreshPresentCookieHandler`	Parse handler implementation for refresh present cookie.
`private static class`	`SyncInfoMessage.RefreshPresentDoneHandler`	Parse handler implementation for refresh present done.
`private static class`	`SyncInfoMessage.RefreshPresentHandler`	Parse handler implementation for refresh present.
`private static class`	`SyncInfoMessage.SyncIdSetCookieHandler`	Parse handler implementation for sync id set cookie.
`private static class`	`SyncInfoMessage.SyncIdSetDeletesHandler`	Parse handler implementation for sync id set deletes.
`private static class`	`SyncInfoMessage.SyncIdSetHandler`	Parse handler implementation for sync id set.
`private static class`	`SyncInfoMessage.SyncIdSetUuidsHandler`	Parse handler implementation for sync id set uuids.
`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
`private byte[]`	`cookie`	server generated cookie.
`private Set<UUID>`	`entryUuids`	entry uuids.
`private static int`	`HASH_CODE_SEED`	hash code seed.
`private SyncInfoMessage.Type`	`messageType`	message type.
`private static DERPath`	`NEW_COOKIE_PATH`	DER path to new cookie.
`static String`	`OID`	OID of this response.
`private static DERPath`	`REFRESH_DELETE_COOKIE_PATH`	DER path to refresh delete cookie.
`private static DERPath`	`REFRESH_DELETE_DONE_PATH`	DER path to refresh delete done.
`private static DERPath`	`REFRESH_DELETE_PATH`	DER path to refresh delete.
`private static DERPath`	`REFRESH_PRESENT_COOKIE_PATH`	DER path to refresh present cookie.
`private static DERPath`	`REFRESH_PRESENT_DONE_PATH`	DER path to refresh present done.
`private static DERPath`	`REFRESH_PRESENT_PATH`	DER path to refresh present.
`private boolean`	`refreshDeletes`	refresh deletes.
`private boolean`	`refreshDone`	refresh done.
`private static DERPath`	`SYNC_ID_SET_COOKIE_PATH`	DER path to sync ID set cookie.
`private static DERPath`	`SYNC_ID_SET_DELETES_PATH`	DER path to sync ID set deletes.
`private static DERPath`	`SYNC_ID_SET_PATH`	DER path to sync ID set.
`private static DERPath`	`SYNC_ID_SET_UUIDS_PATH`	DER path to sync ID set UUIDS.

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addEntryUuids(UUID... uuids)`	Adds the supplied UUIDs to this message.
`static SyncInfoMessage.Builder`	`builder()`	Creates a builder for this class.
`boolean`	`equals(Object o)`
`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.
`protected ParseHandler`	`getResponseValueParseHandler()`
`int`	`hashCode()`	Returns the hash code for this object.
`void`	`setCookie(byte[] value)`	Sets the sync request cookie.
`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.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 String OID
```
    OID of this response.
    
    See Also:
    
    Constant Field Values
  - HASH_CODE_SEED
```
private static final int HASH_CODE_SEED
```
    hash code seed.
    
    See Also:
    
    Constant Field Values
  - NEW_COOKIE_PATH
```
private static final DERPath NEW_COOKIE_PATH
```
    DER path to new cookie.
  - REFRESH_DELETE_PATH
```
private static final DERPath REFRESH_DELETE_PATH
```
    DER path to refresh delete.
  - REFRESH_DELETE_COOKIE_PATH
```
private static final DERPath REFRESH_DELETE_COOKIE_PATH
```
    DER path to refresh delete cookie.
  - REFRESH_DELETE_DONE_PATH
```
private static final DERPath REFRESH_DELETE_DONE_PATH
```
    DER path to refresh delete done.
  - REFRESH_PRESENT_PATH
```
private static final DERPath REFRESH_PRESENT_PATH
```
    DER path to refresh present.
  - REFRESH_PRESENT_COOKIE_PATH
```
private static final DERPath REFRESH_PRESENT_COOKIE_PATH
```
    DER path to refresh present cookie.
  - REFRESH_PRESENT_DONE_PATH
```
private static final DERPath REFRESH_PRESENT_DONE_PATH
```
    DER path to refresh present done.
  - SYNC_ID_SET_PATH
```
private static final DERPath SYNC_ID_SET_PATH
```
    DER path to sync ID set.
  - SYNC_ID_SET_COOKIE_PATH
```
private static final DERPath SYNC_ID_SET_COOKIE_PATH
```
    DER path to sync ID set cookie.
  - SYNC_ID_SET_DELETES_PATH
```
private static final DERPath SYNC_ID_SET_DELETES_PATH
```
    DER path to sync ID set deletes.
  - SYNC_ID_SET_UUIDS_PATH
```
private static final DERPath SYNC_ID_SET_UUIDS_PATH
```
    DER path to sync ID set UUIDS.
  - messageType
```
private SyncInfoMessage.Type messageType
```
    message type.
  - cookie
```
private byte[] cookie
```
    server generated cookie.
  - refreshDone
```
private boolean refreshDone
```
    refresh done.
  - refreshDeletes
```
private boolean refreshDeletes
```
    refresh deletes.
  - entryUuids
```
private Set<UUID> entryUuids
```
    entry uuids.
- 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()
```
  - 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
  - addEntryUuids
```
public void addEntryUuids(UUID... uuids)
```
    Adds the supplied UUIDs to this message.
    
    Parameters:
    
    uuids - to add
  - equals
```
public boolean equals(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 String toString()
```
    Overrides:
    
    toString in class IntermediateResponse
  - builder
```
public static SyncInfoMessage.Builder builder()
```
    Creates a builder for this class.
    
    Returns:
    
    new builder

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

Class SyncInfoMessage

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.ldaptive.extended.IntermediateResponse

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.extended.IntermediateResponse

Methods inherited from class org.ldaptive.AbstractMessage

Methods inherited from class java.lang.Object

Methods inherited from interface org.ldaptive.Message

Field Detail

OID

HASH_CODE_SEED

NEW_COOKIE_PATH

REFRESH_DELETE_PATH

REFRESH_DELETE_COOKIE_PATH

REFRESH_DELETE_DONE_PATH

REFRESH_PRESENT_PATH

REFRESH_PRESENT_COOKIE_PATH

REFRESH_PRESENT_DONE_PATH

SYNC_ID_SET_PATH

SYNC_ID_SET_COOKIE_PATH

SYNC_ID_SET_DELETES_PATH

SYNC_ID_SET_UUIDS_PATH

messageType

cookie

refreshDone

refreshDeletes

entryUuids

Constructor Detail

SyncInfoMessage

SyncInfoMessage

Method Detail

getResponseValueParseHandler

getMessageType

setMessageType

getCookie

setCookie

getRefreshDone

setRefreshDone

getRefreshDeletes

setRefreshDeletes

getEntryUuids

addEntryUuids

equals

hashCode

toString

builder