Remoting (BOM: * : All 2.3.0.Final API)

java.lang.Object
- org.wildfly.swarm.config.Remoting<T>

Direct Known Subclasses:

RemotingFraction
```
public class Remoting<T extends Remoting<T>>
extends Object
```
The configuration of the Remoting subsystem.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Remoting.RemotingResources
Child mutators for Remoting

Nested Classes
Modifier and Type	Class and Description
`static class`	`Remoting.RemotingResources` Child mutators for Remoting

Constructor Summary

Constructors
Constructor and Description

Remoting()

Constructors
Constructor and Description
`Remoting()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener
`Integer`	`authenticationRetries()` Specify the number of times a client is allowed to retry authentication before closing the connection.
`T`	`authenticationRetries(Integer value)` Specify the number of times a client is allowed to retry authentication before closing the connection.
`String`	`authorizeId()` The SASL authorization ID.
`T`	`authorizeId(String value)` The SASL authorization ID.
`String`	`authRealm()` The authentication realm to use if no authentication CallbackHandler is specified.
`T`	`authRealm(String value)` The authentication realm to use if no authentication CallbackHandler is specified.
`Integer`	`bufferRegionSize()` The size of allocated buffer regions.
`T`	`bufferRegionSize(Integer value)` The size of allocated buffer regions.
`T`	`connector(Connector value)` Add the Connector object to the list of subresources
`T`	`connector(ConnectorSupplier supplier)` Install a supplied Connector object to the list of subresources
`T`	`connector(String childKey)` Create and configure a Connector object to the list of subresources
`T`	`connector(String childKey, ConnectorConsumer consumer)` Create and configure a Connector object to the list of subresources
`T`	`connectors(List<Connector> value)` Add all Connector objects to this subresource
`T`	`endpointConfiguration()` Endpoint configuration
`T`	`endpointConfiguration(EndpointConfiguration value)` Endpoint configuration
`T`	`endpointConfiguration(EndpointConfigurationConsumer consumer)` Endpoint configuration
`T`	`endpointConfiguration(EndpointConfigurationSupplier supplier)` Endpoint configuration
`String`	`getKey()`
`Integer`	`heartbeatInterval()` The interval to use for connection heartbeat, in milliseconds.
`T`	`heartbeatInterval(Integer value)` The interval to use for connection heartbeat, in milliseconds.
`T`	`httpConnector(HTTPConnector value)` Add the HTTPConnector object to the list of subresources
`T`	`httpConnector(HTTPConnectorSupplier supplier)` Install a supplied HTTPConnector object to the list of subresources
`T`	`httpConnector(String childKey)` Create and configure a HTTPConnector object to the list of subresources
`T`	`httpConnector(String childKey, HTTPConnectorConsumer consumer)` Create and configure a HTTPConnector object to the list of subresources
`T`	`httpConnectors(List<HTTPConnector> value)` Add all HTTPConnector objects to this subresource
`T`	`localOutboundConnection(LocalOutboundConnection value)` Add the LocalOutboundConnection object to the list of subresources
`T`	`localOutboundConnection(LocalOutboundConnectionSupplier supplier)` Install a supplied LocalOutboundConnection object to the list of subresources
`T`	`localOutboundConnection(String childKey)` Create and configure a LocalOutboundConnection object to the list of subresources
`T`	`localOutboundConnection(String childKey, LocalOutboundConnectionConsumer consumer)` Create and configure a LocalOutboundConnection object to the list of subresources
`T`	`localOutboundConnections(List<LocalOutboundConnection> value)` Add all LocalOutboundConnection objects to this subresource
`Integer`	`maxInboundChannels()` The maximum number of inbound channels to support for a connection.
`T`	`maxInboundChannels(Integer value)` The maximum number of inbound channels to support for a connection.
`Integer`	`maxInboundMessages()` The maximum number of concurrent inbound messages on a channel.
`T`	`maxInboundMessages(Integer value)` The maximum number of concurrent inbound messages on a channel.
`Long`	`maxInboundMessageSize()` The maximum inbound message size to be allowed.
`T`	`maxInboundMessageSize(Long value)` The maximum inbound message size to be allowed.
`Integer`	`maxOutboundChannels()` The maximum number of outbound channels to support for a connection.
`T`	`maxOutboundChannels(Integer value)` The maximum number of outbound channels to support for a connection.
`Integer`	`maxOutboundMessages()` The maximum number of concurrent outbound messages on a channel.
`T`	`maxOutboundMessages(Integer value)` The maximum number of concurrent outbound messages on a channel.
`Long`	`maxOutboundMessageSize()` The maximum outbound message size to send.
`T`	`maxOutboundMessageSize(Long value)` The maximum outbound message size to send.
`T`	`outboundConnection(OutboundConnection value)` Add the OutboundConnection object to the list of subresources
`T`	`outboundConnection(OutboundConnectionSupplier supplier)` Install a supplied OutboundConnection object to the list of subresources
`T`	`outboundConnection(String childKey)` Create and configure a OutboundConnection object to the list of subresources
`T`	`outboundConnection(String childKey, OutboundConnectionConsumer consumer)` Create and configure a OutboundConnection object to the list of subresources
`T`	`outboundConnections(List<OutboundConnection> value)` Add all OutboundConnection objects to this subresource
`Integer`	`receiveBufferSize()` The size of the largest buffer that this endpoint will accept over a connection.
`T`	`receiveBufferSize(Integer value)` The size of the largest buffer that this endpoint will accept over a connection.
`Integer`	`receiveWindowSize()` The maximum window size of the receive direction for connection channels, in bytes.
`T`	`receiveWindowSize(Integer value)` The maximum window size of the receive direction for connection channels, in bytes.
`T`	`remoteOutboundConnection(RemoteOutboundConnection value)` Add the RemoteOutboundConnection object to the list of subresources
`T`	`remoteOutboundConnection(RemoteOutboundConnectionSupplier supplier)` Install a supplied RemoteOutboundConnection object to the list of subresources
`T`	`remoteOutboundConnection(String childKey)` Create and configure a RemoteOutboundConnection object to the list of subresources
`T`	`remoteOutboundConnection(String childKey, RemoteOutboundConnectionConsumer consumer)` Create and configure a RemoteOutboundConnection object to the list of subresources
`T`	`remoteOutboundConnections(List<RemoteOutboundConnection> value)` Add all RemoteOutboundConnection objects to this subresource
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener
`String`	`saslProtocol()` Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
`T`	`saslProtocol(String value)` Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
`Integer`	`sendBufferSize()` The size of the largest buffer that this endpoint will transmit over a connection.
`T`	`sendBufferSize(Integer value)` The size of the largest buffer that this endpoint will transmit over a connection.
`String`	`serverName()` The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
`T`	`serverName(String value)` The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
`Remoting.RemotingResources`	`subresources()`
`Integer`	`transmitWindowSize()` The maximum window size of the transmit direction for connection channels, in bytes.
`T`	`transmitWindowSize(Integer value)` The maximum window size of the transmit direction for connection channels, in bytes.
`String`	`worker()` Worker to use
`T`	`worker(String value)` Worker to use
`Integer`	`workerReadThreads()` The number of read threads to create for the remoting worker.
`T`	`workerReadThreads(Integer value)` The number of read threads to create for the remoting worker.
`Integer`	`workerTaskCoreThreads()` The number of core threads for the remoting worker task thread pool.
`T`	`workerTaskCoreThreads(Integer value)` The number of core threads for the remoting worker task thread pool.
`Integer`	`workerTaskKeepalive()` The number of milliseconds to keep non-core remoting worker task threads alive.
`T`	`workerTaskKeepalive(Integer value)` The number of milliseconds to keep non-core remoting worker task threads alive.
`Integer`	`workerTaskLimit()` The maximum number of remoting worker tasks to allow before rejecting.
`T`	`workerTaskLimit(Integer value)` The maximum number of remoting worker tasks to allow before rejecting.
`Integer`	`workerTaskMaxThreads()` The maximum number of threads for the remoting worker task thread pool.
`T`	`workerTaskMaxThreads(Integer value)` The maximum number of threads for the remoting worker task thread pool.
`Integer`	`workerWriteThreads()` The number of write threads to create for the remoting worker.
`T`	`workerWriteThreads(Integer value)` The number of write threads to create for the remoting worker.

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

- Constructor Detail
  - Remoting
```
public Remoting()
```
- Method Detail
  - getKey
```
public String getKey()
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a property change listener
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property change listener
  - subresources
