# Uses of Class
org.xnio.OptionMap

Packages that use OptionMap
Package
Description
org.xnio
The main API package for XNIO.
org.xnio.http
org.xnio.sasl
Utility classes for using SASL mechanisms atop NIO or XNIO APIs.
org.xnio.ssl
Utility classes for using and implementing SSL within XNIO providers.

## Uses of OptionMap in org.xnio

Fields in org.xnio declared as OptionMap
Modifier and Type
Field
Description
`static final OptionMap`
OptionMap.`EMPTY`
The empty option map.
Fields in org.xnio with type parameters of type OptionMap
Modifier and Type
Field
Description
`static final Option<OptionMap>`
Options.`SSL_RNG_OPTIONS`
The configuration of a secure RNG for SSL usage.
Methods in org.xnio that return OptionMap
Modifier and Type
Method
Description
`static <T> OptionMap`
OptionMap.`create(Option<T> option, T value)`
Create a single-valued option map.
`static <T1, T2> OptionMap`
OptionMap.`create(Option<T1> option1, T1 value1, Option<T2> option2, T2 value2)`
Create a two-valued option map.
`OptionMap`
OptionMap.Builder.`getMap()`
Build a map that reflects the current state of this builder.
Methods in org.xnio with parameters of type OptionMap
Modifier and Type
Method
Description
`IoFuture<ConnectedMessageChannel>`
XnioWorker.`acceptDatagram(SocketAddress destination, ChannelListener<? super ConnectedMessageChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`protected IoFuture<MessageConnection>`
XnioIoThread.`acceptLocalMessageConnection(LocalSocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to accept a local (UNIX domain) datagram connection.
`protected IoFuture<StreamConnection>`
XnioIoThread.`acceptLocalStreamConnection(LocalSocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to accept a local (UNIX domain) stream connection.
`IoFuture<MessageConnection>`
XnioIoFactory.`acceptMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Accept a message connection at a destination address.
`IoFuture<MessageConnection>`
XnioIoThread.`acceptMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<MessageConnection>`
XnioWorker.`acceptMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`acceptStream(SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<StreamConnection>`
XnioIoFactory.`acceptStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Accept a stream connection at a destination address.
`IoFuture<StreamConnection>`
XnioIoThread.`acceptStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`acceptStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`protected IoFuture<StreamConnection>`
XnioIoThread.`acceptTcpStreamConnection(InetSocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to accept a TCP connection.
`OptionMap.Builder`
OptionMap.Builder.`addAll(OptionMap optionMap)`
Add all entries from an existing option map to the one being built.
`IoFuture<ConnectedMessageChannel>`
XnioWorker.`connectDatagram(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super ConnectedMessageChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedMessageChannel>`
XnioWorker.`connectDatagram(SocketAddress destination, ChannelListener<? super ConnectedMessageChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`connectStream(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`connectStream(SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedStreamChannel>`
XnioWorker.`connectStream(SocketAddress destination, ChannelListener<? super ConnectedStreamChannel> openListener, OptionMap optionMap)`
Deprecated.
`FileSystemWatcher`
Xnio.`createFileSystemWatcher(String name, OptionMap options)`
Creates a file system watcher, that can be used to monitor file system changes.
`protected AcceptingChannel<StreamConnection>`
XnioWorker.`createLocalStreamConnectionServer(LocalSocketAddress bindAddress, ChannelListener<? super AcceptingChannel<StreamConnection>> acceptListener, OptionMap optionMap)`
Implementation helper method to create a UNIX domain stream server.
`void`
XnioWorker.`createOneWayPipe(ChannelListener<? super StreamSourceChannel> sourceListener, ChannelListener<? super StreamSinkChannel> sinkListener, OptionMap optionMap)`
Deprecated.
Users should prefer the simpler `XnioWorker.createHalfDuplexPipe()` instead.
`void`
XnioWorker.`createPipe(ChannelListener<? super StreamChannel> leftOpenListener, ChannelListener<? super StreamChannel> rightOpenListener, OptionMap optionMap)`
Deprecated.
Users should prefer the simpler `XnioWorker.createFullDuplexPipe()` instead.
`AcceptingChannel<StreamConnection>`
XnioWorker.`createStreamConnectionServer(SocketAddress bindAddress, ChannelListener<? super AcceptingChannel<StreamConnection>> acceptListener, OptionMap optionMap)`
Create a stream server, for TCP or UNIX domain servers.
`AcceptingChannel<? extends ConnectedStreamChannel>`
XnioWorker.`createStreamServer(SocketAddress bindAddress, ChannelListener<? super AcceptingChannel<ConnectedStreamChannel>> acceptListener, OptionMap optionMap)`
Deprecated.
`protected AcceptingChannel<StreamConnection>`
XnioWorker.`createTcpConnectionServer(InetSocketAddress bindAddress, ChannelListener<? super AcceptingChannel<StreamConnection>> acceptListener, OptionMap optionMap)`
Implementation helper method to create a TCP stream server.
`MulticastMessageChannel`
XnioWorker.`createUdpServer(InetSocketAddress bindAddress, ChannelListener<? super MulticastMessageChannel> bindListener, OptionMap optionMap)`
Create a UDP server.
`MulticastMessageChannel`
XnioWorker.`createUdpServer(InetSocketAddress bindAddress, OptionMap optionMap)`
Create a UDP server.
`XnioWorker`
Xnio.`createWorker(ThreadGroup threadGroup, OptionMap optionMap)`
Construct a new XNIO worker.
`XnioWorker`
Xnio.`createWorker(ThreadGroup threadGroup, OptionMap optionMap, Runnable terminationTask)`
Construct a new XNIO worker.
`XnioWorker`
Xnio.`createWorker(OptionMap optionMap)`
Construct a new XNIO worker.
`boolean`
OptionMap.`equals(OptionMap other)`
Determine whether this option map is equal to another.
`StreamSinkChannel`
XnioWorker.`getDeflatingChannel(StreamSinkChannel delegate, OptionMap options)`
Create a stream channel that compresses to the destination according to the configuration in the given option map.
`StreamSourceChannel`
XnioWorker.`getInflatingChannel(StreamSourceChannel delegate, OptionMap options)`
Create a stream channel that decompresses the source data according to the configuration in the given option map.
`XnioSsl`
Xnio.`getSslProvider(KeyManager[] keyManagers, TrustManager[] trustManagers, OptionMap optionMap)`
Get an SSL provider for this XNIO provider.
`XnioSsl`
Xnio.`getSslProvider(OptionMap optionMap)`
Get an SSL provider for this XNIO provider.
`FileChannel`
Xnio.`openFile(File file, OptionMap options)`
Open a file on the filesystem.
`FileChannel`
Xnio.`openFile(String fileName, OptionMap options)`
Open a file on the filesystem.
`protected IoFuture<MessageConnection>`
XnioIoThread.`openLocalMessageConnection(LocalSocketAddress bindAddress, LocalSocketAddress destinationAddress, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
Implementation helper method to connect to a local (UNIX domain) server.
`protected IoFuture<StreamConnection>`
XnioIoThread.`openLocalStreamConnection(LocalSocketAddress bindAddress, LocalSocketAddress destinationAddress, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to connect to a local (UNIX domain) server.
`IoFuture<MessageConnection>`
XnioIoFactory.`openMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
Connect to a remote message server.
`IoFuture<MessageConnection>`
XnioIoThread.`openMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
`IoFuture<MessageConnection>`
XnioWorker.`openMessageConnection(SocketAddress destination, ChannelListener<? super MessageConnection> openListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioIoFactory.`openStreamConnection(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Connect to a remote stream server.
`IoFuture<StreamConnection>`
XnioIoFactory.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Connect to a remote stream server.
`IoFuture<StreamConnection>`
XnioIoFactory.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, OptionMap optionMap)`
Connect to a remote stream server.
`IoFuture<StreamConnection>`
XnioIoThread.`openStreamConnection(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioIoThread.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioIoThread.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`openStreamConnection(SocketAddress bindAddress, SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<StreamConnection>`
XnioWorker.`openStreamConnection(SocketAddress destination, ChannelListener<? super StreamConnection> openListener, OptionMap optionMap)`
`protected IoFuture<StreamConnection>`
XnioIoThread.`openTcpStreamConnection(InetSocketAddress bindAddress, InetSocketAddress destinationAddress, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Implementation helper method to connect to a TCP server.
`XnioWorker.Builder`
XnioWorker.Builder.`populateFromOptions(OptionMap optionMap)`

## Uses of OptionMap in org.xnio.http

Methods in org.xnio.http with parameters of type OptionMap
Modifier and Type
Method
Description
`static IoFuture<StreamConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, InetSocketAddress bindAddress, URI uri, Map<String,String> headers, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, HandshakeChecker handshakeChecker)`
Connects to the target server using HTTP upgrade.
`static IoFuture<StreamConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, InetSocketAddress bindAddress, URI uri, Map<String,List<String>> headers, ChannelListener<? super StreamConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, ExtendedHandshakeChecker handshakeChecker)`
Connects to the target server using HTTP upgrade.
`static IoFuture<SslConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, XnioSsl ssl, InetSocketAddress bindAddress, URI uri, Map<String,String> headers, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, HandshakeChecker handshakeChecker)`
Perform a HTTP upgrade that results in a SSL secured connection.
`static IoFuture<SslConnection>`
HttpUpgrade.`performUpgrade(XnioWorker worker, XnioSsl ssl, InetSocketAddress bindAddress, URI uri, Map<String,List<String>> headers, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap, ExtendedHandshakeChecker handshakeChecker)`
Perform a HTTP upgrade that results in a SSL secured connection.

## Uses of OptionMap in org.xnio.sasl

Methods in org.xnio.sasl with parameters of type OptionMap
Modifier and Type
Method
Description
`static Map<String,Object>`
SaslUtils.`createPropertyMap(OptionMap optionMap, boolean secure)`
Create a SASL property map from an XNIO option map.

## Uses of OptionMap in org.xnio.ssl

Methods in org.xnio.ssl with parameters of type OptionMap
Modifier and Type
Method
Description
`IoFuture<ConnectedSslStreamChannel>`
JsseXnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`abstract IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Deprecated.
`IoFuture<ConnectedSslStreamChannel>`
XnioSsl.`connectSsl(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super ConnectedSslStreamChannel> openListener, OptionMap optionMap)`
Deprecated.
`AcceptingChannel<SslConnection>`
JsseXnioSsl.`createSslConnectionServer(XnioWorker worker, InetSocketAddress bindAddress, ChannelListener<? super AcceptingChannel<SslConnection>> acceptListener, OptionMap optionMap)`
`abstract AcceptingChannel<SslConnection>`
XnioSsl.`createSslConnectionServer(XnioWorker worker, InetSocketAddress bindAddress, ChannelListener<? super AcceptingChannel<SslConnection>> acceptListener, OptionMap optionMap)`
Create a bound TCP SSL server.
`static SSLContext`
JsseSslUtils.`createSSLContext(KeyManager[] keyManagers, TrustManager[] trustManagers, SecureRandom secureRandom, OptionMap optionMap)`
Create a new SSL context, configured from an option map and the given parameters.
`static SSLContext`
JsseSslUtils.`createSSLContext(OptionMap optionMap)`
Create a new SSL context, configured from an option map.
`static SSLEngine`
JsseSslUtils.`createSSLEngine(SSLContext sslContext, OptionMap optionMap, InetSocketAddress peerAddress)`
Create a new client mode SSL engine, configured from an option map.
`AcceptingChannel<ConnectedSslStreamChannel>`
JsseXnioSsl.`createSslTcpServer(XnioWorker worker, InetSocketAddress bindAddress, ChannelListener<? super AcceptingChannel<ConnectedSslStreamChannel>> acceptListener, OptionMap optionMap)`
`abstract AcceptingChannel<ConnectedSslStreamChannel>`
XnioSsl.`createSslTcpServer(XnioWorker worker, InetSocketAddress bindAddress, ChannelListener<? super AcceptingChannel<ConnectedSslStreamChannel>> acceptListener, OptionMap optionMap)`
Deprecated.
`IoFuture<SslConnection>`
JsseXnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`IoFuture<SslConnection>`
JsseXnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
`abstract IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioIoThread ioThread, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`abstract IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress bindAddress, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, ChannelListener<? super BoundChannel> bindListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
`IoFuture<SslConnection>`
XnioSsl.`openSslConnection(XnioWorker worker, InetSocketAddress destination, ChannelListener<? super SslConnection> openListener, OptionMap optionMap)`
Create an SSL connection to a remote host.
Constructors in org.xnio.ssl with parameters of type OptionMap
Modifier
Constructor
Description
``
`JsseXnioSsl(Xnio xnio, OptionMap optionMap)`
Construct a new instance.
``
`JsseXnioSsl(Xnio xnio, OptionMap optionMap, SSLContext sslContext)`
Construct a new instance.
`protected`
`XnioSsl(Xnio xnio, SSLContext sslContext, OptionMap optionMap)`
Construct a new instance.