Package org.infinispan.configuration.global

Class TransportConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.TransportConfigurationBuilder

All Implemented Interfaces:

Builder<TransportConfiguration>, GlobalConfigurationChildBuilder

public class TransportConfigurationBuilder
extends Object
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)
ThreadPoolConfigurationBuilder	asyncThreadPool()	Configuration for the asynchronous operations thread pool
AttributeSet	attributes()
ThreadPoolConfigurationBuilder	blockingThreadPool()	Configuration for the blocking thread pool
GlobalConfiguration	build()	Builds a GlobalConfiguration object using the settings applied to this builder
TransportConfigurationBuilder	clearProperties()	Clears the transport properties
TransportConfigurationBuilder	clusterName(String clusterName)	Defines the name of the cluster.
TransportConfiguration	create()	Create the configuration bean
GlobalConfigurationBuilder	defaultCacheName(String defaultCacheName)	Sets the name of the cache that acts as the default cache and is returned by EmbeddedCacheManager.getCache().
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.
ThreadPoolConfigurationBuilder	expirationThreadPool()	Configuration for the expiration thread pool
protected GlobalConfigurationBuilder	getGlobalConfig()
String	getProperty(String key)
Transport	getTransport()
GlobalStateConfigurationBuilder	globalState()	Global state configuration
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.
JGroupsConfigurationBuilder	jgroups()
GlobalJmxConfigurationBuilder	jmx()	Global JMX configuration.
ThreadPoolConfigurationBuilder	listenerThreadPool()	Configuration for the listener thread pool
TransportConfigurationBuilder	machineId(String machineId)	The id of the machine where this node runs.
GlobalMetricsConfigurationBuilder	metrics()	Global metrics configuration.
List<Builder<?>>	modules()	Global modules configuration
TransportConfigurationBuilder	nodeName(String nodeName)	Name of the current node.
ThreadPoolConfigurationBuilder	nonBlockingThreadPool()	Configuration for the non blocking thread pool
ThreadPoolConfigurationBuilder	persistenceThreadPool()	Configuration for the persistence thread pool
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	remoteExecutor(String threadPoolName)
TransportConfigurationBuilder	removeProperty(String key)
GlobalSecurityConfigurationBuilder	security()	Security-related configuration
SerializationConfigurationBuilder	serialization()	Global serialization (i.e.
ShutdownConfigurationBuilder	shutdown()	Shutdown configuration
SiteConfigurationBuilder	site()	Cross-site replication configuration
TransportConfigurationBuilder	siteId(String siteId)	The id of the site where this node runs.
TransportConfigurationBuilder	stack(String stack)
ThreadPoolConfigurationBuilder	stateTransferThreadPool()	Configuration for the state-transfer thread pool
String	toString()
TransportConfigurationBuilder	transport()	Transport-related (i.e.
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 java.lang.Object

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

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

read, reset

Methods inherited from interface org.infinispan.configuration.global.GlobalConfigurationChildBuilder

globalJmxStatistics

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(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

transport

public TransportConfigurationBuilder transport(Transport transport)

Class that represents a network transport. Must implement org.infinispan.remoting.transport.Transport NOTE: Currently Infinispan will not use the object instance, but instead instantiate a new instance of the class. Therefore, do not expect any state to survive, and provide a no-args constructor to any instance.

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)
public TransportConfigurationBuilder transportExecutor(String threadPoolName)

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

remoteExecutor

public TransportConfigurationBuilder remoteExecutor(String threadPoolName)

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

getGlobalConfig

protected GlobalConfigurationBuilder getGlobalConfig()

transport

public TransportConfigurationBuilder transport()

Description copied from interface: GlobalConfigurationChildBuilder

Transport-related (i.e. clustering) configuration

Specified by:

transport in interface GlobalConfigurationChildBuilder

metrics

public GlobalMetricsConfigurationBuilder metrics()

Description copied from interface: GlobalConfigurationChildBuilder

Global metrics configuration.

Specified by:

metrics in interface GlobalConfigurationChildBuilder

jmx

public GlobalJmxConfigurationBuilder jmx()

Description copied from interface: GlobalConfigurationChildBuilder

Global JMX configuration.

Specified by:

jmx in interface GlobalConfigurationChildBuilder

globalState

public GlobalStateConfigurationBuilder globalState()

Description copied from interface: GlobalConfigurationChildBuilder

Global state configuration

Specified by:

globalState in interface GlobalConfigurationChildBuilder

serialization

public SerializationConfigurationBuilder serialization()

Description copied from interface: GlobalConfigurationChildBuilder

Global serialization (i.e. marshalling) configuration

Specified by:

serialization in interface GlobalConfigurationChildBuilder

listenerThreadPool

public ThreadPoolConfigurationBuilder listenerThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the listener thread pool

Specified by:

listenerThreadPool in interface GlobalConfigurationChildBuilder

asyncThreadPool

public ThreadPoolConfigurationBuilder asyncThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the asynchronous operations thread pool

Specified by:

asyncThreadPool in interface GlobalConfigurationChildBuilder

expirationThreadPool

public ThreadPoolConfigurationBuilder expirationThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the expiration thread pool

Specified by:

expirationThreadPool in interface GlobalConfigurationChildBuilder

persistenceThreadPool

public ThreadPoolConfigurationBuilder persistenceThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the persistence thread pool

Specified by:

persistenceThreadPool in interface GlobalConfigurationChildBuilder

stateTransferThreadPool

public ThreadPoolConfigurationBuilder stateTransferThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the state-transfer thread pool

Specified by:

stateTransferThreadPool in interface GlobalConfigurationChildBuilder

blockingThreadPool

public ThreadPoolConfigurationBuilder blockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the blocking thread pool

Specified by:

blockingThreadPool in interface GlobalConfigurationChildBuilder

nonBlockingThreadPool

public ThreadPoolConfigurationBuilder nonBlockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the non blocking thread pool

Specified by:

nonBlockingThreadPool in interface GlobalConfigurationChildBuilder

security

public GlobalSecurityConfigurationBuilder security()

Description copied from interface: GlobalConfigurationChildBuilder

Security-related configuration

Specified by:

security in interface GlobalConfigurationChildBuilder

shutdown

public ShutdownConfigurationBuilder shutdown()

Description copied from interface: GlobalConfigurationChildBuilder

Shutdown configuration

Specified by:

shutdown in interface GlobalConfigurationChildBuilder

site

public SiteConfigurationBuilder site()

Description copied from interface: GlobalConfigurationChildBuilder

Cross-site replication configuration

Specified by:

site in interface GlobalConfigurationChildBuilder

modules

public List<Builder<?>> modules()

Description copied from interface: GlobalConfigurationChildBuilder

Global modules configuration

Specified by:

modules in interface GlobalConfigurationChildBuilder

defaultCacheName

public GlobalConfigurationBuilder defaultCacheName(String defaultCacheName)

Description copied from interface: GlobalConfigurationChildBuilder

Sets the name of the cache that acts as the default cache and is returned by EmbeddedCacheManager.getCache(). Not

Specified by:

defaultCacheName in interface GlobalConfigurationChildBuilder

build

public GlobalConfiguration build()

Description copied from interface: GlobalConfigurationChildBuilder

Builds a GlobalConfiguration object using the settings applied to this builder

Specified by:

build in interface GlobalConfigurationChildBuilder