InactiveRole (Atomix API Reference (2.0.4))

java.lang.Object
- io.atomix.protocols.raft.roles.AbstractRole
- - io.atomix.protocols.raft.roles.InactiveRole

All Implemented Interfaces:

RaftRole, io.atomix.utils.Managed<RaftRole>

Direct Known Subclasses:

PassiveRole
```
public class InactiveRole
extends AbstractRole
```
Inactive state.

Constructor Summary

Constructors
Constructor and Description

InactiveRole(io.atomix.protocols.raft.impl.RaftContext context)

Constructors
Constructor and Description
`InactiveRole(io.atomix.protocols.raft.impl.RaftContext context)`

Method Summary

All Methods Instance Methods Concrete 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 Raft state represented by this state.

Methods inherited from class io.atomix.protocols.raft.roles.AbstractRole
close, isClosed, isOpen, open, toString

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

- Constructor Detail
  - InactiveRole
```
public InactiveRole(io.atomix.protocols.raft.impl.RaftContext context)
```
- Method Detail
  - role
```
public RaftServer.Role role()
```
    Description copied from class: AbstractRole
    
    Returns the Raft state represented by this state.
    
    Specified by:
    
    role in interface RaftRole
    
    Specified by:
    
    role in class AbstractRole
    
    Returns:
    
    The Raft state represented by this state.
  - onConfigure
```
public CompletableFuture<ConfigureResponse> onConfigure(ConfigureRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a configure request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onMetadata
```
public CompletableFuture<MetadataResponse> onMetadata(MetadataRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a metadata request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onKeepAlive
```
public CompletableFuture<KeepAliveResponse> onKeepAlive(KeepAliveRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a keep alive request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onOpenSession
```
public CompletableFuture<OpenSessionResponse> onOpenSession(OpenSessionRequest request)
```
    Description copied from interface: RaftRole
    
    Handles an open session request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onCloseSession
```
public CompletableFuture<CloseSessionResponse> onCloseSession(CloseSessionRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a close session request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onInstall
```
public CompletableFuture<InstallResponse> onInstall(InstallRequest request)
```
    Description copied from interface: RaftRole
    
    Handles an install request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onJoin
```
public CompletableFuture<JoinResponse> onJoin(JoinRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a join request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onReconfigure
```
public CompletableFuture<ReconfigureResponse> onReconfigure(ReconfigureRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a configure request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onLeave
```
public CompletableFuture<LeaveResponse> onLeave(LeaveRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a leave request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onTransfer
```
public CompletableFuture<TransferResponse> onTransfer(TransferRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a transfer request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onAppend
```
public CompletableFuture<AppendResponse> onAppend(AppendRequest request)
```
    Description copied from interface: RaftRole
    
    Handles an append request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onPoll
```
public CompletableFuture<PollResponse> onPoll(PollRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a poll request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onVote
```
public CompletableFuture<VoteResponse> onVote(VoteRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a vote request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onCommand
```
public CompletableFuture<CommandResponse> onCommand(CommandRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a command request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.
  - onQuery
```
public CompletableFuture<QueryResponse> onQuery(QueryRequest request)
```
    Description copied from interface: RaftRole
    
    Handles a query request.
    
    Parameters:
    
    request - The request to handle.
    
    Returns:
    
    A completable future to be completed with the request response.

Class InactiveRole

Constructor Summary

Method Summary

Methods inherited from class io.atomix.protocols.raft.roles.AbstractRole

Methods inherited from class java.lang.Object

Constructor Detail

InactiveRole

Method Detail

role

onConfigure

onMetadata

onKeepAlive

onOpenSession

onCloseSession

onInstall

onJoin

onReconfigure

onLeave

onTransfer

onAppend

onPoll

onVote

onCommand

onQuery