RaftRole (Atomix API Reference (2.0.4))

All Superinterfaces:

io.atomix.utils.Managed<RaftRole>

All Known Implementing Classes:

AbstractRole, ActiveRole, CandidateRole, FollowerRole, InactiveRole, LeaderRole, PassiveRole, PromotableRole
```
public interface RaftRole
extends io.atomix.utils.Managed<RaftRole>
```
Raft role interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<AppendResponse>`	`onAppend(AppendRequest request)` Handles an append request.
`CompletableFuture<CloseSessionResponse>`	`onCloseSession(CloseSessionRequest request)` Handles a close session request.
`CompletableFuture<CommandResponse>`	`onCommand(CommandRequest request)` Handles a command request.
`CompletableFuture<ConfigureResponse>`	`onConfigure(ConfigureRequest request)` Handles a configure request.
`CompletableFuture<InstallResponse>`	`onInstall(InstallRequest request)` Handles an install request.
`CompletableFuture<JoinResponse>`	`onJoin(JoinRequest request)` Handles a join request.
`CompletableFuture<KeepAliveResponse>`	`onKeepAlive(KeepAliveRequest request)` Handles a keep alive request.
`CompletableFuture<LeaveResponse>`	`onLeave(LeaveRequest request)` Handles a leave request.
`CompletableFuture<MetadataResponse>`	`onMetadata(MetadataRequest request)` Handles a metadata request.
`CompletableFuture<OpenSessionResponse>`	`onOpenSession(OpenSessionRequest request)` Handles an open session request.
`CompletableFuture<PollResponse>`	`onPoll(PollRequest request)` Handles a poll request.
`CompletableFuture<QueryResponse>`	`onQuery(QueryRequest request)` Handles a query request.
`CompletableFuture<ReconfigureResponse>`	`onReconfigure(ReconfigureRequest request)` Handles a configure request.
`CompletableFuture<TransferResponse>`	`onTransfer(TransferRequest request)` Handles a transfer request.
`CompletableFuture<VoteResponse>`	`onVote(VoteRequest request)` Handles a vote request.
`RaftServer.Role`	`role()` Returns the server state type.

Methods inherited from interface io.atomix.utils.Managed
close, isClosed, isOpen, open

- Method Detail
  - role
```
RaftServer.Role role()
```
    Returns the server state type.
    
    Returns:
    
    The server state type.
  - onMetadata
```
CompletableFuture<MetadataResponse> onMetadata(MetadataRequest request)
```
    Handles a metadata request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onOpenSession
```
CompletableFuture<OpenSessionResponse> onOpenSession(OpenSessionRequest request)
```
    Handles an open session request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onKeepAlive
```
CompletableFuture<KeepAliveResponse> onKeepAlive(KeepAliveRequest request)
```
    Handles a keep alive request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onCloseSession
```
CompletableFuture<CloseSessionResponse> onCloseSession(CloseSessionRequest request)
```
    Handles a close session request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onConfigure
```
CompletableFuture<ConfigureResponse> onConfigure(ConfigureRequest request)
```
    Handles a configure request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onInstall
```
CompletableFuture<InstallResponse> onInstall(InstallRequest request)
```
    Handles an install request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onJoin
```
CompletableFuture<JoinResponse> onJoin(JoinRequest request)
```
    Handles a join request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onReconfigure
```
CompletableFuture<ReconfigureResponse> onReconfigure(ReconfigureRequest request)
```
    Handles a configure request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onLeave
```
CompletableFuture<LeaveResponse> onLeave(LeaveRequest request)
```
    Handles a leave request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onTransfer
```
CompletableFuture<TransferResponse> onTransfer(TransferRequest request)
```
    Handles a transfer request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onAppend
```
CompletableFuture<AppendResponse> onAppend(AppendRequest request)
```
    Handles an append request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onPoll
```
CompletableFuture<PollResponse> onPoll(PollRequest request)
```
    Handles a poll request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onVote
```
CompletableFuture<VoteResponse> onVote(VoteRequest request)
```
    Handles a vote request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onCommand
```
CompletableFuture<CommandResponse> onCommand(CommandRequest request)
```
    Handles a command request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onQuery
```
CompletableFuture<QueryResponse> onQuery(QueryRequest request)
```
    Handles a query request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.

Interface RaftRole

Method Summary

Methods inherited from interface io.atomix.utils.Managed

Method Detail

role

onMetadata

onOpenSession

onKeepAlive

onCloseSession

onConfigure

onInstall

onJoin

onReconfigure

onLeave

onTransfer

onAppend

onPoll

onVote

onCommand

onQuery