InstallSnapshot (JSimpleDB Raft Key/Value Store 2.4.1 API)

java.lang.Object
- org.jsimpledb.kv.raft.msg.Message
- - org.jsimpledb.kv.raft.msg.InstallSnapshot

```
public class InstallSnapshot
extends Message
```
Sent from leader to follower to with a chunk of key/value pairs that will wholesale replace the follower's key/value store.

Constructor Summary

Constructors
Constructor and Description
`InstallSnapshot(int clusterId, String senderId, String recipientId, long term, long snapshotTerm, long snapshotIndex, long pairIndex, Map<String,String> snapshotConfig, boolean lastChunk, ByteBuffer data)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`calculateSize()` Calculate an upper bound on the number of bytes required by `writeTo()`.
`ByteBuffer`	`getData()`
`long`	`getPairIndex()`
`Map<String,String>`	`getSnapshotConfig()`
`long`	`getSnapshotIndex()`
`long`	`getSnapshotTerm()`
`boolean`	`isLastChunk()`
`boolean`	`isLeaderMessage()` Determine whether this message is only sent by leaders.
`String`	`toString()`
`void`	`visit(MessageSwitch handler)` Apply the visitor pattern based on this instance's type.
`void`	`writeTo(ByteBuffer dest)` Serialize this instance into the given buffer.

Methods inherited from class org.jsimpledb.kv.raft.msg.Message
calculateSize, calculateSize, calculateSize, decode, encode, getBoolean, getByteBuffer, getClusterId, getReads, getRecipientId, getSenderId, getString, getTerm, getTimestamp, getWrites, putBoolean, putByteBuffer, putReads, putString, putTimestamp, putWrites

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InstallSnapshot
```
public InstallSnapshot(int clusterId,
               String senderId,
               String recipientId,
               long term,
               long snapshotTerm,
               long snapshotIndex,
               long pairIndex,
               Map<String,String> snapshotConfig,
               boolean lastChunk,
               ByteBuffer data)
```
    Constructor.
    
    Parameters:
    clusterId - cluster ID
    senderId - identity of sender
    recipientId - identity of recipient
    term - sender's current term
    snapshotTerm - term of the last log entry in the snapshot
    snapshotIndex - index of the last log entry in the snapshot
    snapshotConfig - cluster config of the last log entry in the snapshot (first pairIndex only)
    pairIndex - index of the first key/value pair in this chunk
    lastChunk - true if this is the last chunk in the snapshot
    data - encoded key/value pairs
- Method Detail
  - getSnapshotTerm
```
public long getSnapshotTerm()
```
  - getSnapshotIndex
```
public long getSnapshotIndex()
```
  - getSnapshotConfig
```
public Map<String,String> getSnapshotConfig()
```
  - getPairIndex
```
public long getPairIndex()
```
  - isLastChunk
```
public boolean isLastChunk()
```
  - getData
```
public ByteBuffer getData()
```
  - isLeaderMessage
```
public boolean isLeaderMessage()
```
    Description copied from class: Message
    
    Determine whether this message is only sent by leaders.
    
    Overrides:
    
    isLeaderMessage in class Message
    
    Returns:
    true if receipt of this message implies sender is a leader
  - visit
```
public void visit(MessageSwitch handler)
```
    Description copied from class: Message
    
    Apply the visitor pattern based on this instance's type.
    
    Specified by:
    
    visit in class Message
    
    Parameters:
    handler - target for visit
  - writeTo
```
public void writeTo(ByteBuffer dest)
```
    Description copied from class: Message
    
    Serialize this instance into the given buffer.
    
    Overrides:
    
    writeTo in class Message
    
    Parameters:
    dest - destination for encoded data
  - calculateSize
```
protected int calculateSize()
```
    Description copied from class: Message
    
    Calculate an upper bound on the number of bytes required by writeTo().
    
    Overrides:
    
    calculateSize in class Message
    
    Returns:
    an upper bound on the number of encoded bytes
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class Message

Class InstallSnapshot

Constructor Summary

Method Summary

Methods inherited from class org.jsimpledb.kv.raft.msg.Message

Methods inherited from class java.lang.Object

Constructor Detail

InstallSnapshot

Method Detail

getSnapshotTerm

getSnapshotIndex

getSnapshotConfig

getPairIndex

isLastChunk

getData

isLeaderMessage

visit

writeTo

calculateSize

toString