SyncInfoMessage (Ldaptive 1.2.4 API)

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`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.

Field Summary

Fields
Modifier and Type	Field and Description
`private byte[]`	`cookie` server generated cookie.
`private Set<UUID>`	`entryUuids` entry uuids.
`private static int`	`HASH_CODE_SEED` hash value seed.
`private SyncInfoMessage.Type`	`messageType` message type.
`static String`	`OID` OID of this response.
`private boolean`	`refreshDeletes` refresh deletes.
`private boolean`	`refreshDone` refresh done.

Constructor Summary

Constructors
Constructor and Description
`SyncInfoMessage()` Default constructor.
`SyncInfoMessage(ResponseControl[] responseControls, int id)` Creates a new sync info message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decode(byte[] berValue)` Initializes this response with the supplied BER encoded data.
`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.
`int`	`hashCode()`
`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
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
  - HASH_CODE_SEED
```
private static final int HASH_CODE_SEED
```
    hash value seed.
    
    See Also:
    
    Constant Field Values
  - 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
```
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)
```
    Description copied from interface: IntermediateResponse
    
    Initializes this response with the supplied BER encoded data.
    
    Parameters:
    
    berValue - BER encoded response value
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SyncInfoMessage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.intermediate.AbstractIntermediateResponse

Methods inherited from class java.lang.Object

Field Detail

OID

HASH_CODE_SEED

messageType

cookie

refreshDone

refreshDeletes

entryUuids

Constructor Detail

SyncInfoMessage

SyncInfoMessage

Method Detail

getMessageType

setMessageType

getCookie

setCookie

getRefreshDone

setRefreshDone

getRefreshDeletes

setRefreshDeletes

getEntryUuids

setEntryUuids

decode

equals

hashCode

toString