```
public Remoting.RemotingResources subresources()
```
  - httpConnectors
```
public T httpConnectors(List<HTTPConnector> value)
```
    Add all HTTPConnector objects to this subresource
    
    Parameters:
    
    value - List of HTTPConnector objects.
    
    Returns:
    
    this
  - httpConnector
```
public T httpConnector(HTTPConnector value)
```
    Add the HTTPConnector object to the list of subresources
    
    Parameters:
    
    value - The HTTPConnector to add
    
    Returns:
    
    this
  - httpConnector
```
public T httpConnector(String childKey,
                       HTTPConnectorConsumer consumer)
```
    Create and configure a HTTPConnector object to the list of subresources
    
    Parameters:
    
    key - The key for the HTTPConnector resource
    
    config - The HTTPConnectorConsumer to use
    
    Returns:
    
    this
  - httpConnector
```
public T httpConnector(String childKey)
```
    Create and configure a HTTPConnector object to the list of subresources
    
    Parameters:
    
    key - The key for the HTTPConnector resource
    
    Returns:
    
    this
  - httpConnector
```
public T httpConnector(HTTPConnectorSupplier supplier)
```
    Install a supplied HTTPConnector object to the list of subresources
  - connectors
```
public T connectors(List<Connector> value)
```
    Add all Connector objects to this subresource
    
    Parameters:
    
    value - List of Connector objects.
    
    Returns:
    
    this
  - connector
