AtomixClusterBuilder (Atomix API Reference (3.0.0-rc7))

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

All Implemented Interfaces:

io.atomix.utils.Builder<AtomixCluster>
```
public class AtomixClusterBuilder
extends Object
implements io.atomix.utils.Builder<AtomixCluster>
```
Builder for an AtomixCluster instance.
This builder is used to configure an AtomixCluster instance programmatically. To create a new builder, use one of the AtomixCluster.builder() static methods.
```
   
   AtomixClusterBuilder builder = AtomixCluster.builder();
   
 
```
The instance is configured by calling the with* methods on this builder. Once the instance has been configured, call build() to build the instance:
```
   
   AtomixCluster cluster = AtomixCluster.builder()
     .withMemberId("member-1")
     .withAddress("localhost", 5000)
     .build();
   
 
```
Backing the builder is an ClusterConfig which is loaded when the builder is initially constructed. To load a configuration from a file, use AtomixCluster.builder(String).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AtomixCluster`	`build()`
`AtomixClusterBuilder`	`setBroadcastInterval(Duration interval)` Sets the reachability broadcast interval.
`AtomixClusterBuilder`	`setReachabilityThreshold(int threshold)` Sets the reachability failure detection threshold.
`AtomixClusterBuilder`	`withAddress(io.atomix.utils.net.Address address)` Sets the member address.
`AtomixClusterBuilder`	`withAddress(int port)` Sets the member address using local host.
`AtomixClusterBuilder`	`withAddress(String address)` Sets the member address.
`AtomixClusterBuilder`	`withAddress(String host, int port)` Sets the member host/port.
`AtomixClusterBuilder`	`withClusterId(String clusterId)` Sets the cluster identifier.
`AtomixClusterBuilder`	`withHost(String host)` Sets the host to which the member belongs.
`AtomixClusterBuilder`	`withMemberId(MemberId localMemberId)` Sets the local member identifier.
`AtomixClusterBuilder`	`withMemberId(String localMemberId)` Sets the local member identifier.
`AtomixClusterBuilder`	`withMembershipProvider(NodeDiscoveryProvider locationProvider)` Sets the cluster membership provider.
`AtomixClusterBuilder`	`withMulticastAddress(io.atomix.utils.net.Address address)` Sets the multicast address.
`AtomixClusterBuilder`	`withMulticastEnabled()` Enables multicast communication.
`AtomixClusterBuilder`	`withMulticastEnabled(boolean multicastEnabled)` Sets whether multicast communication is enabled.
`AtomixClusterBuilder`	`withProperties(Properties properties)` Sets the member properties.
`AtomixClusterBuilder`	`withProperty(String key, String value)` Sets a property of the member.
`AtomixClusterBuilder`	`withRack(String rack)` Sets the rack to which the member belongs.
`AtomixClusterBuilder`	`withReachabilityTimeout(Duration timeout)` Sets the reachability failure timeout.
`AtomixClusterBuilder`	`withZone(String zone)` Sets the zone to which the member belongs.

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

- Method Detail
  - withClusterId
```
public AtomixClusterBuilder withClusterId(String clusterId)
```
    Sets the cluster identifier.
    The cluster identifier is used to verify intra-cluster communication is taking place between nodes that are intended to be part of the same cluster, e.g. if multicast discovery is used. It only needs to be configured if multiple Atomix clusters are running within the same network.
    
    Parameters:
    
    clusterId - the cluster identifier
    
    Returns:
    
    the cluster builder
  - withMemberId
```
public AtomixClusterBuilder withMemberId(String localMemberId)
```
    Sets the local member identifier.
    The member identifier is an optional attribute that can be used to identify and send messages directly to this node. If no member identifier is provided, a UUID based identifier will be generated.
    
    Parameters:
    
    localMemberId - the local member identifier
    
    Returns:
    
    the cluster builder
  - withMemberId
```
public AtomixClusterBuilder withMemberId(MemberId localMemberId)
```
    Sets the local member identifier.
    The member identifier is an optional attribute that can be used to identify and send messages directly to this node. If no member identifier is provided, a UUID based identifier will be generated.
    
    Parameters:
    
    localMemberId - the local member identifier
    
    Returns:
    
    the cluster builder
  - withAddress
```
public AtomixClusterBuilder withAddress(String address)
```
    Sets the member address.
    The constructed AtomixCluster will bind to the given address for intra-cluster communication. The format of the address can be host:port or just host.
    
    Parameters:
    
    address - a host:port tuple
    
    Returns:
    
    the cluster builder
    
    Throws:
    
    io.atomix.utils.net.MalformedAddressException - if a valid Address cannot be constructed from the arguments
  - withAddress
```
public AtomixClusterBuilder withAddress(String host,
                                        int port)
