TransportConfigurationBuilder (Infinispan Distribution 7.1.0.Beta1 API)

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 and Description

static String DEFAULT_TRANSPORT

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_TRANSPORT`

Method Summary

Methods
Modifier and Type	Method and Description
`TransportConfigurationBuilder`	`addProperty(String key, String value)`
`ExecutorFactoryConfigurationBuilder`	`asyncListenerExecutor()` Deprecated. This method always returns null now. Set thread pool via `listenerThreadPool()` instead.
`ExecutorFactoryConfigurationBuilder`	`asyncTransportExecutor()`
`GlobalConfiguration`	`build()`
`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.
`boolean`	`equals(Object o)`
`ScheduledExecutorFactoryConfigurationBuilder`	`evictionScheduledExecutor()` Deprecated. This method always returns null now. Set thread pool via `evictionThreadPool()` instead.
`ThreadPoolConfigurationBuilder`	`evictionThreadPool()`
`protected GlobalConfigurationBuilder`	`getGlobalConfig()`
`String`	`getProperty(String key)`
`Transport`	`getTransport()`
`GlobalJmxStatisticsConfigurationBuilder`	`globalJmxStatistics()`
`int`	`hashCode()`
`ThreadPoolConfigurationBuilder`	`listenerThreadPool()`
`TransportConfigurationBuilder`	`machineId(String machineId)` The id of the machine where this node runs.
`TransportConfigurationBuilder`	`nodeName(String nodeName)` Name of the current node.
`ExecutorFactoryConfigurationBuilder`	`persistenceExecutor()` Deprecated. This method always returns null now. Set thread pool via `persistenceThreadPool()` instead.
`ThreadPoolConfigurationBuilder`	`persistenceThreadPool()`
`TransportConfigurationBuilder`	`rackId(String rackId)` The id of the rack where this node runs.
`TransportConfigurationBuilder`	`read(TransportConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`ExecutorFactoryConfigurationBuilder`	`remoteCommandsExecutor()` Deprecated. This method always returns null now. Set thread pool via `TransportConfigurationBuilder.remoteCommandThreadPool()` instead.
`ThreadPoolConfigurationBuilder`	`remoteCommandThreadPool()`
`TransportConfigurationBuilder`	`removeProperty(String key)`
`ScheduledExecutorFactoryConfigurationBuilder`	`replicationQueueScheduledExecutor()` Deprecated. This method always returns null now. Set thread pool via `replicationQueueThreadPool()` instead.
`ThreadPoolConfigurationBuilder`	`replicationQueueThreadPool()`
`GlobalSecurityConfigurationBuilder`	`security()`
`SerializationConfigurationBuilder`	`serialization()`
`ShutdownConfigurationBuilder`	`shutdown()`
`SiteConfigurationBuilder`	`site()`
`TransportConfigurationBuilder`	`siteId(String siteId)` The id of the site where this node runs.
`TransportConfigurationBuilder`	`strictPeerToPeer(Boolean ignored)` Deprecated. Since 6.0, strictPeerToPeer is ignored and asymmetric clusters are always allowed.
`String`	`toString()`
`ThreadPoolConfigurationBuilder`	`totalOrderThreadPool()` Deprecated.
`TransportConfigurationBuilder`	`transport()`
`TransportConfigurationBuilder`	`transport(Transport transport)` Class that represents a network transport.
`ThreadPoolConfigurationBuilder`	`transportThreadPool()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`TransportConfigurationBuilder`	`withProperties(Properties properties)` Sets transport properties

- Field Detail
  - DEFAULT_TRANSPORT
```
public static final String DEFAULT_TRANSPORT
```
    See Also:
    Constant Field Values
- Method Detail
  - 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 .
  - 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:
  - 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. This will be resolved in Infinispan 5.2.0
    
    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,
                                        String value)
```
  - removeProperty
```
public TransportConfigurationBuilder removeProperty(String key)
```
  - getProperty
```
public String getProperty(String key)
```
  - strictPeerToPeer
```
@Deprecated
public TransportConfigurationBuilder strictPeerToPeer(Boolean ignored)
```
    Deprecated. Since 6.0, strictPeerToPeer is ignored and asymmetric clusters are always allowed.
  - transportThreadPool
```
public ThreadPoolConfigurationBuilder transportThreadPool()
```
  - remoteCommandThreadPool
```
public ThreadPoolConfigurationBuilder remoteCommandThreadPool()
```
  - totalOrderThreadPool
```
@Deprecated
public ThreadPoolConfigurationBuilder totalOrderThreadPool()
```
    Deprecated.
  - 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>
  - 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()
```
  - read
```
public TransportConfigurationBuilder read(TransportConfiguration template)
```
    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.
  - getTransport