```
public T connector(Connector value)
```
    Add the Connector object to the list of subresources
    
    Parameters:
    
    value - The Connector to add
    
    Returns:
    
    this
  - connector
```
public T connector(String childKey,
                   ConnectorConsumer consumer)
```
    Create and configure a Connector object to the list of subresources
    
    Parameters:
    
    key - The key for the Connector resource
    
    config - The ConnectorConsumer to use
    
    Returns:
    
    this
  - connector
```
public T connector(String childKey)
```
    Create and configure a Connector object to the list of subresources
    
    Parameters:
    
    key - The key for the Connector resource
    
    Returns:
    
    this
  - connector
```
public T connector(ConnectorSupplier supplier)
```
    Install a supplied Connector object to the list of subresources
  - outboundConnections
```
public T outboundConnections(List<OutboundConnection> value)
```
    Add all OutboundConnection objects to this subresource
    
    Parameters:
    
    value - List of OutboundConnection objects.
    
    Returns:
    
    this
  - outboundConnection
```
public T outboundConnection(OutboundConnection value)
```
    Add the OutboundConnection object to the list of subresources
    
    Parameters:
    
    value - The OutboundConnection to add
    
    Returns:
    
    this
  - outboundConnection
```
public T outboundConnection(String childKey,
                            OutboundConnectionConsumer consumer)
```
    Create and configure a OutboundConnection object to the list of subresources
    
    Parameters:
    
    key - The key for the OutboundConnection resource
    
    config - The OutboundConnectionConsumer to use
    
    Returns:
    
    this
  - outboundConnection
```
public T outboundConnection(String childKey)
```
    Create and configure a OutboundConnection object to the list of subresources
    
    Parameters:
    
    key - The key for the OutboundConnection resource
    
    Returns:
    
    this
  - outboundConnection
```
public T outboundConnection(OutboundConnectionSupplier supplier)
```
    Install a supplied OutboundConnection object to the list of subresources
  - localOutboundConnections
```
public T localOutboundConnections(List<LocalOutboundConnection> value)
```
    Add all LocalOutboundConnection objects to this subresource
    
    Parameters:
    
    value - List of LocalOutboundConnection objects.
    
    Returns:
    
    this
  - localOutboundConnection
```
public T localOutboundConnection(LocalOutboundConnection value)
```
    Add the LocalOutboundConnection object to the list of subresources
    
    Parameters:
    
    value - The LocalOutboundConnection to add
    
    Returns:
    
    this
  - localOutboundConnection
```
public T localOutboundConnection(String childKey,
                                 LocalOutboundConnectionConsumer consumer)
```
    Create and configure a LocalOutboundConnection object to the list of subresources
    
    Parameters:
    
    key - The key for the LocalOutboundConnection resource
    
    config - The LocalOutboundConnectionConsumer to use
    
    Returns:
    
    this
  - localOutboundConnection
```
public T localOutboundConnection(String childKey)
```
    Create and configure a LocalOutboundConnection object to the list of subresources
    
    Parameters:
    
    key - The key for the LocalOutboundConnection resource
    
    Returns:
    
    this
  - localOutboundConnection
```
public T localOutboundConnection(LocalOutboundConnectionSupplier supplier)
```
    Install a supplied LocalOutboundConnection object to the list of subresources
  - remoteOutboundConnections
```
public T remoteOutboundConnections(List<RemoteOutboundConnection> value)
```
    Add all RemoteOutboundConnection objects to this subresource
    
    Parameters:
    
    value - List of RemoteOutboundConnection objects.
    
    Returns:
    
    this
  - remoteOutboundConnection
