io.atomix.protocols.raft

Class RaftServer.Builder

java.lang.Object

io.atomix.protocols.raft.RaftServer.Builder

All Implemented Interfaces:

io.atomix.utils.Builder<RaftServer>

Enclosing interface:

RaftServer

public abstract static class RaftServer.Builder
extends Object
implements io.atomix.utils.Builder<RaftServer>

Builds a single-use Raft server.

This builder should be used to programmatically configure and construct a new RaftServer instance. The builder provides methods for configuring all aspects of a Raft server. The RaftServer.Builder class cannot be instantiated directly. To create a new builder, use one of the server builder factory methods.

   
   RaftServer.Builder builder = RaftServer.builder(address);
   
 

Once the server has been configured, use the Builder.build() method to build the server instance:

   
   RaftServer server = RaftServer.builder(address)
     ...
     .build();
   
 

Each server must be configured with a RaftService. The state machine is the component of the server that stores state and reacts to commands and queries submitted by clients to the cluster. State machines are provided to the server in the form of a state machine factory to allow the server to reconstruct its state when necessary.

   
   RaftServer server = RaftServer.builder(address)
     .withStateMachine(MyStateMachine::new)
     .build();
   
 

Method Summary

Modifier and Type	Method and Description
RaftServer.Builder	addService(String type, Supplier<RaftService> factory) Adds a Raft service factory.
RaftServer.Builder	withElectionThreshold(int electionThreshold) Sets the election failure detection threshold.
RaftServer.Builder	withElectionTimeout(Duration electionTimeout) Sets the Raft election timeout, returning the Raft configuration for method chaining.
RaftServer.Builder	withHeartbeatInterval(Duration heartbeatInterval) Sets the Raft heartbeat interval, returning the Raft configuration for method chaining.
RaftServer.Builder	withName(String name) Sets the server name.
RaftServer.Builder	withProtocol(RaftServerProtocol protocol) Sets the server protocol.
RaftServer.Builder	withSessionFailureThreshold(int sessionFailureThreshold) Sets the session failure detection threshold.
RaftServer.Builder	withSessionTimeout(Duration sessionTimeout) Sets the Raft session timeout, returning the Raft configuration for method chaining.
RaftServer.Builder	withStorage(RaftStorage storage) Sets the storage module.
RaftServer.Builder	withThreadModel(ThreadModel threadModel) Sets the server thread model.
RaftServer.Builder	withThreadPoolSize(int threadPoolSize) Sets the server thread pool size.
RaftServer.Builder	withType(RaftMember.Type type) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.atomix.utils.Builder

build

Method Detail

withName

public RaftServer.Builder withName(String name)

Sets the server name.

The server name is used to

Parameters:

name - The server name.

Returns:

The server builder.

withType

@Deprecated
public RaftServer.Builder withType(RaftMember.Type type)

Deprecated.

Sets the initial server member type.

Parameters:

type - The initial server member type.

Returns:

The server builder.

withProtocol

public RaftServer.Builder withProtocol(RaftServerProtocol protocol)

Sets the server protocol.

Parameters:

protocol - The server protocol.

Returns:

The server builder.

withThreadModel

public RaftServer.Builder withThreadModel(ThreadModel threadModel)

Sets the server thread model.

Parameters:

threadModel - the server thread model

Returns:

the server builder

withStorage

public RaftServer.Builder withStorage(RaftStorage storage)

Sets the storage module.

Parameters:

storage - The storage module.

Returns:

The Raft server builder.

Throws:

NullPointerException - if storage is null

addService

public RaftServer.Builder addService(String type,
                                     Supplier<RaftService> factory)

Adds a Raft service factory.

Parameters:

type - The service type name.

factory - The Raft service factory.

Returns:

The server builder.

Throws:

NullPointerException - if the factory is null

withElectionTimeout

public RaftServer.Builder withElectionTimeout(Duration electionTimeout)

Sets the Raft election timeout, returning the Raft configuration for method chaining.

Parameters:

electionTimeout - The Raft election timeout duration.

Returns:

The Raft configuration.

Throws:

IllegalArgumentException - If the election timeout is not positive

NullPointerException - if electionTimeout is null

withHeartbeatInterval

public RaftServer.Builder withHeartbeatInterval(Duration heartbeatInterval)

Sets the Raft heartbeat interval, returning the Raft configuration for method chaining.

Parameters:

heartbeatInterval - The Raft heartbeat interval duration.

Returns:

The Raft configuration.

Throws:

IllegalArgumentException - If the heartbeat interval is not positive

NullPointerException - if heartbeatInterval is null

withElectionThreshold

public RaftServer.Builder withElectionThreshold(int electionThreshold)

Sets the election failure detection threshold.

This is the phi value at which a follower will attempt to start a new election after not receiving any communication from the leader.

Parameters:

electionThreshold - the election failure detection threshold

Returns:

The Raft server builder

Throws:

IllegalArgumentException - if the threshold is not positive

withSessionTimeout

public RaftServer.Builder withSessionTimeout(Duration sessionTimeout)

Sets the Raft session timeout, returning the Raft configuration for method chaining.

Parameters:

sessionTimeout - The Raft session timeout duration.

Returns:

The server builder.

Throws:

IllegalArgumentException - If the session timeout is not positive

NullPointerException - if sessionTimeout is null

withSessionFailureThreshold

public RaftServer.Builder withSessionFailureThreshold(int sessionFailureThreshold)

Sets the session failure detection threshold.

The threshold is a phi value at which sessions will be expired if the leader cannot communicate with the client.

Parameters:

sessionFailureThreshold - the session failure threshold

Returns:

The Raft server builder.

Throws:

IllegalArgumentException - if the threshold is not positive

withThreadPoolSize

public RaftServer.Builder withThreadPoolSize(int threadPoolSize)

Sets the server thread pool size.

Parameters:

threadPoolSize - The server thread pool size.

Returns:

The server builder.