org.jboss.xnio
Class Options

java.lang.Object
  org.jboss.xnio.Options

public final class Options
extends Object

Common channel options.

Field Summary

static Option<Integer>	BACKLOG Configure a server with the specified backlog.
static Option<Boolean>	BROADCAST Enable broadcast support for IP datagram sockets.
static Option<Boolean>	CLOSE_ABORT Configure a TCP socket to send an RST packet on close.
static Option<Integer>	CONNECT_THREADS The number of connect threads to create.
static Option<Integer>	IP_TRAFFIC_CLASS Set the IP traffic class/type-of-service for the channel.
static Option<Boolean>	KEEP_ALIVE Configure a channel to send a periodic heartbeat of some sort.
static Option<Boolean>	MANAGE_CONNECTIONS Configure an acceptor to manage connections or to leave them unmanaged.
static Option<Integer>	MAX_INBOUND_MESSAGE_SIZE The maximum inbound message size.
static Option<Integer>	MAX_OUTBOUND_MESSAGE_SIZE The maximum outbound message size.
static Option<Boolean>	MULTICAST Enable multicast support for a socket.
static Option<Integer>	MULTICAST_TTL Set the multicast time-to-live field for datagram sockets.
static Option<Integer>	READ_THREADS The number of read threads to create.
static Option<Integer>	RECEIVE_BUFFER The receive buffer size.
static Option<Boolean>	REUSE_ADDRESSES Configure an IP socket to reuse addresses.
static Option<Sequence<String>>	SASL_MECHANISMS A list of SASL mechanisms, in decreasing order of preference.
static Option<Boolean>	SASL_POLICY_FORWARD_SECRECY Specify whether SASL mechanisms which implement forward secrecy between sessions are required.
static Option<Boolean>	SASL_POLICY_NOACTIVE Specify whether SASL mechanisms which are susceptible to active (non-dictionary) attacks are permitted.
static Option<Boolean>	SASL_POLICY_NOANONYMOUS Specify whether SASL mechanisms which accept anonymous logins are permitted.
static Option<Boolean>	SASL_POLICY_NODICTIONARY Specify whether SASL mechanisms which are susceptible to passive dictionary attacks are permitted.
static Option<Boolean>	SASL_POLICY_NOPLAINTEXT Specify whether SASL mechanisms which are susceptible to simple plain passive attacks are permitted.
static Option<Boolean>	SASL_POLICY_PASS_CREDENTIALS Specify whether SASL mechanisms which pass client credentials are required.
static Option<Sequence<SaslQop>>	SASL_QOP Specify the SASL quality-of-protection to use.
static Option<Boolean>	SASL_REUSE Specify whether SASL mechanisms should attempt to reuse authenticated session information.
static Option<Boolean>	SASL_SERVER_AUTH Specify whether the SASL server must authenticate to the client.
static Option<SaslStrength>	SASL_STRENGTH Specify the SASL cipher strength to use.
static Option<Boolean>	SECURE Determine whether the channel is encrypted, or employs some other level of security.
static Option<Integer>	SELECTOR_CACHE_SIZE The size of the selector cache (used only by providers which use NIO selectors).
static Option<Integer>	SEND_BUFFER The send buffer size.
static Option<SslClientAuthMode>	SSL_CLIENT_AUTH_MODE Specify the SSL client authentication mode.
static Option<Boolean>	SSL_ENABLE_SESSION_CREATION Enable or disable session creation for an SSL connection.
static Option<Sequence<String>>	SSL_ENABLED_CIPHER_SUITES Specify the cipher suites for an SSL/TLS session.
static Option<Sequence<String>>	SSL_ENABLED_PROTOCOLS Specify the enabled protocols for an SSL/TLS session.
static Option<String>	SSL_PROTOCOL Specify the protocol name for an SSL context.
static Option<String>	SSL_PROVIDER Specify the requested provider for an SSL/TLS session.
static Option<Integer>	SSL_RECEIVE_BUFFER Specify the SSL receive buffer size.
static Option<Integer>	SSL_SEND_BUFFER Specify the SSL send buffer size.
static Option<Sequence<String>>	SSL_SUPPORTED_CIPHER_SUITES Get the supported cipher suites for an SSL/TLS session.
static Option<Sequence<String>>	SSL_SUPPORTED_PROTOCOLS Get the supported protocols for an SSL/TLS session.
static Option<Boolean>	SSL_USE_CLIENT_MODE Specify whether SSL conversations should be in client or server mode.
static Option<Boolean>	TCP_NODELAY Configure a TCP socket to disable Nagle's algorithm.
static Option<Boolean>	TCP_OOB_INLINE Configure a TCP socket to receive out-of-band data alongside regular data.
static Option<Integer>	WRITE_THREADS The number of write threads to create.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MULTICAST

