Class TransportConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

org.infinispan.configuration.global.TransportConfigurationBuilder

All Implemented Interfaces:

Builder<TransportConfiguration>, GlobalConfigurationChildBuilder

public class TransportConfigurationBuilder
extends AbstractGlobalConfigurationBuilder
implements Builder<TransportConfiguration>

Configures the transport used for network communications across the cluster.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TRANSPORT

Method Summary

Modifier and Type	Method	Description
TransportConfigurationBuilder	addProperty(String key, Object value)
AttributeSet	attributes()
TransportConfigurationBuilder	clearProperties()	Clears the transport properties
TransportConfigurationBuilder	clusterName(String clusterName)	Defines the name of the cluster.
TransportConfiguration	create()	Create the configuration bean
TransportConfigurationBuilder	defaultTransport()
TransportConfigurationBuilder	distributedSyncTimeout(long distributedSyncTimeout)	Timeout for coordinating cluster formation when nodes join or leave the cluster.
TransportConfigurationBuilder	distributedSyncTimeout(long distributedSyncTimeout, TimeUnit unit)	Timeout for coordinating cluster formation when nodes join or leave the cluster.
TransportConfigurationBuilder	distributedSyncTimeout(String distributedSyncTimeout)	Same as distributedSyncTimeout(long) but supporting time units
String	getProperty(String key)
Transport	getTransport()
TransportConfigurationBuilder	initialClusterSize(int clusterSize)	Sets the number of nodes that need to join before the cache container can start.
TransportConfigurationBuilder	initialClusterTimeout(long initialClusterTimeout, TimeUnit unit)	Sets the timeout for the initial cluster to form.
TransportConfigurationBuilder	initialClusterTimeout(String initialClusterTimeout)	Same as initialClusterTimeout(long, TimeUnit) but supporting time units.
JGroupsConfigurationBuilder	jgroups()
TransportConfigurationBuilder	machineId(String machineId)	The id of the machine where this node runs.
TransportConfigurationBuilder	nodeName(String nodeName)	Name of the current node.
TransportConfigurationBuilder	rackId(String rackId)	The id of the rack where this node runs.
TransportConfigurationBuilder	raftMember(String member)	Adds a single member to the raft-members.
TransportConfigurationBuilder	raftMembers(String... members)	Adds multiple members to the raft-members.
TransportConfigurationBuilder	raftMembers(Collection<String> members)	Adds multiple members to the raft-members.
TransportConfigurationBuilder	read(TransportConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
ThreadPoolConfigurationBuilder	remoteCommandThreadPool()
TransportConfigurationBuilder	removeProperty(String key)
TransportConfigurationBuilder	siteId(String siteId)	The id of the site where this node runs.
TransportConfigurationBuilder	stack(String stack)
String	toString()
TransportConfigurationBuilder	transport(Transport transport)	Class that represents a network transport.
TransportConfigurationBuilder	transportExecutor(String threadPoolName)	Deprecated, for removal: This API element is subject to removal in a future version.
ThreadPoolConfigurationBuilder	transportThreadPool()
void	validate()	Validate the data in this builder before building the configuration bean
TransportConfigurationBuilder	withProperties(Properties properties)	Sets transport properties

Methods inherited from class org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

addModule, asyncThreadPool, blockingThreadPool, build, clearModules, defaultCacheName, expirationThreadPool, getGlobalConfig, globalState, jmx, listenerThreadPool, metrics, module, modules, nonBlockingThreadPool, persistenceThreadPool, security, serialization, shutdown, site, tracing, transport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset

Field Details

DEFAULT_TRANSPORT

public static final String DEFAULT_TRANSPORT

See Also:

• Constant Field Values

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<TransportConfiguration>

clusterName

public TransportConfigurationBuilder clusterName(String clusterName)

Defines the name of the cluster. Nodes only connect to clusters sharing the same name.

Parameters:

clusterName -

machineId

public TransportConfigurationBuilder machineId(String machineId)

The id of the machine where this node runs. Used for server hinting .

rackId

public TransportConfigurationBuilder rackId(String rackId)

The id of the rack where this node runs. Used for server hinting .

siteId

public TransportConfigurationBuilder siteId(String siteId)

The id of the site where this node runs. Used for server hinting .

stack

public TransportConfigurationBuilder stack(String stack)

distributedSyncTimeout

public TransportConfigurationBuilder distributedSyncTimeout(long distributedSyncTimeout)

Timeout for coordinating cluster formation when nodes join or leave the cluster.

Parameters:

distributedSyncTimeout -

Returns:

distributedSyncTimeout

public TransportConfigurationBuilder distributedSyncTimeout(String distributedSyncTimeout)

Same as distributedSyncTimeout(long) but supporting time units

distributedSyncTimeout

public TransportConfigurationBuilder distributedSyncTimeout(long distributedSyncTimeout,
 TimeUnit unit)

Timeout for coordinating cluster formation when nodes join or leave the cluster.

Parameters:

distributedSyncTimeout -

Returns:

initialClusterSize

public TransportConfigurationBuilder initialClusterSize(int clusterSize)

Sets the number of nodes that need to join before the cache container can start. The default is to start immediately without waiting.

initialClusterTimeout

public TransportConfigurationBuilder initialClusterTimeout(long initialClusterTimeout,
 TimeUnit unit)

Sets the timeout for the initial cluster to form. Defaults to 1 minute

initialClusterTimeout

public TransportConfigurationBuilder initialClusterTimeout(String initialClusterTimeout)

Same as initialClusterTimeout(long, TimeUnit) but supporting time units.

transport

public TransportConfigurationBuilder transport(Transport transport)

Class that represents a network transport. Must implement org.infinispan.remoting.transport.Transport

Parameters:

transport - transport instance

nodeName

public TransportConfigurationBuilder nodeName(String nodeName)

Name of the current node. This is a friendly name to make logs, etc. make more sense. Defaults to a combination of host name and a random number (to differentiate multiple nodes on the same host)

Parameters:

nodeName -

withProperties

public TransportConfigurationBuilder withProperties(Properties properties)

Sets transport properties

Parameters:

properties -

Returns:

this TransportConfig

clearProperties

public TransportConfigurationBuilder clearProperties()

Clears the transport properties

Returns:

this TransportConfig

addProperty

public TransportConfigurationBuilder addProperty(String key,
 Object value)

removeProperty

public TransportConfigurationBuilder removeProperty(String key)

getProperty

public String getProperty(String key)

transportThreadPool

public ThreadPoolConfigurationBuilder transportThreadPool()

remoteCommandThreadPool

public ThreadPoolConfigurationBuilder remoteCommandThreadPool()

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<TransportConfiguration>

jgroups

public JGroupsConfigurationBuilder jgroups()

create

public TransportConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<TransportConfiguration>

Returns:

defaultTransport

public TransportConfigurationBuilder defaultTransport()

transportExecutor

@Deprecated(forRemoval=true,
            since="11.0")
public TransportConfigurationBuilder transportExecutor(String threadPoolName)

Deprecated, for removal: This API element is subject to removal in a future version.

raftMember

public TransportConfigurationBuilder raftMember(String member)

Adds a single member to the raft-members.

Parameters:

member - The member to add

raftMembers

public TransportConfigurationBuilder raftMembers(String... members)

Adds multiple members to the raft-members.

Parameters:

members - The members to add

raftMembers

public TransportConfigurationBuilder raftMembers(Collection<String> members)

Adds multiple members to the raft-members.

Parameters:

members - The members to add

read

public TransportConfigurationBuilder read(TransportConfiguration template,
 Combine combine)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<TransportConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

combine - the way attributes and children of this instance and the template should be combined.

getTransport

public Transport getTransport()

toString

public String toString()

Overrides:

toString in class Object