```
public T remoteOutboundConnection(RemoteOutboundConnection value)
```
    Add the RemoteOutboundConnection object to the list of subresources
    
    Parameters:
    
    value - The RemoteOutboundConnection to add
    
    Returns:
    
    this
  - remoteOutboundConnection
```
public T remoteOutboundConnection(String childKey,
                                  RemoteOutboundConnectionConsumer consumer)
```
    Create and configure a RemoteOutboundConnection object to the list of subresources
    
    Parameters:
    
    key - The key for the RemoteOutboundConnection resource
    
    config - The RemoteOutboundConnectionConsumer to use
    
    Returns:
    
    this
  - remoteOutboundConnection
```
public T remoteOutboundConnection(String childKey)
```
    Create and configure a RemoteOutboundConnection object to the list of subresources
    
    Parameters:
    
    key - The key for the RemoteOutboundConnection resource
    
    Returns:
    
    this
  - remoteOutboundConnection
```
public T remoteOutboundConnection(RemoteOutboundConnectionSupplier supplier)
```
    Install a supplied RemoteOutboundConnection object to the list of subresources
  - endpointConfiguration
```
public T endpointConfiguration(EndpointConfiguration value)
```
    Endpoint configuration
  - endpointConfiguration
```
public T endpointConfiguration(EndpointConfigurationConsumer consumer)
```
    Endpoint configuration
  - endpointConfiguration
```
public T endpointConfiguration()
```
    Endpoint configuration
  - endpointConfiguration
```
public T endpointConfiguration(EndpointConfigurationSupplier supplier)
```
    Endpoint configuration
  - authRealm
```
public String authRealm()
```
    The authentication realm to use if no authentication CallbackHandler is specified.
  - authRealm
```
public T authRealm(String value)
```
    The authentication realm to use if no authentication CallbackHandler is specified.
  - authenticationRetries
```
public Integer authenticationRetries()
```
    Specify the number of times a client is allowed to retry authentication before closing the connection.
  - authenticationRetries
```
public T authenticationRetries(Integer value)
```
    Specify the number of times a client is allowed to retry authentication before closing the connection.
  - authorizeId
```
public String authorizeId()
```
    The SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specifiedand the selected SASL mechanism demands a user name.
  - authorizeId
```
public T authorizeId(String value)
```
    The SASL authorization ID. Used as authentication user name to use if no authentication CallbackHandler is specifiedand the selected SASL mechanism demands a user name.
  - bufferRegionSize
```
public Integer bufferRegionSize()
```
    The size of allocated buffer regions.
  - bufferRegionSize
```
public T bufferRegionSize(Integer value)
```
    The size of allocated buffer regions.
  - heartbeatInterval
```
public Integer heartbeatInterval()
```
    The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound directionfor this amount of time, a ping message will be sent, which will trigger a corresponding reply message.
  - heartbeatInterval
```
public T heartbeatInterval(Integer value)
```
    The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound directionfor this amount of time, a ping message will be sent, which will trigger a corresponding reply message.
  - maxInboundChannels
```
public Integer maxInboundChannels()
```
    The maximum number of inbound channels to support for a connection.
  - maxInboundChannels
```
public T maxInboundChannels(Integer value)
```
    The maximum number of inbound channels to support for a connection.
  - maxInboundMessageSize
```
public Long maxInboundMessageSize()
```
    The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.
  - maxInboundMessageSize
```
public T maxInboundMessageSize(Long value)
```
    The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.
  - maxInboundMessages
```
public Integer maxInboundMessages()
```
    The maximum number of concurrent inbound messages on a channel.
  - maxInboundMessages
```
public T maxInboundMessages(Integer value)
```
    The maximum number of concurrent inbound messages on a channel.
  - maxOutboundChannels
```
public Integer maxOutboundChannels()
```
    The maximum number of outbound channels to support for a connection.
  - maxOutboundChannels
```
public T maxOutboundChannels(Integer value)
```
    The maximum number of outbound channels to support for a connection.
  - maxOutboundMessageSize
```
public Long maxOutboundMessageSize()
```
    The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.
  - maxOutboundMessageSize
```
public T maxOutboundMessageSize(Long value)
```
    The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.
  - maxOutboundMessages
```
public Integer maxOutboundMessages()
```
    The maximum number of concurrent outbound messages on a channel.
  - maxOutboundMessages
```
public T maxOutboundMessages(Integer value)
```
    The maximum number of concurrent outbound messages on a channel.
  - receiveBufferSize
```
public Integer receiveBufferSize()
```
    The size of the largest buffer that this endpoint will accept over a connection.
  - receiveBufferSize
