RaftNode (Hazelcast Root 3.12.12 API)

All Known Implementing Classes:

RaftNodeImpl
```
public interface RaftNode
```
RaftNode maintains the state of a member for a specific Raft group and exposes methods to handle external client requests (such as append requests, queries and membership changes) and internal Raft RPCs (voting, append request, snapshot installing etc).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`forceSetTerminatedStatus()` Sets node's status to `RaftNodeStatus.TERMINATED` unconditionally if it's not terminated or stepped down yet.
`Collection<Endpoint>`	`getAppliedMembers()` Returns the currently effective member list of the raft group this node belongs to.
`Collection<Endpoint>`	`getCommittedMembers()` Returns the last committed member list of the raft group this node belongs to.
`CPGroupId`	`getGroupId()` Returns the groupId which this node belongs to.
`Collection<Endpoint>`	`getInitialMembers()` Returns the initial member list of the Raft group this node belongs to.
`Endpoint`	`getLeader()` Returns the known leader endpoint.
`Endpoint`	`getLocalMember()` Returns the Raft endpoint for this node.
`RaftNodeStatus`	`getStatus()` Returns the current status of this node.
`void`	`handleAppendRequest(AppendRequest request)` Handles `AppendRequest` sent by leader.
`void`	`handleAppendResponse(AppendFailureResponse response)` Handles `AppendFailureResponse` for a previously sent append request by this node.
`void`	`handleAppendResponse(AppendSuccessResponse response)` Handles `AppendSuccessResponse` for a previously sent append request by this node.
`void`	`handleInstallSnapshot(InstallSnapshot request)` Handles `InstallSnapshot` sent by leader.
`void`	`handlePreVoteRequest(PreVoteRequest request)` Handles `PreVoteRequest` sent by another follower.
`void`	`handlePreVoteResponse(PreVoteResponse response)` Handles `PreVoteResponse` for a previously sent request by this node.
`void`	`handleVoteRequest(VoteRequest request)` Handles `VoteRequest` sent by a candidate.
`void`	`handleVoteResponse(VoteResponse response)` Handles `VoteResponse` for a previously sent vote request by this node.
`boolean`	`isTerminatedOrSteppedDown()` Returns true if this node is `RaftNodeStatus.TERMINATED` or `RaftNodeStatus.STEPPED_DOWN`, false otherwise.
`ICompletableFuture`	`query(Object operation, QueryPolicy queryPolicy)` Executes the given operation on Raft group depending on the `QueryPolicy`
`ICompletableFuture`	`replicate(Object operation)` Replicates the given operation to the Raft group.
`ICompletableFuture`	`replicateMembershipChange(Endpoint member, MembershipChangeMode mode)` Replicates the membership change to the Raft group.
`ICompletableFuture`	`replicateMembershipChange(Endpoint member, MembershipChangeMode mode, long groupMembersCommitIndex)` Replicates the membership change to the Raft group, if expected members commit index is equal to the actual one stored in Raft state.

- Method Detail
  - getGroupId
```
CPGroupId getGroupId()
```
    Returns the groupId which this node belongs to.
  - getLocalMember
```
Endpoint getLocalMember()
```
    Returns the Raft endpoint for this node.
  - getLeader
```
Endpoint getLeader()
```
    Returns the known leader endpoint. Leader endpoint might be already changed when this method returns.
  - getStatus
```
RaftNodeStatus getStatus()
```
    Returns the current status of this node.
  - getInitialMembers
```
Collection<Endpoint> getInitialMembers()
```
    Returns the initial member list of the Raft group this node belongs to.
  - getCommittedMembers
```
Collection<Endpoint> getCommittedMembers()
```
    Returns the last committed member list of the raft group this node belongs to. Please note that the returned member list can be different from the currently effective member list, if there is an ongoing membership change in the group.
  - getAppliedMembers
```
Collection<Endpoint> getAppliedMembers()
```
    Returns the currently effective member list of the raft group this node belongs to. Please note that the returned member list can be different from the committed member list, if there is an ongoing membership change in the group.
  - isTerminatedOrSteppedDown
