RaftIntegration (Hazelcast Root 3.12.12 API)

```
public interface RaftIntegration
```
Integration abstraction between Raft state machine and the underlying platform which is responsible for task/operation execution & scheduling, message transportation and failure detection.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`execute(Runnable task)` Executes the task on underlying task execution mechanism.
`Object`	`getAppendedEntryOnLeaderElection()` Returns the entry to be appended if the no-op entry append on leader election feature is enabled.
`ILogger`	`getLogger(String name)` Returns an `ILogger` instance for given name.
`boolean`	`isReachable(Endpoint endpoint)` Returns true if the endpoint is reachable by the time this method is called, false otherwise.
`boolean`	`isReady()` Returns true if underlying platform is ready to operate, false otherwise.
`SimpleCompletableFuture`	`newCompletableFuture()` Creates a new instance of `SimpleCompletableFuture`.
`void`	`onNodeStatusChange(RaftNodeStatus status)` Called when RaftNode status changes.
`void`	`restoreSnapshot(Object operation, long commitIndex)` Restores the snapshot with the given operation for the given commit index
`Object`	`runOperation(Object operation, long commitIndex)` Executes the operation on underlying operation execution mechanism and returns its return value.
`void`	`schedule(Runnable task, long delay, TimeUnit timeUnit)` Schedules the task on underlying scheduling mechanism.
`boolean`	`send(AppendFailureResponse response, Endpoint target)` Sends the `AppendFailureResponse` to target endpoint to be handled by its `RaftNode.handleAppendResponse(AppendFailureResponse)`.
`boolean`	`send(AppendRequest request, Endpoint target)` Sends the `AppendRequest` to target endpoint to be handled by its `RaftNode.handleAppendRequest(AppendRequest)`.
`boolean`	`send(AppendSuccessResponse response, Endpoint target)` Sends the `AppendSuccessResponse` to target endpoint to be handled by its `RaftNode.handleAppendResponse(AppendSuccessResponse)`.
`boolean`	`send(InstallSnapshot request, Endpoint target)` Sends the `InstallSnapshot` to target endpoint to be handled by its `RaftNode.handleInstallSnapshot(InstallSnapshot)`.
`boolean`	`send(PreVoteRequest request, Endpoint target)` Sends the `PreVoteRequest` to target endpoint to be handled by its `RaftNode.handlePreVoteRequest(PreVoteRequest)`.
`boolean`	`send(PreVoteResponse response, Endpoint target)` Sends the `PreVoteResponse` to target endpoint to be handled by its `RaftNode.handlePreVoteResponse(PreVoteResponse)`.
`boolean`	`send(VoteRequest request, Endpoint target)` Sends the `VoteRequest` to target endpoint to be handled by its `RaftNode.handleVoteRequest(VoteRequest)`.
`boolean`	`send(VoteResponse response, Endpoint target)` Sends the `VoteResponse` to target endpoint to be handled by its `RaftNode.handleVoteResponse(VoteResponse)`.
`Object`	`takeSnapshot(long commitIndex)` Take a snapshot for the given commit index which is the current commit index

- Method Detail
  - getLogger
```
ILogger getLogger(String name)
```
    Returns an ILogger instance for given name.
    
    Parameters:
    
    name - logger name
    
    Returns:
    
    logger instance
  - isReady
```
boolean isReady()
```
    Returns true if underlying platform is ready to operate, false otherwise.
    
    Returns:
    
    true if ready, false otherwise
  - isReachable
```
boolean isReachable(Endpoint endpoint)
```
    Returns true if the endpoint is reachable by the time this method is called, false otherwise.
    
    Parameters:
    
    endpoint - endpoint
    
    Returns:
    
    true if endpoint is reachable, false otherwise
  - send
```
boolean send(PreVoteRequest request,
             Endpoint target)
```
    Sends the PreVoteRequest to target endpoint to be handled by its RaftNode.handlePreVoteRequest(PreVoteRequest).
    
    Returns:
    
    true if request is sent or scheduled to be sent to target, false otherwise
  - send