```
public Transport getTransport()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getGlobalConfig
```
protected GlobalConfigurationBuilder getGlobalConfig()
```
  - transport
```
public TransportConfigurationBuilder transport()
```
    Specified by:
    
    transport in interface GlobalConfigurationChildBuilder
  - globalJmxStatistics
```
public GlobalJmxStatisticsConfigurationBuilder globalJmxStatistics()
```
    Specified by:
    
    globalJmxStatistics in interface GlobalConfigurationChildBuilder
  - serialization
```
public SerializationConfigurationBuilder serialization()
```
    Specified by:
    
    serialization in interface GlobalConfigurationChildBuilder
  - asyncListenerExecutor
```
@Deprecated
public ExecutorFactoryConfigurationBuilder asyncListenerExecutor()
```
    Deprecated. This method always returns null now. Set thread pool via listenerThreadPool() instead.
    
    Specified by:
    
    asyncListenerExecutor in interface GlobalConfigurationChildBuilder
  - persistenceExecutor
```
@Deprecated
public ExecutorFactoryConfigurationBuilder persistenceExecutor()
```
    Deprecated. This method always returns null now. Set thread pool via persistenceThreadPool() instead.
    
    Specified by:
    
    persistenceExecutor in interface GlobalConfigurationChildBuilder
  - asyncTransportExecutor
```
public ExecutorFactoryConfigurationBuilder asyncTransportExecutor()
```
    Specified by:
    
    asyncTransportExecutor in interface GlobalConfigurationChildBuilder
  - remoteCommandsExecutor
```
@Deprecated
public ExecutorFactoryConfigurationBuilder remoteCommandsExecutor()
```
    Deprecated. This method always returns null now. Set thread pool via TransportConfigurationBuilder.remoteCommandThreadPool() instead.
    
    Specified by:
    
    remoteCommandsExecutor in interface GlobalConfigurationChildBuilder
  - evictionScheduledExecutor
```
@Deprecated
public ScheduledExecutorFactoryConfigurationBuilder evictionScheduledExecutor()
```
    Deprecated. This method always returns null now. Set thread pool via evictionThreadPool() instead.
    
    Specified by:
    
    evictionScheduledExecutor in interface GlobalConfigurationChildBuilder
  - replicationQueueScheduledExecutor
```
@Deprecated
public ScheduledExecutorFactoryConfigurationBuilder replicationQueueScheduledExecutor()
```
    Deprecated. This method always returns null now. Set thread pool via replicationQueueThreadPool() instead.
    
    Specified by:
    
    replicationQueueScheduledExecutor in interface GlobalConfigurationChildBuilder
  - listenerThreadPool
```
public ThreadPoolConfigurationBuilder listenerThreadPool()
```
    Specified by:
    
    listenerThreadPool in interface GlobalConfigurationChildBuilder
  - replicationQueueThreadPool
```
public ThreadPoolConfigurationBuilder replicationQueueThreadPool()
```
    Specified by:
    
    replicationQueueThreadPool in interface GlobalConfigurationChildBuilder
  - evictionThreadPool
```
public ThreadPoolConfigurationBuilder evictionThreadPool()
```
    Specified by:
    
    evictionThreadPool in interface GlobalConfigurationChildBuilder
  - persistenceThreadPool
```
public ThreadPoolConfigurationBuilder persistenceThreadPool()
```
    Specified by:
    
    persistenceThreadPool in interface GlobalConfigurationChildBuilder
  - security
```
public GlobalSecurityConfigurationBuilder security()
```
    Specified by:
    
    security in interface GlobalConfigurationChildBuilder
  - shutdown
```
public ShutdownConfigurationBuilder shutdown()
```
    Specified by:
    
    shutdown in interface GlobalConfigurationChildBuilder
  - site
```
public SiteConfigurationBuilder site()
```
    Specified by:
    
    site in interface GlobalConfigurationChildBuilder
  - build
```
public GlobalConfiguration build()
```
    Specified by:
    
    build in interface GlobalConfigurationChildBuilder

Class TransportConfigurationBuilder

Field Summary

Method Summary

Field Detail

DEFAULT_TRANSPORT

Method Detail

clusterName

machineId

rackId

siteId

distributedSyncTimeout

distributedSyncTimeout

transport

nodeName

withProperties

clearProperties

addProperty

removeProperty

getProperty

strictPeerToPeer

transportThreadPool

remoteCommandThreadPool

totalOrderThreadPool

validate

create

defaultTransport

read

getTransport

toString

equals

hashCode

getGlobalConfig

transport

globalJmxStatistics

serialization

asyncListenerExecutor

persistenceExecutor

asyncTransportExecutor

remoteCommandsExecutor

evictionScheduledExecutor

replicationQueueScheduledExecutor

listenerThreadPool

replicationQueueThreadPool

evictionThreadPool

persistenceThreadPool

security

shutdown

site

build