```
    Sets the member host/port.
    The constructed AtomixCluster will bind to the given host/port for intra-cluster communication. The provided host should be visible to other nodes in the cluster.
    
    Parameters:
    
    host - the host name
    
    port - the port number
    
    Returns:
    
    the cluster builder
    
    Throws:
    
    io.atomix.utils.net.MalformedAddressException - if a valid Address cannot be constructed from the arguments
  - withAddress
```
public AtomixClusterBuilder withAddress(int port)
```
    Sets the member address using local host.
    The constructed AtomixCluster will bind to the given port for intra-cluster communication.
    
    Parameters:
    
    port - the port number
    
    Returns:
    
    the cluster builder
    
    Throws:
    
    io.atomix.utils.net.MalformedAddressException - if a valid Address cannot be constructed from the arguments
  - withAddress
```
public AtomixClusterBuilder withAddress(io.atomix.utils.net.Address address)
```
    Sets the member address.
    The constructed AtomixCluster will bind to the given address for intra-cluster communication. The provided address should be visible to other nodes in the cluster.
    
    Parameters:
    
    address - the member address
    
    Returns:
    
    the cluster builder
  - withZone
```
public AtomixClusterBuilder withZone(String zone)
```
    Sets the zone to which the member belongs.
    The zone attribute can be used to enable zone-awareness in replication for certain primitive protocols. It is an arbitrary string that should be used to group multiple nodes together by their physical location.
    
    Parameters:
    
    zone - the zone to which the member belongs
    
    Returns:
    
    the cluster builder
  - withRack
```
public AtomixClusterBuilder withRack(String rack)
```
    Sets the rack to which the member belongs.
    The rack attribute can be used to enable rack-awareness in replication for certain primitive protocols. It is an arbitrary string that should be used to group multiple nodes together by their physical location.
    
    Parameters:
    
    rack - the rack to which the member belongs
    
    Returns:
    
    the cluster builder
  - withHost
```
public AtomixClusterBuilder withHost(String host)
```
    Sets the host to which the member belongs.
    The host attribute can be used to enable host-awareness in replication for certain primitive protocols. It is an arbitrary string that should be used to group multiple nodes together by their physical location. Typically this attribute only applies to containerized clusters.
    
    Parameters:
    
    host - the host to which the member belongs
    
    Returns:
    
    the cluster builder
  - withProperties
```
public AtomixClusterBuilder withProperties(Properties properties)
```
    Sets the member properties.
    The properties are arbitrary settings that will be replicated along with this node's member information. Properties can be used to enable other nodes to determine metadata about this node.
    
    Parameters:
    
    properties - the member properties
    
    Returns:
    
    the cluster builder
    
    Throws:
    
    NullPointerException - if the properties are null
  - withProperty
```
public AtomixClusterBuilder withProperty(String key,
                                         String value)
```
    Sets a property of the member.
    The properties are arbitrary settings that will be replicated along with this node's member information. Properties can be used to enable other nodes to determine metadata about this node.
    
    Parameters:
    
    key - the property key to set
    
    value - the property value to set
    
    Returns:
    
    the cluster builder
    
    Throws:
    
    NullPointerException - if the property is null
  - withMulticastEnabled
```
public AtomixClusterBuilder withMulticastEnabled()
```
    Enables multicast communication.
    Multicast is disabled by default. This method must be called to enable it. Enabling multicast enables the use of the BroadcastService.
    
    Returns:
    
    the cluster builder
    
    See Also:
    
    withMulticastAddress(Address)
  - withMulticastEnabled
```
public AtomixClusterBuilder withMulticastEnabled(boolean multicastEnabled)
```
    Sets whether multicast communication is enabled.
    Multicast is disabled by default. This method must be called to enable it. Enabling multicast enables the use of the BroadcastService.
    
    Parameters:
    
    multicastEnabled - whether to enable multicast
    
    Returns:
    
    the cluster builder
    
    See Also:
    
    withMulticastAddress(Address)
  - withMulticastAddress
```
public AtomixClusterBuilder withMulticastAddress(io.atomix.utils.net.Address address)
```
    Sets the multicast address.
    Multicast is disabled by default. To enable multicast, first use withMulticastEnabled().
    
    Parameters:
    
    address - the multicast address
    
    Returns:
    
    the cluster builder
  - setBroadcastInterval
```
public AtomixClusterBuilder setBroadcastInterval(Duration interval)
```
    Sets the reachability broadcast interval.
    The broadcast interval is the interval at which heartbeats are sent to peers in the cluster.
    
    Parameters:
    
    interval - the reachability broadcast interval
    
    Returns:
    
    the cluster builder
  - setReachabilityThreshold
```
public AtomixClusterBuilder setReachabilityThreshold(int threshold)
```
    Sets the reachability failure detection threshold.
    Reachability of cluster members is determined using a phi-accrual failure detector. The reachability threshold is the phi threshold after which a peer will be determined to be unreachable.
    
    Parameters:
    
    threshold - the reachability failure detection threshold
    
    Returns:
    
    the cluster builder
  - withReachabilityTimeout
```
public AtomixClusterBuilder withReachabilityTimeout(Duration timeout)
```
    Sets the reachability failure timeout.
    The reachability timeout determines the maximum time after which a member will be marked unreachable if heartbeats have failed.
    
    Parameters:
    
    timeout - the reachability failure timeout
    
    Returns:
    
    the cluster builder
  - withMembershipProvider
```
public AtomixClusterBuilder withMembershipProvider(NodeDiscoveryProvider locationProvider)
```
    Sets the cluster membership provider.
    The membership provider determines how peers are located and the cluster is bootstrapped.
    
    Parameters:
    
    locationProvider - the membership provider
    
    Returns:
    
    the cluster builder
    
    See Also:
    
    BootstrapDiscoveryProvider, MulticastDiscoveryProvider
  - build
```
public AtomixCluster build()
```
    Specified by:
    
    build in interface io.atomix.utils.Builder<AtomixCluster>

Class AtomixClusterBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withClusterId

withMemberId

withMemberId

withAddress

withAddress

withAddress

withAddress

withZone

withRack

withHost

withProperties

withProperty

withMulticastEnabled

withMulticastEnabled

withMulticastAddress

setBroadcastInterval

setReachabilityThreshold

withReachabilityTimeout

withMembershipProvider

build