io.atomix.cluster

Class AtomixClusterBuilder

java.lang.Object

io.atomix.cluster.AtomixClusterBuilder

All Implemented Interfaces:

Builder<AtomixCluster>

Direct Known Subclasses:

AtomixBuilder

public class AtomixClusterBuilder
extends Object
implements Builder<AtomixCluster>

Atomix cluster builder.

Method Summary

Modifier and Type	Method and Description
AtomixCluster	build() Builds the object.
AtomixClusterBuilder	setBroadcastInterval(Duration interval) Sets the reachability broadcast interval.
AtomixClusterBuilder	setReachabilityThreshold(int threshold) Sets the reachability failure detection threshold.
AtomixClusterBuilder	withAddress(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 membership provider.
AtomixClusterBuilder	withMulticastAddress(Address address) Sets the multicast address.
AtomixClusterBuilder	withMulticastEnabled() Enables multicast node discovery.
AtomixClusterBuilder	withMulticastEnabled(boolean multicastEnabled) Sets whether multicast node discovery 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.

Parameters:

clusterId - the cluster identifier

Returns:

the cluster builder

withMemberId

public AtomixClusterBuilder withMemberId(String localMemberId)

Sets the local member identifier.

Parameters:

localMemberId - the local member identifier

Returns:

the cluster builder

withMemberId

public AtomixClusterBuilder withMemberId(MemberId localMemberId)

Sets the local member identifier.

Parameters:

localMemberId - the local member identifier

Returns:

the cluster builder

withAddress

public AtomixClusterBuilder withAddress(String address)

Sets the member address.

Parameters:

address - a host:port tuple

Returns:

the member builder

Throws:

MalformedAddressException - if a valid Address cannot be constructed from the arguments

withAddress

public AtomixClusterBuilder withAddress(String host,
                                        int port)

Sets the member host/port.

Parameters:

host - the host name

port - the port number

Returns:

the member builder

Throws:

MalformedAddressException - if a valid Address cannot be constructed from the arguments

withAddress

public AtomixClusterBuilder withAddress(int port)

Sets the member address using local host.

Parameters:

port - the port number

Returns:

the member builder

Throws:

MalformedAddressException - if a valid Address cannot be constructed from the arguments

withAddress

public AtomixClusterBuilder withAddress(Address address)

Sets the member address.

Parameters:

address - the member address

Returns:

the member builder

withZone

public AtomixClusterBuilder withZone(String zone)

Sets the zone to which the member belongs.

Parameters:

zone - the zone to which the member belongs

Returns:

the member builder

withRack

public AtomixClusterBuilder withRack(String rack)

Sets the rack to which the member belongs.

Parameters:

rack - the rack to which the member belongs

Returns:

the member builder

withHost

public AtomixClusterBuilder withHost(String host)

Sets the host to which the member belongs.

Parameters:

host - the host to which the member belongs

Returns:

the member builder

withProperties

public AtomixClusterBuilder withProperties(Properties properties)

Sets the member properties.

Parameters:

properties - the member properties

Returns:

the member builder

Throws:

NullPointerException - if the properties are null

withProperty

public AtomixClusterBuilder withProperty(String key,
                                         String value)

Sets a property of the member.

Parameters:

key - the property key to set

value - the property value to set

Returns:

the member builder

Throws:

NullPointerException - if the property is null

withMulticastEnabled

public AtomixClusterBuilder withMulticastEnabled()

Enables multicast node discovery.

Returns:

the Atomix builder

withMulticastEnabled

public AtomixClusterBuilder withMulticastEnabled(boolean multicastEnabled)

Sets whether multicast node discovery is enabled.

Parameters:

multicastEnabled - whether to enable multicast node discovery

Returns:

the Atomix builder

withMulticastAddress

public AtomixClusterBuilder withMulticastAddress(Address address)

Sets the multicast address.

Parameters:

address - the multicast address

Returns:

the Atomix builder

setBroadcastInterval

public AtomixClusterBuilder setBroadcastInterval(Duration interval)

Sets the reachability broadcast interval.

Parameters:

interval - the reachability broadcast interval

Returns:

the Atomix builder

setReachabilityThreshold

public AtomixClusterBuilder setReachabilityThreshold(int threshold)

Sets the reachability failure detection threshold.

Parameters:

threshold - the reachability failure detection threshold

Returns:

the Atomix builder

withReachabilityTimeout

public AtomixClusterBuilder withReachabilityTimeout(Duration timeout)

Sets the reachability failure timeout.

Parameters:

timeout - the reachability failure timeout

Returns:

the Atomix builder

withMembershipProvider

public AtomixClusterBuilder withMembershipProvider(NodeDiscoveryProvider locationProvider)

Sets the membership provider.

Parameters:

locationProvider - the membership provider

Returns:

the Atomix cluster builder

build

public AtomixCluster build()

Description copied from interface: Builder

Builds the object.

The returned object may be a new instance of the built class or a recycled instance, depending on the semantics of the builder implementation. Users should never assume that a builder allocates a new instance.

Specified by:

build in interface Builder<AtomixCluster>

Returns:

The built object.