io.atomix.core

Class AtomixBuilder

java.lang.Object

io.atomix.cluster.AtomixClusterBuilder

io.atomix.core.AtomixBuilder

All Implemented Interfaces:

Builder<AtomixCluster>

public class AtomixBuilder
extends AtomixClusterBuilder

Atomix builder.

Method Summary

Modifier and Type	Method and Description
AtomixBuilder	addPartitionGroup(ManagedPartitionGroup partitionGroup) Adds a partition group.
AtomixBuilder	addProfile(Profile profile) Adds an Atomix profile.
Atomix	build() Builds a new Atomix instance.
AtomixBuilder	setBroadcastInterval(Duration interval) Sets the reachability broadcast interval.
AtomixBuilder	setReachabilityThreshold(int threshold) Sets the reachability failure detection threshold.
AtomixBuilder	withAddress(Address address) Sets the member address.
AtomixBuilder	withAddress(int port) Sets the member address using local host.
AtomixBuilder	withAddress(String address) Sets the member address.
AtomixBuilder	withAddress(String host, int port) Sets the member host/port.
AtomixBuilder	withClusterId(String clusterId) Sets the cluster identifier.
AtomixBuilder	withHost(String host) Sets the host to which the member belongs.
AtomixBuilder	withManagementGroup(ManagedPartitionGroup systemManagementGroup) Sets the system management partition group.
AtomixBuilder	withMemberId(MemberId localMemberId) Sets the local member identifier.
AtomixBuilder	withMemberId(String localMemberId) Sets the local member identifier.
AtomixBuilder	withMembershipProvider(NodeDiscoveryProvider locationProvider) Sets the membership provider.
AtomixBuilder	withMulticastAddress(Address address) Sets the multicast address.
AtomixBuilder	withMulticastEnabled() Enables multicast node discovery.
AtomixBuilder	withMulticastEnabled(boolean multicastEnabled) Sets whether multicast node discovery is enabled.
AtomixBuilder	withPartitionGroups(Collection<ManagedPartitionGroup> partitionGroups) Sets the partition groups.
AtomixBuilder	withPartitionGroups(ManagedPartitionGroup... partitionGroups) Sets the partition groups.
AtomixBuilder	withProfiles(Collection<Profile> profiles) Sets the Atomix profiles.
AtomixBuilder	withProfiles(Profile... profiles) Sets the Atomix profiles.
AtomixBuilder	withProperties(Properties properties) Sets the member properties.
AtomixBuilder	withProperty(String key, String value) Sets a property of the member.
AtomixBuilder	withRack(String rack) Sets the rack to which the member belongs.
AtomixBuilder	withReachabilityTimeout(Duration timeout) Sets the reachability failure timeout.
AtomixBuilder	withShutdownHook(boolean enabled) Enables the shutdown hook.
AtomixBuilder	withShutdownHookEnabled() Enables the shutdown hook.
AtomixBuilder	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

withShutdownHookEnabled

public AtomixBuilder withShutdownHookEnabled()

Enables the shutdown hook.

Returns:

the Atomix builder

withShutdownHook

public AtomixBuilder withShutdownHook(boolean enabled)

Enables the shutdown hook.

Parameters:

enabled - if true a shutdown hook will be registered

Returns:

the Atomix builder

withProfiles

public AtomixBuilder withProfiles(Profile... profiles)

Sets the Atomix profiles.

Parameters:

profiles - the profiles

Returns:

the Atomix builder

withProfiles

public AtomixBuilder withProfiles(Collection<Profile> profiles)

Sets the Atomix profiles.

Parameters:

profiles - the profiles

Returns:

the Atomix builder

addProfile

public AtomixBuilder addProfile(Profile profile)

Adds an Atomix profile.

Parameters:

profile - the profile to add

Returns:

the Atomix builder

withManagementGroup

public AtomixBuilder withManagementGroup(ManagedPartitionGroup systemManagementGroup)

Sets the system management partition group.

Parameters:

systemManagementGroup - the system management partition group

Returns:

the Atomix builder

withPartitionGroups

public AtomixBuilder withPartitionGroups(ManagedPartitionGroup... partitionGroups)

Sets the partition groups.

Parameters:

partitionGroups - the partition groups

Returns:

the Atomix builder

Throws:

NullPointerException - if the partition groups are null

withPartitionGroups

public AtomixBuilder withPartitionGroups(Collection<ManagedPartitionGroup> partitionGroups)

Sets the partition groups.

Parameters:

partitionGroups - the partition groups

Returns:

the Atomix builder

Throws:

NullPointerException - if the partition groups are null

addPartitionGroup

public AtomixBuilder addPartitionGroup(ManagedPartitionGroup partitionGroup)

Adds a partition group.

Parameters:

partitionGroup - the partition group to add

Returns:

the Atomix builder

Throws:

NullPointerException - if the partition group is null

withClusterId

public AtomixBuilder withClusterId(String clusterId)

Description copied from class: AtomixClusterBuilder

Sets the cluster identifier.

Overrides:

withClusterId in class AtomixClusterBuilder

Parameters:

clusterId - the cluster identifier

Returns:

the cluster builder

withMemberId

public AtomixBuilder withMemberId(String localMemberId)

Description copied from class: AtomixClusterBuilder

Sets the local member identifier.

