EndpointConfiguration (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.remoting.EndpointConfiguration

public class EndpointConfiguration
extends Object

Endpoint configuration

Constructor Summary

Constructors
Constructor and Description

EndpointConfiguration()

Constructors
Constructor and Description
`EndpointConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`authenticationRetries()` Specify the number of times a client is allowed to retry authentication before closing the connection.
`EndpointConfiguration`	`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.
`EndpointConfiguration`	`authorizeId(String value)` The SASL authorization ID.
`String`	`authRealm()` The authentication realm to use if no authentication `CallbackHandler` is specified.
`EndpointConfiguration`	`authRealm(String value)` The authentication realm to use if no authentication `CallbackHandler` is specified.
`Integer`	`bufferRegionSize()` The size of allocated buffer regions.
`EndpointConfiguration`	`bufferRegionSize(Integer value)` The size of allocated buffer regions.
`String`	`getKey()`
`Integer`	`heartbeatInterval()` The interval to use for connection heartbeat, in milliseconds.
`EndpointConfiguration`	`heartbeatInterval(Integer value)` The interval to use for connection heartbeat, in milliseconds.
`Integer`	`maxInboundChannels()` The maximum number of concurrent inbound messages on a channel.
`EndpointConfiguration`	`maxInboundChannels(Integer value)` The maximum number of concurrent inbound messages on a channel.
`Integer`	`maxInboundMessages()` The maximum number of inbound channels to support for a connection.
`EndpointConfiguration`	`maxInboundMessages(Integer value)` The maximum number of inbound channels to support for a connection.
`Long`	`maxInboundMessageSize()` The maximum inbound message size to be allowed.
`EndpointConfiguration`	`maxInboundMessageSize(Long value)` The maximum inbound message size to be allowed.
`Integer`	`maxOutboundChannels()` The maximum number of concurrent outbound messages on a channel.
`EndpointConfiguration`	`maxOutboundChannels(Integer value)` The maximum number of concurrent outbound messages on a channel.
`Integer`	`maxOutboundMessages()` The maximum number of outbound channels to support for a connection.
`EndpointConfiguration`	`maxOutboundMessages(Integer value)` The maximum number of outbound channels to support for a connection.
`Long`	`maxOutboundMessageSize()` The maximum outbound message size to send.
`EndpointConfiguration`	`maxOutboundMessageSize(Long value)` The maximum outbound message size to send.
`Integer`	`receiveBufferSize()` The size of the largest buffer that this endpoint will accept over a connection.
`EndpointConfiguration`	`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.
`EndpointConfiguration`	`receiveWindowSize(Integer value)` The maximum window size of the receive direction for connection channels, in bytes.
`String`	`saslProtocol()` Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
`EndpointConfiguration`	`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.
`EndpointConfiguration`	`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.
`EndpointConfiguration`	`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.
`Integer`	`transmitWindowSize()` The maximum window size of the transmit direction for connection channels, in bytes.
`EndpointConfiguration`	`transmitWindowSize(Integer value)` The maximum window size of the transmit direction for connection channels, in bytes.
`String`	`worker()` Worker to use
`EndpointConfiguration`	`worker(String value)` Worker to use

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

- Constructor Detail
  - EndpointConfiguration
```
public EndpointConfiguration()
```
- Method Detail
  - getKey
```
public String getKey()
```
  - authRealm
```
public String authRealm()
```
    The authentication realm to use if no authentication CallbackHandler is specified.
  - authRealm
```
public EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration 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 concurrent inbound messages on a channel.
  - maxInboundChannels
```
public EndpointConfiguration maxInboundChannels(Integer value)
```
    The maximum number of concurrent inbound messages on a channel.
  - 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 EndpointConfiguration 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 inbound channels to support for a connection.
  - maxInboundMessages
```
public EndpointConfiguration maxInboundMessages(Integer value)
```
    The maximum number of inbound channels to support for a connection.
  - maxOutboundChannels
```
public Integer maxOutboundChannels()
```
    The maximum number of concurrent outbound messages on a channel.
  - maxOutboundChannels
```
public EndpointConfiguration maxOutboundChannels(Integer value)
```
    The maximum number of concurrent outbound messages on a channel.
  - 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 EndpointConfiguration 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 outbound channels to support for a connection.
  - maxOutboundMessages
```
public EndpointConfiguration maxOutboundMessages(Integer value)
```
    The maximum number of outbound channels to support for a connection.
  - receiveBufferSize
```
public Integer receiveBufferSize()
```
    The size of the largest buffer that this endpoint will accept over a connection.
  - receiveBufferSize
```
public EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration 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 EndpointConfiguration worker(String value)
```
    Worker to use

Class EndpointConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointConfiguration

Method Detail

getKey

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