```
boolean isTerminatedOrSteppedDown()
```
    Returns true if this node is RaftNodeStatus.TERMINATED or RaftNodeStatus.STEPPED_DOWN, false otherwise.
    This method is essentially same as;
```
 
     return status == TERMINATED || status == STEPPED_DOWN
 
 
```
  - forceSetTerminatedStatus
```
void forceSetTerminatedStatus()
```
    Sets node's status to RaftNodeStatus.TERMINATED unconditionally if it's not terminated or stepped down yet.
  - handlePreVoteRequest
```
void handlePreVoteRequest(PreVoteRequest request)
```
    Handles PreVoteRequest sent by another follower.
  - handlePreVoteResponse
```
void handlePreVoteResponse(PreVoteResponse response)
```
    Handles PreVoteResponse for a previously sent request by this node.
  - handleVoteRequest
```
void handleVoteRequest(VoteRequest request)
```
    Handles VoteRequest sent by a candidate.
  - handleVoteResponse
```
void handleVoteResponse(VoteResponse response)
```
    Handles VoteResponse for a previously sent vote request by this node.
  - handleAppendRequest
```
void handleAppendRequest(AppendRequest request)
```
    Handles AppendRequest sent by leader.
  - handleAppendResponse
```
void handleAppendResponse(AppendSuccessResponse response)
```
    Handles AppendSuccessResponse for a previously sent append request by this node.
  - handleAppendResponse
```
void handleAppendResponse(AppendFailureResponse response)
```
    Handles AppendFailureResponse for a previously sent append request by this node.
  - handleInstallSnapshot
```
void handleInstallSnapshot(InstallSnapshot request)
```
    Handles InstallSnapshot sent by leader.
  - replicate
```
ICompletableFuture replicate(Object operation)
```
    Replicates the given operation to the Raft group. Only the leader can process replicate requests.
    Otherwise, if this node is not leader, or the leader is demoted before committing the operation, the returned future is notified with a related exception.
    
    Parameters:
    
    operation - operation to replicate
    
    Returns:
    
    future to get notified about result of the replication
  - replicateMembershipChange
```
ICompletableFuture replicateMembershipChange(Endpoint member,
                                             MembershipChangeMode mode)
```
    Replicates the membership change to the Raft group. Only the leader can process membership change requests.
    If this node is not leader, or the leader is demoted before committing the operation, or membership change is not committed for any reason, then the returned future is notified with a related exception.
    
    Parameters:
    
    member - member to add or remove
    
    mode - type of membership change
    
    Returns:
    
    future to get notified about result of the membership change
  - replicateMembershipChange
```
ICompletableFuture replicateMembershipChange(Endpoint member,
                                             MembershipChangeMode mode,
                                             long groupMembersCommitIndex)
```
    Replicates the membership change to the Raft group, if expected members commit index is equal to the actual one stored in Raft state. Otherwise, fails with MismatchingGroupMembersCommitIndexException.
    For more info see replicate(Object).
    
    Parameters:
    
    member - member to add or remove
    
    mode - type of membership change
    
    groupMembersCommitIndex - expected members commit index
    
    Returns:
    
    future to get notified about result of the membership change
  - query
```
ICompletableFuture query(Object operation,
                         QueryPolicy queryPolicy)
```
    Executes the given operation on Raft group depending on the QueryPolicy
    
    Parameters:
    
    operation - operation to query
    
    queryPolicy - query policy to decide where to execute operation
    
    Returns:
    
    future to get notified about result of the query

Interface RaftNode

Method Summary

Method Detail

getGroupId

getLocalMember

getLeader

getStatus

getInitialMembers

getCommittedMembers

getAppliedMembers

isTerminatedOrSteppedDown

forceSetTerminatedStatus

handlePreVoteRequest

handlePreVoteResponse

handleVoteRequest

handleVoteResponse

handleAppendRequest

handleAppendResponse

handleAppendResponse

handleInstallSnapshot

replicate

replicateMembershipChange

replicateMembershipChange

query