AtomixCluster (Atomix API Reference (3.0.0-rc7))

java.lang.Object
- io.atomix.cluster.AtomixCluster

All Implemented Interfaces:

BootstrapService, io.atomix.utils.Managed<Void>
```
public class AtomixCluster
extends Object
implements BootstrapService, io.atomix.utils.Managed<Void>
```
Atomix cluster manager.
The cluster manager is the basis for all cluster management and communication in an Atomix cluster. This class is responsible for bootstrapping new clusters or joining existing ones, establishing communication between nodes, and detecting failures.
The Atomix cluster can be run as a standalone instance for cluster management and communication. To build a cluster instance, use builder() to create a new builder.
```
   
   AtomixCluster cluster = AtomixCluster.builder()
     .withClusterName("my-cluster")
     .withMemberId("member-1")
     .withAddress("localhost:1234")
     .withMulticastEnabled()
     .build();
   
 
```
The instance can be configured with a unique identifier via AtomixClusterBuilder.withMemberId(String). The member ID can be used to lookup the member in the ClusterMembershipService or send messages to this node from other member nodes. The address is the host and port to which the node will bind for intra-cluster communication over TCP.
Once an instance has been configured, the start() method must be called to bootstrap the instance. The start() method returns a CompletableFuture which will be completed once all the services have been bootstrapped.
```
   
   cluster.start().join();
   
 
```
Cluster membership is determined by a configurable NodeDiscoveryProvider. To configure the membership provider use AtomixClusterBuilder.withMembershipProvider(NodeDiscoveryProvider). By default, the MulticastDiscoveryProvider will be used if multicast is enabled, otherwise the BootstrapDiscoveryProvider will be used if no provider is explicitly provided.

Constructor Summary

Constructors
Constructor and Description

AtomixCluster(ClusterConfig config)

AtomixCluster(File configFile)

AtomixCluster(String configFile)

Constructors
Constructor and Description
`AtomixCluster(ClusterConfig config)`
`AtomixCluster(File configFile)`
`AtomixCluster(String configFile)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AtomixClusterBuilder`	`builder()` Returns a new Atomix builder.
`static AtomixClusterBuilder`	`builder(ClassLoader classLoader)` Returns a new Atomix builder.
`static AtomixClusterBuilder`	`builder(ClusterConfig config)` Returns a new Atomix builder.
`static AtomixClusterBuilder`	`builder(String config)` Returns a new Atomix builder.
`static AtomixClusterBuilder`	`builder(String config, ClassLoader classLoader)` Returns a new Atomix builder.
`BroadcastService`	`getBroadcastService()` Returns the cluster broadcast service.
`ClusterCommunicationService`	`getCommunicationService()` Returns the cluster communication service.
`ClusterEventService`	`getEventService()` Returns the cluster event service.
`ClusterMembershipService`	`getMembershipService()` Returns the cluster membership service.
`MessagingService`	`getMessagingService()` Returns the cluster messaging service.
`boolean`	`isRunning()`
`CompletableFuture<Void>`	`start()`
`CompletableFuture<Void>`	`stop()`
`String`	`toString()`

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

- Constructor Detail
  - AtomixCluster
```
public AtomixCluster(String configFile)
```
  - AtomixCluster
```
public AtomixCluster(File configFile)
```
  - AtomixCluster
```
public AtomixCluster(ClusterConfig config)
```
- Method Detail
  - builder
```
public static AtomixClusterBuilder builder()
```
    Returns a new Atomix builder.
    
    Returns:
    
    a new Atomix builder
  - builder
```
public static AtomixClusterBuilder builder(ClassLoader classLoader)
```
    Returns a new Atomix builder.
    
    Parameters:
    
    classLoader - the class loader
    
    Returns:
    
    a new Atomix builder
  - builder
```
public static AtomixClusterBuilder builder(String config)
```
    Returns a new Atomix builder.
    
    Parameters:
    
    config - the Atomix configuration
    
    Returns:
    
    a new Atomix builder
  - builder
```
public static AtomixClusterBuilder builder(String config,
                                           ClassLoader classLoader)
```
    Returns a new Atomix builder.
    
    Parameters:
    
    config - the Atomix configuration
    
    classLoader - the class loader
    
    Returns:
    
    a new Atomix builder
  - builder
```
public static AtomixClusterBuilder builder(ClusterConfig config)
```
    Returns a new Atomix builder.
    
    Parameters:
    
    config - the Atomix configuration
    
    Returns:
    
    a new Atomix builder
  - getBroadcastService
```
public BroadcastService getBroadcastService()
```
    Returns the cluster broadcast service.
    The broadcast service is used to broadcast messages to all nodes in the cluster via multicast. The broadcast service is disabled by default. To enable broadcast, the cluster must be configured with multicast enabled.
    
    Specified by:
    
    getBroadcastService in interface BootstrapService
    
    Returns:
    
    the cluster broadcast service
  - getMessagingService
```
public MessagingService getMessagingService()
```
    Returns the cluster messaging service.
    The messaging service is used for direct point-to-point messaging between nodes by Address. This is a low-level cluster communication API. For higher level messaging, use the communication service or event service.
    
    Specified by:
    
    getMessagingService in interface BootstrapService
    
    Returns:
    
    the cluster messaging service
  - getMembershipService
```
public ClusterMembershipService getMembershipService()
```
    Returns the cluster membership service.
    The membership service manages cluster membership information and failure detection.
    
    Returns:
    
    the cluster membership service
  - getCommunicationService
```
public ClusterCommunicationService getCommunicationService()
```
    Returns the cluster communication service.
    The cluster communication service is used for high-level unicast, multicast, broadcast, and request-reply messaging.
    
    Returns:
    
    the cluster communication service
  - getEventService
```
public ClusterEventService getEventService()
```
    Returns the cluster event service.
    The cluster event service is used for high-level publish-subscribe messaging.
    
    Returns:
    
    the cluster event service
  - start
```
public CompletableFuture<Void> start()
```
    Specified by:
    
    start in interface io.atomix.utils.Managed<Void>
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface io.atomix.utils.Managed<Void>
  - stop
```
public CompletableFuture<Void> stop()
```
    Specified by:
    
    stop in interface io.atomix.utils.Managed<Void>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AtomixCluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AtomixCluster

AtomixCluster

AtomixCluster

Method Detail

builder

builder

builder

builder

builder

getBroadcastService

getMessagingService

getMembershipService

getCommunicationService

getEventService

start

isRunning

stop

toString