io.atomix.manager

Class ResourceServer.Builder

java.lang.Object

io.atomix.manager.ResourceServer.Builder

All Implemented Interfaces:

Builder<ResourceServer>

Enclosing class:

ResourceServer

public static class ResourceServer.Builder
extends Object
implements Builder<ResourceServer>

Builds an ResourceServer.

The server builder configures an ResourceServer to listen for connections from clients and other servers, connect to other servers in a cluster, and manage a replicated log. To create a server builder, use the ResourceServer.builder(Address, Address...) method:

   
   AtomixServer server = AtomixServer.builder(address, servers)
     .withTransport(new NettyTransport())
     .withStorage(Storage.builder()
       .withDirectory("logs")
       .withStorageLevel(StorageLevel.MAPPED)
       .build())
     .build();
   
 

The two most essential components of the builder are the Transport and Storage. The transport provides the mechanism for the server to communicate with clients and other servers in the cluster. All servers, clients, and replicas must implement the same Transport type. The Storage module configures how the server manages the replicated log. Logs can be written to disk or held in memory or memory-mapped files.

Method Summary

Modifier and Type	Method and Description
ResourceServer.Builder	addResourceType(Class<? extends io.atomix.resource.Resource<?>> type) Adds a resource type to the server.
ResourceServer.Builder	addResourceType(io.atomix.resource.ResourceType type) Adds a resource type to the server.
ResourceServer	build() Builds the server.
ResourceServer.Builder	withClientTransport(Transport transport) Sets the client transport, returning the server builder for method chaining.
ResourceServer.Builder	withElectionTimeout(Duration electionTimeout) Sets the server election timeout, returning the server builder for method chaining.
ResourceServer.Builder	withHeartbeatInterval(Duration heartbeatInterval) Sets the server heartbeat interval, returning the server builder for method chaining.
ResourceServer.Builder	withResourceTypes(Class<? extends io.atomix.resource.Resource<?>>... types) Sets the available resource types.
ResourceServer.Builder	withResourceTypes(Collection<io.atomix.resource.ResourceType> types) Sets the available resource types.
ResourceServer.Builder	withResourceTypes(io.atomix.resource.ResourceType... types) Sets the available resource types.
ResourceServer.Builder	withSerializer(Serializer serializer) Sets the serializer, returning the server builder for method chaining.
ResourceServer.Builder	withServerTransport(Transport transport) Sets the server transport, returning the server builder for method chaining.
ResourceServer.Builder	withSessionTimeout(Duration sessionTimeout) Sets the server session timeout, returning the server builder for method chaining.
ResourceServer.Builder	withStorage(Storage storage) Sets the server storage module, returning the server builder for method chaining.
ResourceServer.Builder	withTransport(Transport transport) Sets the server transport, returning the server builder for method chaining.

Methods inherited from class java.lang.Object

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

Method Detail

withTransport

public ResourceServer.Builder withTransport(Transport transport)

Sets the server transport, returning the server builder for method chaining.

The configured transport should be the same transport as all other nodes in the cluster. If no transport is explicitly provided, the instance will default to the NettyTransport if available on the classpath.

Parameters:

transport - The server transport.

Returns:

The server builder.

Throws:

NullPointerException - if transport is null

withClientTransport

public ResourceServer.Builder withClientTransport(Transport transport)

Sets the client transport, returning the server builder for method chaining.

The configured transport should be the same transport as all clients. If no transport is explicitly provided, the instance will default to the NettyTransport if available on the classpath.

Parameters:

transport - The server transport.

Returns:

The server builder.

Throws:

NullPointerException - if transport is null

withServerTransport

public ResourceServer.Builder withServerTransport(Transport transport)

Sets the server transport, returning the server builder for method chaining.

The configured transport should be the same transport as all other servers in the cluster. If no transport is explicitly provided, the instance will default to the NettyTransport if available on the classpath.

Parameters:

transport - The server transport.

Returns:

The server builder.

Throws:

NullPointerException - if transport is null

withSerializer

public ResourceServer.Builder withSerializer(Serializer serializer)

Sets the serializer, returning the server builder for method chaining.

