TransportConfigurationBuilder (JBoss Data Grid 7.1.0 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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TransportConfigurationBuilder`	`addProperty(String key, String value)`
`ThreadPoolConfigurationBuilder`	`asyncThreadPool()`
`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.
`ThreadPoolConfigurationBuilder`	`evictionThreadPool()` Deprecated.
`ThreadPoolConfigurationBuilder`	`expirationThreadPool()`
`protected GlobalConfigurationBuilder`	`getGlobalConfig()`
`String`	`getProperty(String key)`
`Transport`	`getTransport()`
`GlobalJmxStatisticsConfigurationBuilder`	`globalJmxStatistics()`
`GlobalStateConfigurationBuilder`	`globalState()`
`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.
`ThreadPoolConfigurationBuilder`	`listenerThreadPool()`
`TransportConfigurationBuilder`	`machineId(String machineId)` The id of the machine where this node runs.
`TransportConfigurationBuilder`	`nodeName(String nodeName)` Name of the current node.
`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.
`ThreadPoolConfigurationBuilder`	`remoteCommandThreadPool()`
`TransportConfigurationBuilder`	`removeProperty(String key)`
`ThreadPoolConfigurationBuilder`	`replicationQueueThreadPool()`
`GlobalSecurityConfigurationBuilder`	`security()`
`SerializationConfigurationBuilder`	`serialization()`
`ShutdownConfigurationBuilder`	`shutdown()`
`SiteConfigurationBuilder`	`site()`
`TransportConfigurationBuilder`	`siteId(String siteId)` The id of the site where this node runs.
`ThreadPoolConfigurationBuilder`	`stateTransferThreadPool()`
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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:
  - 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. 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
  - getGlobalConfig
```
protected GlobalConfigurationBuilder getGlobalConfig()
```
  - transport
```
public TransportConfigurationBuilder transport()
```
    Specified by:
    
    transport in interface GlobalConfigurationChildBuilder
  - globalJmxStatistics
```
public GlobalJmxStatisticsConfigurationBuilder globalJmxStatistics()
```
    Specified by:
    
    globalJmxStatistics in interface GlobalConfigurationChildBuilder
  - globalState
```
public GlobalStateConfigurationBuilder globalState()
```
    Specified by:
    
    globalState in interface GlobalConfigurationChildBuilder
  - serialization
```
public SerializationConfigurationBuilder serialization()
```
    Specified by:
    
    serialization in interface GlobalConfigurationChildBuilder
  - listenerThreadPool
```
public ThreadPoolConfigurationBuilder listenerThreadPool()
```
    Specified by:
    
    listenerThreadPool in interface GlobalConfigurationChildBuilder
  - asyncThreadPool
```
public ThreadPoolConfigurationBuilder asyncThreadPool()
```
    Specified by:
    
    asyncThreadPool in interface GlobalConfigurationChildBuilder
  - replicationQueueThreadPool
```
public ThreadPoolConfigurationBuilder replicationQueueThreadPool()
```
    Specified by:
    
    replicationQueueThreadPool in interface GlobalConfigurationChildBuilder
  - evictionThreadPool
```
@Deprecated
public ThreadPoolConfigurationBuilder evictionThreadPool()
```
    Deprecated.
    
    Description copied from interface: GlobalConfigurationChildBuilder
    
    Please use GlobalConfigurationChildBuilder.expirationThreadPool()
    
    Specified by:
    
    evictionThreadPool in interface GlobalConfigurationChildBuilder
  - expirationThreadPool
```
public ThreadPoolConfigurationBuilder expirationThreadPool()
```
    Specified by:
    
    expirationThreadPool in interface GlobalConfigurationChildBuilder
  - persistenceThreadPool
```
public ThreadPoolConfigurationBuilder persistenceThreadPool()
```
    Specified by:
    
    persistenceThreadPool in interface GlobalConfigurationChildBuilder
  - stateTransferThreadPool
```
public ThreadPoolConfigurationBuilder stateTransferThreadPool()
```
    Specified by:
    
    stateTransferThreadPool 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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TRANSPORT

Method Detail

clusterName

machineId

rackId

siteId

distributedSyncTimeout

distributedSyncTimeout

initialClusterSize

initialClusterTimeout

transport

nodeName

withProperties

clearProperties

addProperty

removeProperty

getProperty

strictPeerToPeer

transportThreadPool

remoteCommandThreadPool

totalOrderThreadPool

validate

create

defaultTransport

read

getTransport

toString

getGlobalConfig

transport

globalJmxStatistics

globalState

serialization

listenerThreadPool

asyncThreadPool

replicationQueueThreadPool

evictionThreadPool

expirationThreadPool

persistenceThreadPool

stateTransferThreadPool

security

shutdown

site

build