```
public T receiveBufferSize(Integer value)
```
    The size of the largest buffer that this endpoint will accept over a connection.
  - receiveWindowSize
```
public Integer receiveWindowSize()
```
    The maximum window size of the receive direction for connection channels, in bytes.
  - receiveWindowSize
```
public T receiveWindowSize(Integer value)
```
    The maximum window size of the receive direction for connection channels, in bytes.
  - saslProtocol
```
public String saslProtocol()
```
    Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
  - saslProtocol
```
public T saslProtocol(String value)
```
    Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
  - sendBufferSize
```
public Integer sendBufferSize()
```
    The size of the largest buffer that this endpoint will transmit over a connection.
  - sendBufferSize
```
public T sendBufferSize(Integer value)
```
    The size of the largest buffer that this endpoint will transmit over a connection.
  - serverName
```
public String serverName()
```
    The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
  - serverName
```
public T serverName(String value)
```
    The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
  - transmitWindowSize
```
public Integer transmitWindowSize()
```
    The maximum window size of the transmit direction for connection channels, in bytes.
  - transmitWindowSize
```
public T transmitWindowSize(Integer value)
```
    The maximum window size of the transmit direction for connection channels, in bytes.
  - worker
```
public String worker()
```
    Worker to use
  - worker
```
public T worker(String value)
```
    Worker to use
  - workerReadThreads
```
public Integer workerReadThreads()
```
    The number of read threads to create for the remoting worker.
  - workerReadThreads
```
public T workerReadThreads(Integer value)
```
    The number of read threads to create for the remoting worker.
  - workerTaskCoreThreads
```
public Integer workerTaskCoreThreads()
```
    The number of core threads for the remoting worker task thread pool.
  - workerTaskCoreThreads
```
public T workerTaskCoreThreads(Integer value)
```
    The number of core threads for the remoting worker task thread pool.
  - workerTaskKeepalive
```
public Integer workerTaskKeepalive()
```
    The number of milliseconds to keep non-core remoting worker task threads alive.
  - workerTaskKeepalive
```
public T workerTaskKeepalive(Integer value)
```
    The number of milliseconds to keep non-core remoting worker task threads alive.
  - workerTaskLimit
```
public Integer workerTaskLimit()
```
    The maximum number of remoting worker tasks to allow before rejecting.
  - workerTaskLimit
```
public T workerTaskLimit(Integer value)
```
    The maximum number of remoting worker tasks to allow before rejecting.
  - workerTaskMaxThreads
```
public Integer workerTaskMaxThreads()
```
    The maximum number of threads for the remoting worker task thread pool.
  - workerTaskMaxThreads
```
public T workerTaskMaxThreads(Integer value)
```
    The maximum number of threads for the remoting worker task thread pool.
  - workerWriteThreads
```
public Integer workerWriteThreads()
```
    The number of write threads to create for the remoting worker.
  - workerWriteThreads
```
public T workerWriteThreads(Integer value)
```
    The number of write threads to create for the remoting worker.

Class Remoting<T extends Remoting<T>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Remoting

Method Detail

getKey

addPropertyChangeListener

removePropertyChangeListener

subresources

httpConnectors

httpConnector

httpConnector

httpConnector

httpConnector

connectors

connector

connector

connector

connector

outboundConnections

outboundConnection

outboundConnection

outboundConnection

outboundConnection

localOutboundConnections

localOutboundConnection

localOutboundConnection

localOutboundConnection

localOutboundConnection

remoteOutboundConnections

remoteOutboundConnection

remoteOutboundConnection

remoteOutboundConnection

remoteOutboundConnection

endpointConfiguration

endpointConfiguration

endpointConfiguration

endpointConfiguration

authRealm

authRealm

authenticationRetries

authenticationRetries

authorizeId

authorizeId

bufferRegionSize

bufferRegionSize

heartbeatInterval

heartbeatInterval

maxInboundChannels

maxInboundChannels

maxInboundMessageSize

maxInboundMessageSize

maxInboundMessages

maxInboundMessages

maxOutboundChannels

maxOutboundChannels

maxOutboundMessageSize

maxOutboundMessageSize

maxOutboundMessages

maxOutboundMessages

receiveBufferSize

receiveBufferSize

receiveWindowSize

receiveWindowSize

saslProtocol

saslProtocol

sendBufferSize

sendBufferSize

serverName

serverName

transmitWindowSize

transmitWindowSize

worker

worker

workerReadThreads

workerReadThreads

workerTaskCoreThreads