io.atomix.protocols.raft

Class RaftServer.Builder

java.lang.Object

io.atomix.protocols.raft.RaftServer.Builder

All Implemented Interfaces:

Builder<RaftServer>

Enclosing interface:

RaftServer

public abstract static class RaftServer.Builder
extends java.lang.Object
implements 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 PrimitiveService. 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	withElectionTimeout(java.time.Duration electionTimeout) Sets the Raft election timeout, returning the Raft configuration for method chaining.
RaftServer.Builder	withHeartbeatInterval(java.time.Duration heartbeatInterval) Sets the Raft heartbeat interval, returning the Raft configuration for method chaining.
RaftServer.Builder	withMembershipService(ClusterMembershipService membershipService) Sets the cluster membership service.
RaftServer.Builder	withName(java.lang.String name) Sets the server name.
RaftServer.Builder	withPrimitiveTypes(PrimitiveTypeRegistry primitiveTypes) Sets the primitive types.
RaftServer.Builder	withProtocol(io.atomix.protocols.raft.protocol.RaftServerProtocol protocol) Sets the server protocol.
RaftServer.Builder	withSessionTimeout(java.time.Duration sessionTimeout) Sets the Raft session timeout, returning the Raft configuration for method chaining.
RaftServer.Builder	withStorage(io.atomix.protocols.raft.storage.RaftStorage storage) Sets the storage module.
RaftServer.Builder	withThreadContextFactory(io.atomix.utils.concurrent.ThreadContextFactory threadContextFactory) Sets the client thread context factory.
RaftServer.Builder	withThreadModel(io.atomix.utils.concurrent.ThreadModel threadModel) Sets the server thread model.
RaftServer.Builder	withThreadPoolSize(int threadPoolSize) Sets the server thread pool size.

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(java.lang.String name)

Sets the server name.

The server name is used to

Parameters:

name - The server name.

Returns:

The server builder.

withMembershipService

public RaftServer.Builder withMembershipService(ClusterMembershipService membershipService)

Sets the cluster membership service.

Parameters:

membershipService - the cluster membership service

Returns:

the server builder

withProtocol

public RaftServer.Builder withProtocol(io.atomix.protocols.raft.protocol.RaftServerProtocol protocol)

Sets the server protocol.

Parameters:

protocol - The server protocol.

Returns:

The server builder.

withThreadModel

public RaftServer.Builder withThreadModel(io.atomix.utils.concurrent.ThreadModel threadModel)

Sets the server thread model.

Parameters:

threadModel - the server thread model

Returns:

the server builder

withStorage

public RaftServer.Builder withStorage(io.atomix.protocols.raft.storage.RaftStorage storage)

Sets the storage module.

Parameters:

storage - The storage module.

Returns:

The Raft server builder.

Throws:

java.lang.NullPointerException - if storage is null

withPrimitiveTypes

public RaftServer.Builder withPrimitiveTypes(PrimitiveTypeRegistry primitiveTypes)

Sets the primitive types.

Parameters:

primitiveTypes - the primitive types

Returns:

the Raft server builder

Throws:

java.lang.NullPointerException - if the primitiveTypes argument is null

withElectionTimeout

public RaftServer.Builder withElectionTimeout(java.time.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:

java.lang.IllegalArgumentException - If the election timeout is not positive

java.lang.NullPointerException - if electionTimeout is null

withHeartbeatInterval

public RaftServer.Builder withHeartbeatInterval(java.time.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:

java.lang.IllegalArgumentException - If the heartbeat interval is not positive

java.lang.NullPointerException - if heartbeatInterval is null

withSessionTimeout

public RaftServer.Builder withSessionTimeout(java.time.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:

java.lang.IllegalArgumentException - If the session timeout is not positive

java.lang.NullPointerException - if sessionTimeout is null

withThreadPoolSize

public RaftServer.Builder withThreadPoolSize(int threadPoolSize)

Sets the server thread pool size.

Parameters:

threadPoolSize - The server thread pool size.

Returns:

The server builder.

withThreadContextFactory

public RaftServer.Builder withThreadContextFactory(io.atomix.utils.concurrent.ThreadContextFactory threadContextFactory)

Sets the client thread context factory.

Parameters:

threadContextFactory - the client thread context factory

Returns:

the server builder

Throws:

java.lang.NullPointerException - if the factory is null