CopycatServer.Builder (Copycat API Reference (1.1.4))

java.lang.Object
- io.atomix.copycat.server.CopycatServer.Builder

All Implemented Interfaces:

Builder<CopycatServer>

Enclosing class:

CopycatServer
```
public static class CopycatServer.Builder
extends Object
implements Builder<CopycatServer>
```
Builds a single-use Copycat server.
This builder should be used to programmatically configure and construct a new CopycatServer instance. The builder provides methods for configuring all aspects of a Copycat server. The CopycatServer.Builder class cannot be instantiated directly. To create a new builder, use one of the server builder factory methods.
```
   
   CopycatServer.Builder builder = CopycatServer.builder(address);
   
 
```
Once the server has been configured, use the build() method to build the server instance:
```
   
   CopycatServer server = CopycatServer.builder(address)
     ...
     .build();
   
 
```
Each server must be configured with a StateMachine. 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.
```
   
   CopycatServer server = CopycatServer.builder(address)
     .withStateMachine(MyStateMachine::new)
     .build();
   
 
```
Similarly critical to the operation of the server are the Transport and Storage layers. By default, servers are configured with the io.atomix.catalyst.transport.netty.NettyTransport transport if it's available on the classpath. Users should provide a Storage instance to specify how the server stores state changes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CopycatServer`	`build()`
`CopycatServer.Builder`	`withClientTransport(Transport transport)` Sets the client transport.
`CopycatServer.Builder`	`withElectionTimeout(Duration electionTimeout)` Sets the Raft election timeout, returning the Raft configuration for method chaining.
`CopycatServer.Builder`	`withGlobalSuspendTimeout(Duration globalSuspendTimeout)` Sets the timeout after which suspended global replication will resume and force a partitioned follower to truncate its log once the partition heals.
`CopycatServer.Builder`	`withHeartbeatInterval(Duration heartbeatInterval)` Sets the Raft heartbeat interval, returning the Raft configuration for method chaining.
`CopycatServer.Builder`	`withName(String name)` Sets the server name.
`CopycatServer.Builder`	`withSerializer(Serializer serializer)` Sets the Raft serializer.
`CopycatServer.Builder`	`withServerTransport(Transport transport)` Sets the server transport.
`CopycatServer.Builder`	`withSessionTimeout(Duration sessionTimeout)` Sets the Raft session timeout, returning the Raft configuration for method chaining.
`CopycatServer.Builder`	`withStateMachine(Supplier<StateMachine> factory)` Sets the Raft state machine factory.
`CopycatServer.Builder`	`withStorage(Storage storage)` Sets the storage module.
`CopycatServer.Builder`	`withTransport(Transport transport)` Sets the client and server transport.
`CopycatServer.Builder`	`withType(Member.Type type)` Sets the initial server member type.

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

- Method Detail
  - withName
```
public CopycatServer.Builder withName(String name)
```
    Sets the server name.
    The server name is used to
    
    Parameters:
    
    name - The server name.
    
    Returns:
    
    The server builder.
  - withType
```
public CopycatServer.Builder withType(Member.Type type)
```
    Sets the initial server member type.
    
    Parameters:
    
    type - The initial server member type.
    
    Returns:
    
    The server builder.
  - withTransport
```
public CopycatServer.Builder withTransport(Transport transport)
```
    Sets the client and server transport.
    
    Parameters:
    
    transport - The client and server transport.
    
    Returns:
    
    The server builder.
    
    Throws:
    
    NullPointerException - if transport is null
  - withClientTransport
```
public CopycatServer.Builder withClientTransport(Transport transport)
```
    Sets the client transport.
    
    Parameters:
    
    transport - The client transport.
    
    Returns:
    
    The server builder.
    
    Throws:
    
    NullPointerException - if transport is null
  - withServerTransport
```
public CopycatServer.Builder withServerTransport(Transport transport)
```
    Sets the server transport.
    
    Parameters:
    
    transport - The server transport.
    
    Returns:
    
    The server builder.
    
    Throws:
    
    NullPointerException - if transport is null
  - withSerializer
```
public CopycatServer.Builder withSerializer(Serializer serializer)
```
    Sets the Raft serializer.
    
    Parameters:
    
    serializer - The Raft serializer.
    
    Returns:
    
    The Raft builder.
    
    Throws:
    
    NullPointerException - if serializer is null
  - withStorage
```
public CopycatServer.Builder withStorage(Storage storage)
```
    Sets the storage module.
    
    Parameters:
    
    storage - The storage module.
    
    Returns:
    
    The Raft server builder.
    
    Throws:
    
    NullPointerException - if storage is null
  - withStateMachine
```
public CopycatServer.Builder withStateMachine(Supplier<StateMachine> factory)
```
    Sets the Raft state machine factory.
    
    Parameters:
    
    factory - The Raft state machine factory.
    
    Returns:
    
    The server builder.
    
    Throws:
    
    NullPointerException - if the factory is null
  - withElectionTimeout
```
public CopycatServer.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 CopycatServer.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
  - withSessionTimeout
```
public CopycatServer.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
  - withGlobalSuspendTimeout
```
public CopycatServer.Builder withGlobalSuspendTimeout(Duration globalSuspendTimeout)
```
    Sets the timeout after which suspended global replication will resume and force a partitioned follower to truncate its log once the partition heals.
    
    Parameters:
    
    globalSuspendTimeout - The timeout after which to resume global replication.
    
    Returns:
    
    The server builder.
  - build
```
public CopycatServer build()
```
    Specified by:
    
    build in interface Builder<CopycatServer>
    
    Throws:
    
    ConfigurationException - if a state machine, members or transport are not configured

Class CopycatServer.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withName

withType

withTransport

withClientTransport

withServerTransport

withSerializer

withStorage

withStateMachine

withElectionTimeout

withHeartbeatInterval

withSessionTimeout

withGlobalSuspendTimeout

build