The serializer will be used to serialize and deserialize operations that are sent over the wire.

Parameters:

serializer - The serializer.

Returns:

The server builder.

Throws:

NullPointerException - if serializer is null

withStorage

public ResourceServer.Builder withStorage(Storage storage)

Sets the server storage module, returning the server builder for method chaining.

The storage module is the interface the server will use to store the persistent replicated log. For simple configurations, users can simply construct a Storage object:

   
   AtomixServer server = AtomixServer.builder(address, members)
     .withStorage(new Storage("logs"))
     .build();
   
 

For more complex storage configurations, use the Storage.Builder:

   
   AtomixServer server = AtomixServer.builder(address, members)
     .withStorage(Storage.builder()
       .withDirectory("logs")
       .withStorageLevel(StorageLevel.MAPPED)
       .withCompactionThreads(2)
       .build())
     .build();
   
 

Parameters:

storage - The server storage module.

Returns:

The server builder.

Throws:

NullPointerException - if storage is null

withElectionTimeout

public ResourceServer.Builder withElectionTimeout(Duration electionTimeout)

Sets the server election timeout, returning the server builder for method chaining.

The election timeout is the duration since last contact with the cluster leader after which the server should start a new election. The election timeout should always be significantly larger than withHeartbeatInterval(Duration) in order to prevent unnecessary elections.

Parameters:

electionTimeout - The server election timeout in milliseconds.

Returns:

The server builder.

Throws:

NullPointerException - if electionTimeout is null

withHeartbeatInterval

public ResourceServer.Builder withHeartbeatInterval(Duration heartbeatInterval)

Sets the server heartbeat interval, returning the server builder for method chaining.

The heartbeat interval is the interval at which the server, if elected leader, should contact other servers within the cluster to maintain its leadership. The heartbeat interval should always be some fraction of withElectionTimeout(Duration).

Parameters:

heartbeatInterval - The server heartbeat interval in milliseconds.

Returns:

The server builder.

Throws:

NullPointerException - if heartbeatInterval is null

withSessionTimeout

public ResourceServer.Builder withSessionTimeout(Duration sessionTimeout)

Sets the server session timeout, returning the server builder for method chaining.

The session timeout is assigned by the server to a client which opens a new session. The session timeout dictates the interval at which the client must send keep-alive requests to the cluster to maintain its session. If a client fails to communicate with the cluster for larger than the configured session timeout, its session may be expired.

Parameters:

sessionTimeout - The server session timeout in milliseconds.

Returns:

The server builder.

Throws:

NullPointerException - if sessionTimeout is null

withResourceTypes

public ResourceServer.Builder withResourceTypes(Class<? extends io.atomix.resource.Resource<?>>... types)

Sets the available resource types.

Parameters:

types - The available resource types.

Returns:

The server builder.

withResourceTypes

public ResourceServer.Builder withResourceTypes(io.atomix.resource.ResourceType... types)

Sets the available resource types.

Parameters:

types - The available resource types.

Returns:

The server builder.

withResourceTypes

public ResourceServer.Builder withResourceTypes(Collection<io.atomix.resource.ResourceType> types)

Sets the available resource types.

Parameters:

types - The available resource types.

Returns:

The server builder.

addResourceType

public ResourceServer.Builder addResourceType(Class<? extends io.atomix.resource.Resource<?>> type)

Adds a resource type to the server.

Parameters:

type - The resource type.

Returns:

The server builder.

addResourceType

public ResourceServer.Builder addResourceType(io.atomix.resource.ResourceType type)

Adds a resource type to the server.

Parameters:

type - The resource type.

Returns:

The server builder.

build

public ResourceServer build()

Builds the server.

If no Transport was configured for the server, the builder will attempt to create a NettyTransport instance. If io.atomix.catalyst.transport.NettyTransport is not available on the classpath, a ConfigurationException will be thrown.

Once the server is built, it is not yet connected to the cluster. To connect the server to the cluster, call the asynchronous #open() method.

Specified by:

build in interface Builder<ResourceServer>

Returns:

The built server.

Throws:

ConfigurationException - if the server is misconfigured