SessionAttributes (diffusion-api 6.10.0 API)

```
public interface SessionAttributes
```
Session Attributes.
This encapsulates the basic attributes of a Session. These attributes may be set (unless default values are sufficient) on the SessionFactory used to create sessions.

Since:

5.0

Author:

DiffusionData Limited

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class SessionAttributes.Transport
The transports available to Java clients.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SessionAttributes.Transport` The transports available to Java clients.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CONNECTION_TIMEOUT` The default connection timeout = 2 seconds.
`static int`	`DEFAULT_INPUT_BUFFER_SIZE` The default size of socket and message input buffers in bytes.
`static int`	`DEFAULT_MAXIMUM_MESSAGE_SIZE` The default maximum message size in bytes.
`static int`	`DEFAULT_MAXIMUM_QUEUE_SIZE` The default maximum outbound queue size in messages.
`static int`	`DEFAULT_OUTPUT_BUFFER_SIZE` The default size of socket and message output buffers in bytes.
`static int`	`DEFAULT_RECONNECTION_TIMEOUT` The default reconnection timeout = 60 seconds.
`static int`	`DEFAULT_RECOVERY_BUFFER_SIZE` The default recovery buffer size in messages.
`static String`	`DEFAULT_REQUEST_PATH` The default request path.
`static int`	`DEFAULT_WRITE_TIMEOUT` The default write timeout for blocking writes = 2 seconds.
`static int`	`MAXIMUM_MESSAGE_SIZE_MIN` The minimum value that the maximum message size can be set to in bytes.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getConnectionTimeout()` Returns the connection timeout value.
`HTTPProxyAuthentication`	`getHttpProxyAuth()` Returns the proxy authenticator used to route a connection to the server via an HTTP proxy.
`String`	`getHttpProxyHost()` Returns the proxy host name used to route a connection to the server via an HTTP proxy.
`int`	`getHttpProxyPort()` Returns the proxy port used to route a connection to the server via an HTTP proxy.
`RetryStrategy`	`getInitialRetryStrategy()` Returns the initial retry strategy.
`int`	`getInputBufferSize()` Returns the input buffer size for socket connection buffers and message receiving buffers.
`SocketAddress`	`getLocalSocketAddress()` Returns the local socket address.
`int`	`getMaximumMessageSize()` Returns the maximum message size that will be accepted by this session.
`int`	`getMaximumQueueSize()` Returns the maximum size of the outbound message queue for the connection.
`int`	`getOutputBufferSize()` Returns the output buffer size for socket connection buffers and message sending buffers.
`ReconnectionStrategy`	`getReconnectionStrategy()` Returns the reconnection strategy.
`int`	`getReconnectionTimeout()` Returns the reconnection timeout.
`int`	`getRecoveryBufferSize()` Returns the maximum number of sent messages that can be recovered on reconnection.
`List<SessionAttributes.Transport>`	`getRequestedTransports()` Returns the transports the session will use to connect to the server.
`String`	`getRequestPath()` Returns the path used for any HTTP requests made by the session.
`String`	`getServerHost()` Returns the host name or IP of the server the session will connect to.
`int`	`getServerPort()` Returns the port of the server the session will connect to.
`String`	`getServerURL()` Returns the URL used to create the session.
`SSLContext`	`getSslContext()` Returns the SSL context for secure connections.
`int`	`getWriteTimeout()` Returns the write timeout value.
`boolean`	`isTransportSecure()` Indicates whether the session will use transport layer security to connect to Diffusion.

- Field Detail
  - DEFAULT_CONNECTION_TIMEOUT
```
static final int DEFAULT_CONNECTION_TIMEOUT
```
    The default connection timeout = 2 seconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECONNECTION_TIMEOUT
```
static final int DEFAULT_RECONNECTION_TIMEOUT
```
    The default reconnection timeout = 60 seconds.
    
    Since:
    
    5.5
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WRITE_TIMEOUT
```
static final int DEFAULT_WRITE_TIMEOUT
```
    The default write timeout for blocking writes = 2 seconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAXIMUM_MESSAGE_SIZE
```
static final int DEFAULT_MAXIMUM_MESSAGE_SIZE
```
    The default maximum message size in bytes. The maximum message size limits the size of received messages. This default value is is Integer.MAX_VALUE, so the message size is effectively unlimited.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_MESSAGE_SIZE_MIN
```
static final int MAXIMUM_MESSAGE_SIZE_MIN
```
    The minimum value that the maximum message size can be set to in bytes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INPUT_BUFFER_SIZE
```
static final int DEFAULT_INPUT_BUFFER_SIZE
```
    The default size of socket and message input buffers in bytes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OUTPUT_BUFFER_SIZE
```
static final int DEFAULT_OUTPUT_BUFFER_SIZE
```
    The default size of socket and message output buffers in bytes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECOVERY_BUFFER_SIZE
```
static final int DEFAULT_RECOVERY_BUFFER_SIZE
```
    The default recovery buffer size in messages.
    
    Since:
    
    5.8
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAXIMUM_QUEUE_SIZE
```
static final int DEFAULT_MAXIMUM_QUEUE_SIZE
```
    The default maximum outbound queue size in messages.
    
    Since:
    
    5.9
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REQUEST_PATH
```
static final String DEFAULT_REQUEST_PATH
```
    The default request path.
    
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getServerURL
```
String getServerURL()
```
    Returns the URL used to create the session.
    
    Returns:
    
    the URL
  - getConnectionTimeout
```
int getConnectionTimeout()
```
    Returns the connection timeout value.
    
    Returns:
    
    connection timeout in milliseconds
    
    See Also:
    
    #connectionTimeout(int)
  - getInputBufferSize
```
int getInputBufferSize()
```
    Returns the input buffer size for socket connection buffers and message receiving buffers.
    
    Returns:
    
    the input buffer size in bytes
    
    See Also:
    
    SessionFactory.inputBufferSize(int)
  - getOutputBufferSize
```
int getOutputBufferSize()
```
    Returns the output buffer size for socket connection buffers and message sending buffers.
    
    Returns:
    
    the output buffer size in bytes
    
    See Also:
    
    SessionFactory.outputBufferSize(int)
  - getWriteTimeout
```
int getWriteTimeout()
```
    Returns the write timeout value.
    
    Returns:
    
    write timeout in milliseconds
    
    See Also:
    
    SessionFactory.writeTimeout(int)
  - getInitialRetryStrategy
```
RetryStrategy getInitialRetryStrategy()
```
    Returns the initial retry strategy.
    
    Returns:
    
    the initial retry strategy used by the session
    
    See Also:
    
    SessionFactory.initialRetryStrategy(RetryStrategy)
  - getReconnectionStrategy
```
ReconnectionStrategy getReconnectionStrategy()
```
    Returns the reconnection strategy.
    
    Returns:
    
    the reconnection strategy to be used by the session
    
    Since:
    
    5.5
    
    See Also:
    
    SessionFactory.reconnectionStrategy(ReconnectionStrategy)
  - getReconnectionTimeout
```
int getReconnectionTimeout()
```
    Returns the reconnection timeout.
    
    Returns:
    
    the reconnection timeout in milliseconds
    
    Since:
    
    5.5
    
    See Also:
    
    SessionFactory.reconnectionTimeout(int)
  - getLocalSocketAddress
```
SocketAddress getLocalSocketAddress()
```
    Returns the local socket address.
    
    Returns:
    
    the local socket address or null if none has been specified
    
    See Also:
    
    SessionFactory.localSocketAddress(SocketAddress)
  - getSslContext
```
SSLContext getSslContext()
```
    Returns the SSL context for secure connections.
    
    Returns:
    
    the SSL context
    
    See Also:
    
    SessionFactory.sslContext(SSLContext)
  - getMaximumMessageSize
```
int getMaximumMessageSize()
```
    Returns the maximum message size that will be accepted by this session.
    
    Returns:
    
    the maximum message size
    
    See Also:
    
    SessionFactory.maximumMessageSize(int)
  - getHttpProxyHost
```
String getHttpProxyHost()
```
    Returns the proxy host name used to route a connection to the server via an HTTP proxy.
    
    Returns:
    
    the proxy host
    
    Since:
    
    5.1
    
    See Also:
    
    SessionFactory.httpProxy(String, int)
  - getHttpProxyPort
```
int getHttpProxyPort()
```
    Returns the proxy port used to route a connection to the server via an HTTP proxy.
    
    Returns:
    
    the proxy port
    
    Since:
    
    5.1
    
    See Also:
    
    SessionFactory.httpProxy(String, int)
  - getHttpProxyAuth
```
HTTPProxyAuthentication getHttpProxyAuth()
```
    Returns the proxy authenticator used to route a connection to the server via an HTTP proxy.
    
    Returns:
    
    the proxy authenticator
    
    Since:
    
    5.1
    
    See Also:
    
    SessionFactory.httpProxy(String, int, HTTPProxyAuthentication)
  - getServerHost
```
String getServerHost()
```
    Returns the host name or IP of the server the session will connect to.
    
    Returns:
    
    the host name (or IP address)
    
    Since:
    
    5.8
    
    See Also:
    
    SessionFactory.serverHost(String)
  - getServerPort
```
int getServerPort()
```
    Returns the port of the server the session will connect to.
    
    Returns:
    
    the port
    
    Since:
    
    5.8
    
    See Also:
    
    SessionFactory.serverPort(int)
  - getRequestedTransports
```
List<SessionAttributes.Transport> getRequestedTransports()
```
    Returns the transports the session will use to connect to the server.
    
    Returns:
    
    the transports in order of preference
    
    Since:
    
    5.8
    
    See Also:
    
    SessionFactory.transports(com.pushtechnology.diffusion.client.session.SessionAttributes.Transport...)
  - isTransportSecure
```
boolean isTransportSecure()
```
    Indicates whether the session will use transport layer security to connect to Diffusion.
    
    Returns:
    
    if the session will use TLS
    
    Since:
    
    5.8
    
    See Also:
    
    SessionFactory.secureTransport(boolean)
  - getRequestPath
```
String getRequestPath()
```
    Returns the path used for any HTTP requests made by the session.
    
    Returns:
    
    the path used in request URLs
    
    Since:
    
    5.8
    
    See Also:
    
    SessionFactory.requestPath(String)
  - getRecoveryBufferSize
```
int getRecoveryBufferSize()
```
    Returns the maximum number of sent messages that can be recovered on reconnection.
    
    Returns:
    
    the size of the buffer used to store sent messages for sessions that support reconnection
    
    Since:
    
    5.8
    
    See Also:
    
    SessionFactory.recoveryBufferSize(int)
  - getMaximumQueueSize
```
int getMaximumQueueSize()
```
    Returns the maximum size of the outbound message queue for the connection.
    
    Returns:
    
    the maximum number of messages that may be queued on the outbound message queue
    
    Since:
    
    5.9
    
    See Also:
    
    SessionFactory.maximumQueueSize(int)

Interface SessionAttributes

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_RECONNECTION_TIMEOUT

DEFAULT_WRITE_TIMEOUT

DEFAULT_MAXIMUM_MESSAGE_SIZE

MAXIMUM_MESSAGE_SIZE_MIN

DEFAULT_INPUT_BUFFER_SIZE

DEFAULT_OUTPUT_BUFFER_SIZE

DEFAULT_RECOVERY_BUFFER_SIZE

DEFAULT_MAXIMUM_QUEUE_SIZE

DEFAULT_REQUEST_PATH

Method Detail

getServerURL

getConnectionTimeout

getInputBufferSize

getOutputBufferSize

getWriteTimeout

getInitialRetryStrategy

getReconnectionStrategy

getReconnectionTimeout

getLocalSocketAddress

getSslContext

getMaximumMessageSize

getHttpProxyHost

getHttpProxyPort

getHttpProxyAuth

getServerHost

getServerPort

getRequestedTransports

isTransportSecure

getRequestPath

getRecoveryBufferSize

getMaximumQueueSize