public static final Option<Boolean> MULTICAST

Enable multicast support for a socket. The value type for this option is boolean. Note that some implementations may add overhead when multicast sockets are in use.

BROADCAST

public static final Option<Boolean> BROADCAST

Enable broadcast support for IP datagram sockets. The value type for this option is boolean. If you intend to send datagrams to a broadcast address, this option must be enabled.

CLOSE_ABORT

public static final Option<Boolean> CLOSE_ABORT

Configure a TCP socket to send an RST packet on close. The value type for this option is boolean.

RECEIVE_BUFFER

public static final Option<Integer> RECEIVE_BUFFER

The receive buffer size. The value type for this option is int. This may be used by an XNIO provider directly, or it may be passed to the underlying operating system, depending on the channel type.

REUSE_ADDRESSES

public static final Option<Boolean> REUSE_ADDRESSES

Configure an IP socket to reuse addresses. The value type for this option is boolean.

SEND_BUFFER

public static final Option<Integer> SEND_BUFFER

The send buffer size. The value type for this option is int. This may be used by an XNIO provider directly, or it may be passed to the underlying operating system, depending on the channel type.

TCP_NODELAY

public static final Option<Boolean> TCP_NODELAY

Configure a TCP socket to disable Nagle's algorithm. The value type for this option is boolean.

MULTICAST_TTL

public static final Option<Integer> MULTICAST_TTL

Set the multicast time-to-live field for datagram sockets. The value type for this option is int.

IP_TRAFFIC_CLASS

public static final Option<Integer> IP_TRAFFIC_CLASS

Set the IP traffic class/type-of-service for the channel. The value type for this option is int.

TCP_OOB_INLINE

public static final Option<Boolean> TCP_OOB_INLINE

Configure a TCP socket to receive out-of-band data alongside regular data. The value type for this option is boolean.

KEEP_ALIVE

public static final Option<Boolean> KEEP_ALIVE

Configure a channel to send a periodic heartbeat of some sort. The value type for this option is boolean.

BACKLOG

public static final Option<Integer> BACKLOG

Configure a server with the specified backlog. The value type for this option is int.

MANAGE_CONNECTIONS

public static final Option<Boolean> MANAGE_CONNECTIONS

Configure an acceptor to manage connections or to leave them unmanaged. A managed entity will appear in any registered MBean server, but there may be a performance penalty associated with management. In general it is recommended to always enable management, unless a specific performance problem is identified.

Since:

1.2

READ_THREADS

public static final Option<Integer> READ_THREADS

The number of read threads to create.

Since:

2.0

WRITE_THREADS

public static final Option<Integer> WRITE_THREADS

The number of write threads to create.

Since:

2.0

CONNECT_THREADS

public static final Option<Integer> CONNECT_THREADS

The number of connect threads to create.

Since:

2.0

SELECTOR_CACHE_SIZE

public static final Option<Integer> SELECTOR_CACHE_SIZE

The size of the selector cache (used only by providers which use NIO selectors).

Since:

2.0

MAX_INBOUND_MESSAGE_SIZE

public static final Option<Integer> MAX_INBOUND_MESSAGE_SIZE

The maximum inbound message size.

Since:

2.0

MAX_OUTBOUND_MESSAGE_SIZE

public static final Option<Integer> MAX_OUTBOUND_MESSAGE_SIZE

The maximum outbound message size.

Since:

2.0

SSL_CLIENT_AUTH_MODE

public static final Option<SslClientAuthMode> SSL_CLIENT_AUTH_MODE

Specify the SSL client authentication mode.

Since:

2.0

SSL_ENABLED_CIPHER_SUITES

public static final Option<Sequence<String>> SSL_ENABLED_CIPHER_SUITES

Specify the cipher suites for an SSL/TLS session. If a listed cipher suites is not supported, it is ignored; however, if you specify a list of cipher suites, none of which are supported, an exception will be thrown.

Since:

2.0

SSL_SUPPORTED_CIPHER_SUITES

public static final Option<Sequence<String>> SSL_SUPPORTED_CIPHER_SUITES