Overrides:

withMemberId in class AtomixClusterBuilder

Parameters:

localMemberId - the local member identifier

Returns:

the cluster builder

withMemberId

public AtomixBuilder withMemberId(MemberId localMemberId)

Description copied from class: AtomixClusterBuilder

Sets the local member identifier.

Overrides:

withMemberId in class AtomixClusterBuilder

Parameters:

localMemberId - the local member identifier

Returns:

the cluster builder

withAddress

public AtomixBuilder withAddress(String address)

Description copied from class: AtomixClusterBuilder

Sets the member address.

Overrides:

withAddress in class AtomixClusterBuilder

Parameters:

address - a host:port tuple

Returns:

the member builder

withAddress

public AtomixBuilder withAddress(String host,
                                 int port)

Description copied from class: AtomixClusterBuilder

Sets the member host/port.

Overrides:

withAddress in class AtomixClusterBuilder

Parameters:

host - the host name

port - the port number

Returns:

the member builder

withAddress

public AtomixBuilder withAddress(int port)

Description copied from class: AtomixClusterBuilder

Sets the member address using local host.

Overrides:

withAddress in class AtomixClusterBuilder

Parameters:

port - the port number

Returns:

the member builder

withAddress

public AtomixBuilder withAddress(Address address)

Description copied from class: AtomixClusterBuilder

Sets the member address.

Overrides:

withAddress in class AtomixClusterBuilder

Parameters:

address - the member address

Returns:

the member builder

withZone

public AtomixBuilder withZone(String zone)

Description copied from class: AtomixClusterBuilder

Sets the zone to which the member belongs.

Overrides:

withZone in class AtomixClusterBuilder

Parameters:

zone - the zone to which the member belongs

Returns:

the member builder

withRack

public AtomixBuilder withRack(String rack)

Description copied from class: AtomixClusterBuilder

Sets the rack to which the member belongs.

Overrides:

withRack in class AtomixClusterBuilder

Parameters:

rack - the rack to which the member belongs

Returns:

the member builder

withHost

public AtomixBuilder withHost(String host)

Description copied from class: AtomixClusterBuilder

Sets the host to which the member belongs.

Overrides:

withHost in class AtomixClusterBuilder

Parameters:

host - the host to which the member belongs

Returns:

the member builder

withProperties

public AtomixBuilder withProperties(Properties properties)

Description copied from class: AtomixClusterBuilder

Sets the member properties.

Overrides:

withProperties in class AtomixClusterBuilder

Parameters:

properties - the member properties

Returns:

the member builder

withProperty

public AtomixBuilder withProperty(String key,
                                  String value)

Description copied from class: AtomixClusterBuilder

Sets a property of the member.

Overrides:

withProperty in class AtomixClusterBuilder

Parameters:

key - the property key to set

value - the property value to set

Returns:

the member builder

withMulticastEnabled

public AtomixBuilder withMulticastEnabled()

Description copied from class: AtomixClusterBuilder

Enables multicast node discovery.

Overrides:

withMulticastEnabled in class AtomixClusterBuilder

Returns:

the Atomix builder

withMulticastEnabled

public AtomixBuilder withMulticastEnabled(boolean multicastEnabled)

Description copied from class: AtomixClusterBuilder

Sets whether multicast node discovery is enabled.

Overrides:

withMulticastEnabled in class AtomixClusterBuilder

Parameters:

multicastEnabled - whether to enable multicast node discovery

Returns:

the Atomix builder

withMulticastAddress

public AtomixBuilder withMulticastAddress(Address address)

Description copied from class: AtomixClusterBuilder

Sets the multicast address.

Overrides:

withMulticastAddress in class AtomixClusterBuilder

Parameters:

address - the multicast address

Returns:

the Atomix builder

withMembershipProvider

public AtomixBuilder withMembershipProvider(NodeDiscoveryProvider locationProvider)

Description copied from class: AtomixClusterBuilder

Sets the membership provider.

Overrides:

withMembershipProvider in class AtomixClusterBuilder

Parameters:

locationProvider - the membership provider

Returns:

the Atomix cluster builder

setBroadcastInterval

public AtomixBuilder setBroadcastInterval(Duration interval)

Description copied from class: AtomixClusterBuilder

Sets the reachability broadcast interval.

Overrides:

setBroadcastInterval in class AtomixClusterBuilder

Parameters:

interval - the reachability broadcast interval

Returns:

the Atomix builder

setReachabilityThreshold

public AtomixBuilder setReachabilityThreshold(int threshold)

Description copied from class: AtomixClusterBuilder

Sets the reachability failure detection threshold.

Overrides:

setReachabilityThreshold in class AtomixClusterBuilder

Parameters:

threshold - the reachability failure detection threshold

Returns:

the Atomix builder

withReachabilityTimeout

public AtomixBuilder withReachabilityTimeout(Duration timeout)

Description copied from class: AtomixClusterBuilder

Sets the reachability failure timeout.

Overrides:

withReachabilityTimeout in class AtomixClusterBuilder

Parameters:

timeout - the reachability failure timeout

Returns:

the Atomix builder

build

public Atomix build()

Builds a new Atomix instance.

Specified by:

build in interface Builder<AtomixCluster>

Overrides:

build in class AtomixClusterBuilder

Returns:

a new Atomix instance