```
boolean send(PreVoteResponse response,
             Endpoint target)
```
    Sends the PreVoteResponse to target endpoint to be handled by its RaftNode.handlePreVoteResponse(PreVoteResponse).
    
    Returns:
    
    true if response is sent or scheduled to be sent to target, false otherwise
  - send
```
boolean send(VoteRequest request,
             Endpoint target)
```
    Sends the VoteRequest to target endpoint to be handled by its RaftNode.handleVoteRequest(VoteRequest).
    
    Returns:
    
    true if request is sent or scheduled to be sent to target, false otherwise
  - send
```
boolean send(VoteResponse response,
             Endpoint target)
```
    Sends the VoteResponse to target endpoint to be handled by its RaftNode.handleVoteResponse(VoteResponse).
    
    Returns:
    
    true if response is sent or scheduled to be sent to target, false otherwise
  - send
```
boolean send(AppendRequest request,
             Endpoint target)
```
    Sends the AppendRequest to target endpoint to be handled by its RaftNode.handleAppendRequest(AppendRequest).
    
    Returns:
    
    true if request is sent or scheduled to be sent to target, false otherwise
  - send
```
boolean send(AppendSuccessResponse response,
             Endpoint target)
```
    Sends the AppendSuccessResponse to target endpoint to be handled by its RaftNode.handleAppendResponse(AppendSuccessResponse).
    
    Returns:
    
    true if response is sent or scheduled to be sent to target, false otherwise
  - send
```
boolean send(AppendFailureResponse response,
             Endpoint target)
```
    Sends the AppendFailureResponse to target endpoint to be handled by its RaftNode.handleAppendResponse(AppendFailureResponse).
    
    Returns:
    
    true if response is sent or scheduled to be sent to target, false otherwise
  - send
```
boolean send(InstallSnapshot request,
             Endpoint target)
```
    Sends the InstallSnapshot to target endpoint to be handled by its RaftNode.handleInstallSnapshot(InstallSnapshot).
    
    Returns:
    
    true if request is sent or scheduled to be sent to target, false otherwise
  - runOperation
```
Object runOperation(Object operation,
                    long commitIndex)
```
    Executes the operation on underlying operation execution mechanism and returns its return value.
    
    Parameters:
    
    operation - raft operation
    
    commitIndex - commit index
    
    Returns:
    
    operation execution result
  - takeSnapshot
```
Object takeSnapshot(long commitIndex)
```
    Take a snapshot for the given commit index which is the current commit index
    
    Parameters:
    
    commitIndex - commit index
    
    Returns:
    
    snapshot operation to put into the SnapshotEntry
  - restoreSnapshot
```
void restoreSnapshot(Object operation,
                     long commitIndex)
```
    Restores the snapshot with the given operation for the given commit index
    
    Parameters:
    
    operation - snapshot operation provided by takeSnapshot(long)
    
    commitIndex - commit index of the snapshot
  - execute
```
void execute(Runnable task)
```
    Executes the task on underlying task execution mechanism.
    
    Parameters:
    
    task - the task
  - schedule
```
void schedule(Runnable task,
              long delay,
              TimeUnit timeUnit)
```
    Schedules the task on underlying scheduling mechanism.
    
    Parameters:
    
    task - the task
    
    delay - the time from now to delay execution
    
    timeUnit - the time unit of the delay
  - newCompletableFuture
```
SimpleCompletableFuture newCompletableFuture()
```
    Creates a new instance of SimpleCompletableFuture.
    
    Returns:
    
    a new future
  - getAppendedEntryOnLeaderElection
```
Object getAppendedEntryOnLeaderElection()
```
    Returns the entry to be appended if the no-op entry append on leader election feature is enabled.
    See Bug in single-server membership changes post by Diego Ongaro for more info.
  - onNodeStatusChange
```
void onNodeStatusChange(RaftNodeStatus status)
```
    Called when RaftNode status changes.
    
    Parameters:
    
    status - new status

Interface RaftIntegration

Method Summary

Method Detail

getLogger

isReady

isReachable

send

send

send

send

send

send

send

send

runOperation

takeSnapshot

restoreSnapshot

execute

schedule

newCompletableFuture

getAppendedEntryOnLeaderElection

onNodeStatusChange