Get the supported cipher suites for an SSL/TLS session. This option is generally read-only.

Since:

2.0

SSL_ENABLED_PROTOCOLS

public static final Option<Sequence<String>> SSL_ENABLED_PROTOCOLS

Specify the enabled protocols for an SSL/TLS session. If a listed protocol is not supported, it is ignored; however, if you specify a list of protocols, none of which are supported, an exception will be thrown.

Since:

2.0

SSL_SUPPORTED_PROTOCOLS

public static final Option<Sequence<String>> SSL_SUPPORTED_PROTOCOLS

Get the supported protocols for an SSL/TLS session. This option is generally read-only.

Since:

2.0

SSL_PROVIDER

public static final Option<String> SSL_PROVIDER

Specify the requested provider for an SSL/TLS session.

Since:

2.0

SSL_PROTOCOL

public static final Option<String> SSL_PROTOCOL

Specify the protocol name for an SSL context.

Since:

2.1

SSL_SEND_BUFFER

public static final Option<Integer> SSL_SEND_BUFFER

Specify the SSL send buffer size.

Since:

2.0

SSL_RECEIVE_BUFFER

public static final Option<Integer> SSL_RECEIVE_BUFFER

Specify the SSL receive buffer size.

Since:

2.0

SSL_ENABLE_SESSION_CREATION

public static final Option<Boolean> SSL_ENABLE_SESSION_CREATION

Enable or disable session creation for an SSL connection. Defaults to true to enable session creation.

Since:

2.0

SSL_USE_CLIENT_MODE

public static final Option<Boolean> SSL_USE_CLIENT_MODE

Specify whether SSL conversations should be in client or server mode. Defaults to false (use server mode).

Since:

2.0

SECURE

public static final Option<Boolean> SECURE

Determine whether the channel is encrypted, or employs some other level of security. The interpretation of this flag is specific to the channel in question; however, whatever the channel type, this flag is generally read-only.

SASL_POLICY_FORWARD_SECRECY

public static final Option<Boolean> SASL_POLICY_FORWARD_SECRECY

Specify whether SASL mechanisms which implement forward secrecy between sessions are required.

See Also:

Sasl.POLICY_FORWARD_SECRECY

SASL_POLICY_NOACTIVE

public static final Option<Boolean> SASL_POLICY_NOACTIVE

Specify whether SASL mechanisms which are susceptible to active (non-dictionary) attacks are permitted.

See Also:

Sasl.POLICY_NOACTIVE

SASL_POLICY_NOANONYMOUS

public static final Option<Boolean> SASL_POLICY_NOANONYMOUS

Specify whether SASL mechanisms which accept anonymous logins are permitted.

See Also:

Sasl.POLICY_NOANONYMOUS

SASL_POLICY_NODICTIONARY

public static final Option<Boolean> SASL_POLICY_NODICTIONARY

Specify whether SASL mechanisms which are susceptible to passive dictionary attacks are permitted.

See Also:

Sasl.POLICY_NODICTIONARY

SASL_POLICY_NOPLAINTEXT

public static final Option<Boolean> SASL_POLICY_NOPLAINTEXT

Specify whether SASL mechanisms which are susceptible to simple plain passive attacks are permitted.

See Also:

Sasl.POLICY_NOPLAINTEXT

SASL_POLICY_PASS_CREDENTIALS

public static final Option<Boolean> SASL_POLICY_PASS_CREDENTIALS

Specify whether SASL mechanisms which pass client credentials are required.

See Also:

Sasl.POLICY_PASS_CREDENTIALS

SASL_QOP

public static final Option<Sequence<SaslQop>> SASL_QOP

Specify the SASL quality-of-protection to use.

See Also:

Sasl.QOP

SASL_STRENGTH

public static final Option<SaslStrength> SASL_STRENGTH

Specify the SASL cipher strength to use.

See Also:

Sasl.STRENGTH

SASL_SERVER_AUTH

public static final Option<Boolean> SASL_SERVER_AUTH

Specify whether the SASL server must authenticate to the client.

See Also:

Sasl.SERVER_AUTH

SASL_REUSE

public static final Option<Boolean> SASL_REUSE

Specify whether SASL mechanisms should attempt to reuse authenticated session information.

See Also:

Sasl.REUSE

SASL_MECHANISMS

public static final Option<Sequence<String>> SASL_MECHANISMS

A list of SASL mechanisms, in decreasing order of preference.