Options (NATS.IO Java API)

java.lang.Object
- io.nats.client.Options

```
public class Options
extends java.lang.Object
```
The Options class specifies the connection options for a new NATs connection, including the default options. Options are created using a Builder. This class and the builder associated with it, is basically a long list of parameters. The documentation attempts to clarify the value of each parameter in place on the builder and here, but it may be easier to read the documentation starting with the Builder, since it has a simple list of methods that configure the connection.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Options.Builder
Options are created using a Builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Options.Builder` Options are created using a Builder.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BUFFER_SIZE` Default size for buffers in the connection, not as available as other settings, this is primarily changed for testing, `getBufferSize()`.
`static java.time.Duration`	`DEFAULT_CONNECTION_TIMEOUT` Default connection timeout, see `getConnectionTimeout()`.
`static java.lang.String`	`DEFAULT_DATA_PORT_TYPE` Default dataport class, which will use a TCP socket, `getDataPortType()`.
`static boolean`	`DEFAULT_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL` This value is used internally to discard messages when the outgoing queue is full.
`static java.lang.String`	`DEFAULT_INBOX_PREFIX` Default prefix used for inboxes, you can change this to manage authorization of subjects.
`static int`	`DEFAULT_MAX_CONTROL_LINE` The default length, 4096 bytes, the client will allow in an outgoing protocol control line, `getMaxControlLine()`.
`static int`	`DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE` This value is used internally to limit the number of messages allowed in the outgoing queue.
`static int`	`DEFAULT_MAX_PINGS_OUT` Default maximum number of pings have not received a response allowed by the client, `getMaxPingsOut()`.
`static int`	`DEFAULT_MAX_RECONNECT` Default maximum number of reconnect attempts, see `getMaxReconnect()`.
`static java.time.Duration`	`DEFAULT_PING_INTERVAL` Default server ping interval.
`static int`	`DEFAULT_PORT` Default server port.
`static int`	`DEFAULT_RECONNECT_BUF_SIZE` Default of pending message buffer that is used for buffering messages that are published during a disconnect/reconnect, `getReconnectBufferSize()`.
`static java.time.Duration`	`DEFAULT_RECONNECT_JITTER` Default wait time before attempting reconnection to the same server, see `getReconnectJitter()`.
`static java.time.Duration`	`DEFAULT_RECONNECT_JITTER_TLS` Default wait time before attempting reconnection to the same server, see `getReconnectJitterTls()`.
`static java.time.Duration`	`DEFAULT_RECONNECT_WAIT` Default wait time before attempting reconnection to the same server, see `getReconnectWait()`.
`static java.time.Duration`	`DEFAULT_REQUEST_CLEANUP_INTERVAL` Default interval to clean up cancelled/timed out requests.
`static java.util.function.Supplier<java.util.concurrent.ExecutorService>`	`DEFAULT_SINGLE_THREAD_EXECUTOR` Default supplier for creating a single-threaded executor service.
`static java.time.Duration`	`DEFAULT_SOCKET_WRITE_TIMEOUT` Default socket write timeout, see `getSocketWriteTimeout()`.
`static java.lang.String`	`DEFAULT_SSL_PROTOCOL` Default SSL protocol used to create an SSLContext if the `secure property` is used.
`static java.lang.String`	`DEFAULT_THREAD_NAME_PREFIX` Default thread name prefix.
`static java.lang.String`	`DEFAULT_URL` Default server URL.
`static int`	`MAX_MESSAGES_IN_NETWORK_BUFFER` This value is used internally to limit the number of messages sent in a single network I/O.
`static long`	`MINIMUM_SOCKET_READ_TIMEOUT_GT_CONNECTION_TIMEOUT` Deprecated. No longer enforcing a minimum
`static long`	`MINIMUM_SOCKET_WRITE_TIMEOUT_GT_CONNECTION_TIMEOUT` Deprecated. No longer enforcing a minimum compared to the connection timeout
`static long`	`MINIMUM_SOCKET_WRITE_TIMEOUT_NANOS` This is set to 100 nanos to ensure that the scheduled task can execute
`static java.lang.String`	`PROP_CALLBACK_THREAD_FACTORY_CLASS` Property used to set class name for the Callback Thread Factory `callbackThreadFactory`.
`static java.lang.String`	`PROP_CLEANUP_INTERVAL` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_CLIENT_SIDE_LIMIT_CHECKS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_CONNECT_THREAD_FACTORY_CLASS` Property used to set class name for the Connect Thread Factory `connectThreadFactory`.
`static java.lang.String`	`PROP_CONNECTION_CB` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_CONNECTION_NAME` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_CONNECTION_TIMEOUT` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_CREDENTIAL_PATH` Property used to set the path to a credentials file to be used in a FileAuthHandler
`static java.lang.String`	`PROP_DATA_PORT_TYPE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_DISPATCHER_FACTORY_CLASS` Property used to set class name for the Dispatcher Factory `dispatcherFactory`.
`static java.lang.String`	`PROP_ERROR_LISTENER` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_EXECUTOR_SERVICE_CLASS` Property used to set class name for the Executor Service (executor) class `executor`.
`static java.lang.String`	`PROP_FAST_FALLBACK` Property used to enable fast fallback algorithm for socket connection.
`static java.lang.String`	`PROP_FORCE_FLUSH_ON_REQUEST` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_IGNORE_DISCOVERED_SERVERS` Property used to set whether to ignore discovered servers when connecting
`static java.lang.String`	`PROP_IGNORE_DISCOVERED_SERVERS_PREFERRED` Preferred property used to set whether to ignore discovered servers when connecting
`static java.lang.String`	`PROP_INBOX_PREFIX` Property used to set the inbox prefix
`static java.lang.String`	`PROP_KEYSTORE` Property for the keystore path used to create an SSLContext
`static java.lang.String`	`PROP_KEYSTORE_PASSWORD` Property for the keystore password used to create an SSLContext
`static java.lang.String`	`PROP_MAX_CONTROL_LINE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_MAX_MESSAGES_IN_OUTGOING_QUEUE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_MAX_PINGS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_MAX_RECONNECT` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_NO_ECHO` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_NO_HEADERS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_NO_NORESPONDERS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_NO_RESOLVE_HOSTNAMES` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_NORANDOMIZE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_OPENTLS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_PASSWORD` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_PEDANTIC` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_PING_INTERVAL` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_READ_LISTENER_CLASS` Property used to set class name for the ReaderListener implementation `readListener`.
`static java.lang.String`	`PROP_RECONNECT_BUF_SIZE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_RECONNECT_JITTER` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_RECONNECT_JITTER_TLS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_RECONNECT_WAIT` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_REPORT_NO_RESPONDERS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SCHEDULED_EXECUTOR_SERVICE_CLASS` Property used to set class name for the Executor Service (executor) class `executor`.
`static java.lang.String`	`PROP_SECURE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SERVERS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SERVERS_POOL_IMPLEMENTATION_CLASS` Property used to set class name for ServerPool implementation `serverPool`.
`static java.lang.String`	`PROP_SERVERS_POOL_IMPLEMENTATION_CLASS_PREFERRED` Preferred property used to set class name for ServerPool implementation `serverPool`.
`static java.lang.String`	`PROP_SOCKET_READ_TIMEOUT_MS` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SOCKET_RECEIVE_BUFFER_SIZE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SOCKET_SEND_BUFFER_SIZE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SOCKET_SO_LINGER` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SOCKET_WRITE_TIMEOUT` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_SSL_CONTEXT_FACTORY_CLASS` Property used to set class name for the SSLContextFactory `sslContextFactory`.
`static java.lang.String`	`PROP_STATISTICS_COLLECTOR` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_TIME_TRACE_LOGGER` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_TLS_ALGORITHM` Property for the algorithm used to create an SSLContext
`static java.lang.String`	`PROP_TLS_FIRST` Property used to configure tls first behavior This property is a boolean flag, telling connections whether to do TLS upgrade first, before INFO
`static java.lang.String`	`PROP_TOKEN` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_TOKEN_SUPPLIER` Property used to configure the token supplier from a Properties object.
`static java.lang.String`	`PROP_TRUSTSTORE` Property for the truststore path used to create an SSLContext
`static java.lang.String`	`PROP_TRUSTSTORE_PASSWORD` Property for the truststore password used to create an SSLContext
`static java.lang.String`	`PROP_URL` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_USE_DISPATCHER_WITH_EXECUTOR` Property used to a dispatcher that dispatches messages via the executor service instead of with a blocking call.
`static java.lang.String`	`PROP_USE_OLD_REQUEST_STYLE` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_USE_TIMEOUT_EXCEPTION` Property used to throw `TimeoutException` on timeout instead of `CancellationException`.
`static java.lang.String`	`PROP_USERNAME` Property used to configure a builder from a Properties object.
`static java.lang.String`	`PROP_UTF8_SUBJECTS` This property is used to enable support for UTF8 subjects.
`static java.lang.String`	`PROP_VERBOSE` Property used to configure a builder from a Properties object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`io.nats.client.impl.DataPort`	`buildDataPort()` the data port described by these options
`static Options.Builder`	`builder()` Creates a builder for the options in a fluent style
`java.nio.CharBuffer`	`buildProtocolConnectOptionsString(java.lang.String serverURI, boolean includeAuth, byte[] nonce)` Create the options string sent with the connect message.
`boolean`	`clientSideLimitChecks()` clientSideLimitChecks
`java.net.URI`	`createURIForServer(java.lang.String serverURI)` create a URI from a server uri.
`boolean`	`executorIsInternal()` whether the general executor is the internal one versus a user supplied one
`boolean`	`forceFlushOnRequest()` Whether to flush on any user request
`AuthHandler`	`getAuthHandler()` the auth handler, or null, see `authHandler()` in the builder doc
`int`	`getBufferSize()` the default size for buffers in the connection code, see `bufferSize()` in the builder doc
`java.util.concurrent.ExecutorService`	`getCallbackExecutor()` the callback executor, see `callbackThreadFactory()` in the builder doc
`java.util.concurrent.ExecutorService`	`getConnectExecutor()` the connect executor, see `connectThreadFactory()` in the builder doc
`ConnectionListener`	`getConnectionListener()` the connection listener, or null, see `connectionListener()` in the builder doc
`java.lang.String`	`getConnectionName()` the connectionName, see `connectionName()` in the builder doc
`java.time.Duration`	`getConnectionTimeout()` the connectionTimeout, see `connectionTimeout()` in the builder doc
`java.lang.String`	`getDataPortType()` the DataPort class type for connections created by this options object, see `dataPortType()` in the builder doc
`io.nats.client.impl.DispatcherFactory`	`getDispatcherFactory()` Get the DispatcherFactory implementation.
`ErrorListener`	`getErrorListener()` the error listener.
`java.util.concurrent.ExecutorService`	`getExecutor()` Get the general executor
`java.util.List<java.util.function.Consumer<io.nats.client.support.HttpRequest>>`	`getHttpRequestInterceptors()` the list of HttpRequest interceptors.
`java.lang.String`	`getInboxPrefix()` the inbox prefix to use for requests, see `inboxPrefix()` in the builder doc
`int`	`getMaxControlLine()` the maximum length of a control line, see `maxControlLine()` in the builder doc
`int`	`getMaxMessagesInOutgoingQueue()` the maximum number of messages in the outgoing queue, see `maxMessagesInOutgoingQueue(int)` in the builder doc
`int`	`getMaxPingsOut()` the maxPingsOut to limit the number of pings on the wire, see `maxPingsOut()` in the builder doc
`int`	`getMaxReconnect()` the maxReconnect attempts to make before failing, see `maxReconnects()` in the builder doc
`java.util.List<io.nats.client.support.NatsUri>`	`getNatsServerUris()` the servers as configured in options as NatsUri's, see `servers()` in the builder doc
`java.lang.String`	`getPassword()` Deprecated. converts the char array to a string, use getPasswordChars instead for more security
`char[]`	`getPasswordChars()` the password to use for basic authentication, see `userInfo()` in the builder doc
`java.time.Duration`	`getPingInterval()` the pingInterval, see `pingInterval()` in the builder doc
`java.net.Proxy`	`getProxy()` the proxy to used for all sockets.
`ReadListener`	`getReadListener()` the read listener, or null, see `readListener()` in the builder doc
`int`	`getReceiveBufferSize()` the number of bytes to set the for the SO_RCVBUF property on the socket
`long`	`getReconnectBufferSize()` the reconnectBufferSize, to limit the amount of data held during reconnection attempts, see `reconnectBufferSize()` in the builder doc
`ReconnectDelayHandler`	`getReconnectDelayHandler()` the reconnection delay handler, or null, see `reconnectDelayHandler()` in the builder doc
`java.time.Duration`	`getReconnectJitter()` the reconnectJitter, used between reconnect attempts to vary the reconnect wait, see `reconnectJitter()` in the builder doc
`java.time.Duration`	`getReconnectJitterTls()` the reconnectJitterTls, used between reconnect attempts to vary the reconnect wait whe using tls/secure, see `reconnectJitterTls()` in the builder doc
`java.time.Duration`	`getReconnectWait()` the reconnectWait, used between reconnect attempts, see `reconnectWait()` in the builder doc
`java.time.Duration`	`getRequestCleanupInterval()` the request cleanup interval, see `requestCleanupInterval()` in the builder doc
`java.util.concurrent.ScheduledExecutorService`	`getScheduledExecutor()` Get the ScheduledExecutorService instance
`int`	`getSendBufferSize()` the number of bytes to set the for the SO_SNDBUF property on the socket
`ServerPool`	`getServerPool()` Get the ServerPool implementation.
`java.util.List<java.net.URI>`	`getServers()` the servers as configured in options as URI's, see `servers()` in the builder doc
`int`	`getSocketReadTimeoutMillis()` the socketReadTimeoutMillis, see `socketReadTimeoutMillis` in the builder doc
`int`	`getSocketSoLinger()` the socket so linger number of seconds, see `socketSoLinger()` in the builder doc
`java.time.Duration`	`getSocketWriteTimeout()` the socketWriteTimeout, see `socketWriteTimeout` in the builder doc
`javax.net.ssl.SSLContext`	`getSslContext()` the sslContext, see `secure()` in the builder doc
`StatisticsCollector`	`getStatisticsCollector()` the statistics collector, or null, see `statisticsCollector()` in the builder doc
`TimeTraceLogger`	`getTimeTraceLogger()` If the user provided a TimeTraceLogger, it's returned here.
`java.lang.String`	`getToken()` Deprecated. converts the char array to a string, use getTokenChars instead for more security
`char[]`	`getTokenChars()` the token to be used for token-based authentication, see `token()` in the builder doc generated from the token supplier if the user supplied one.
`java.util.List<java.lang.String>`	`getUnprocessedServers()` the servers as given to the options, since the servers are normalized
`java.lang.String`	`getUsername()` Deprecated. converts the char array to a string, use getUserNameChars instead for more security
`char[]`	`getUsernameChars()` the username to use for basic authentication, see `userInfo()` in the builder doc
`boolean`	`isDiscardMessagesWhenOutgoingQueueFull()` should we discard messages when the outgoing queue is full, see `discardMessagesWhenOutgoingQueueFull()` in the builder doc
`boolean`	`isEnableFastFallback()` Whether Fast fallback algorithm is enabled for socket connect
`boolean`	`isIgnoreDiscoveredServers()` Get whether to ignore discovered servers
`boolean`	`isNoEcho()` is echo-ing disabled, see `noEcho()` in the builder doc
`boolean`	`isNoHeaders()` are headers disabled, see `noHeaders()` in the builder doc
`boolean`	`isNoNoResponders()` is NoResponders ignored disabled, see `noNoResponders()` in the builder doc
`boolean`	`isNoRandomize()` should we turn off randomization for server connection attempts, see `noRandomize()` in the builder doc
`boolean`	`isNoResolveHostnames()` should we resolve hostnames for server connection attempts, see `noResolveHostnames()` in the builder doc
`boolean`	`isOldRequestStyle()` the flag to turn on old style requests, see `oldStyleRequest()` in the builder doc
`boolean`	`isPedantic()` are we using pedantic protocol, see `pedantic()` in the builder doc
`boolean`	`isReportNoResponders()` should complete with exception futures for requests that get no responders instead of cancelling the future, see `reportNoResponders()` in the builder doc
`boolean`	`isTlsFirst()` Get whether to do tls first
`boolean`	`isTLSRequired()` is there an sslContext for these Options, otherwise false, see `secure()` in the builder doc
`boolean`	`isTraceConnection()` If isTraceConnection is true, the user provided a TimeTraceLogger or manually called traceConnection in the builder
`boolean`	`isTrackAdvancedStats()` should we track advanced stats, see `turnOnAdvancedStats()` in the builder doc
`boolean`	`isVerbose()` are we in verbose mode, see `verbose()` in the builder doc
`boolean`	`scheduledExecutorIsInternal()` whether the scheduled executor is the internal one versus a user supplied one
`void`	`setOldRequestStyle(boolean value)` Deprecated. Use Builder
`boolean`	`supportUTF8Subjects()` whether utf8 subjects are supported, see `supportUTF8Subjects()` in the builder doc.
`boolean`	`useDispatcherWithExecutor()` Whether the dispatcher should use an executor to async messages to handlers
`boolean`	`useTimeoutException()` Get whether to throw `TimeoutException` on timeout instead of `CancellationException`.

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

- Field Detail
  - DEFAULT_URL
```
public static final java.lang.String DEFAULT_URL
```
    Default server URL. This property is defined as "nats://localhost:4222"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    Default server port. This property is defined as 4222
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RECONNECT
```
public static final int DEFAULT_MAX_RECONNECT
```
    Default maximum number of reconnect attempts, see getMaxReconnect(). This property is defined as 60
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECONNECT_WAIT
```
public static final java.time.Duration DEFAULT_RECONNECT_WAIT
```
    Default wait time before attempting reconnection to the same server, see getReconnectWait(). This property is defined as 2000 milliseconds (2 seconds).
  - DEFAULT_RECONNECT_JITTER
```
public static final java.time.Duration DEFAULT_RECONNECT_JITTER
```
    Default wait time before attempting reconnection to the same server, see getReconnectJitter(). This property is defined as 100 milliseconds.
  - DEFAULT_RECONNECT_JITTER_TLS
```
public static final java.time.Duration DEFAULT_RECONNECT_JITTER_TLS
```
    Default wait time before attempting reconnection to the same server, see getReconnectJitterTls(). This property is defined as 1000 milliseconds (1 second).
  - DEFAULT_CONNECTION_TIMEOUT
```
public static final java.time.Duration DEFAULT_CONNECTION_TIMEOUT
```
    Default connection timeout, see getConnectionTimeout(). This property is defined as 2 seconds.
  - DEFAULT_SOCKET_WRITE_TIMEOUT
```
public static final java.time.Duration DEFAULT_SOCKET_WRITE_TIMEOUT
```
    Default socket write timeout, see getSocketWriteTimeout(). This property is defined as 1 minute
  - MINIMUM_SOCKET_WRITE_TIMEOUT_GT_CONNECTION_TIMEOUT
```
@Deprecated
public static final long MINIMUM_SOCKET_WRITE_TIMEOUT_GT_CONNECTION_TIMEOUT
```
    Deprecated. No longer enforcing a minimum compared to the connection timeout
    
    See Also:
    
    Constant Field Values
  - MINIMUM_SOCKET_WRITE_TIMEOUT_NANOS
```
public static final long MINIMUM_SOCKET_WRITE_TIMEOUT_NANOS
```
    This is set to 100 nanos to ensure that the scheduled task can execute
    
    See Also:
    
    Constant Field Values
  - MINIMUM_SOCKET_READ_TIMEOUT_GT_CONNECTION_TIMEOUT
```
@Deprecated
public static final long MINIMUM_SOCKET_READ_TIMEOUT_GT_CONNECTION_TIMEOUT
```
    Deprecated. No longer enforcing a minimum
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PING_INTERVAL
```
public static final java.time.Duration DEFAULT_PING_INTERVAL
```
    Default server ping interval. The client will send a ping to the server on this interval to insure liveness. The server may send pings to the client as well, these are handled automatically by the library, see getPingInterval().
    A value of <=0 means disabled.
    
    This property is defined as 2 minutes.
  - DEFAULT_REQUEST_CLEANUP_INTERVAL
```
public static final java.time.Duration DEFAULT_REQUEST_CLEANUP_INTERVAL
```
    Default interval to clean up cancelled/timed out requests. A timer is used to clean up futures that were handed out but never completed via a message, getRequestCleanupInterval().
    This property is defined as 5 seconds.
  - DEFAULT_MAX_PINGS_OUT
```
public static final int DEFAULT_MAX_PINGS_OUT
```
    Default maximum number of pings have not received a response allowed by the client, getMaxPingsOut().
    This property is defined as 2
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_PROTOCOL
```
public static final java.lang.String DEFAULT_SSL_PROTOCOL
```
    Default SSL protocol used to create an SSLContext if the secure property is used.
    This property is defined as "TLSv1.2"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECONNECT_BUF_SIZE
```
public static final int DEFAULT_RECONNECT_BUF_SIZE
```
    Default of pending message buffer that is used for buffering messages that are published during a disconnect/reconnect, getReconnectBufferSize().
    This property is defined as 8388608 bytes, 8 * 1024 * 1024.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_CONTROL_LINE
```
public static final int DEFAULT_MAX_CONTROL_LINE
```
    The default length, 4096 bytes, the client will allow in an outgoing protocol control line, getMaxControlLine().
    This value is configurable on the server, and should be set here to match.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATA_PORT_TYPE
```
public static final java.lang.String DEFAULT_DATA_PORT_TYPE
```
    Default dataport class, which will use a TCP socket, getDataPortType().
    This option is currently provided only for testing, and experimentation, the default should be used in almost all cases.
  - DEFAULT_BUFFER_SIZE
```
public static final int DEFAULT_BUFFER_SIZE
```
    Default size for buffers in the connection, not as available as other settings, this is primarily changed for testing, getBufferSize().
    
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_NAME_PREFIX
```
public static final java.lang.String DEFAULT_THREAD_NAME_PREFIX
```
    Default thread name prefix. Used by the default executor when creating threads. This property is defined as "nats"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INBOX_PREFIX
```
public static final java.lang.String DEFAULT_INBOX_PREFIX
```
    Default prefix used for inboxes, you can change this to manage authorization of subjects. See getInboxPrefix(), the . is required but will be added if missing.
    
    See Also:
    
    Constant Field Values
  - MAX_MESSAGES_IN_NETWORK_BUFFER
```
public static final int MAX_MESSAGES_IN_NETWORK_BUFFER
```
    This value is used internally to limit the number of messages sent in a single network I/O. The value returned by getBufferSize() is used first, but if the buffer size is large and the message sizes are small, this limit comes into play. The choice of 1000 is arbitrary and based on testing across several operating systems. Use buffer size for tuning.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE
```
public static final int DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE
```
    This value is used internally to limit the number of messages allowed in the outgoing queue. When this limit is reached, publish requests will be blocked until the queue can clear. Because this value is in messages, the memory size associated with this value depends on the actual size of messages. If 0 byte messages are used, then DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE will take up the minimal space. If 1024 byte messages are used then approximately 5Mb is used for the queue (plus overhead for subjects, etc..) We are using messages, not bytes, to allow a simplification in the underlying library, and use LinkedBlockingQueue as the core element in the queue.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL
```
public static final boolean DEFAULT_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL
```
    This value is used internally to discard messages when the outgoing queue is full. See DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SINGLE_THREAD_EXECUTOR
```
public static final java.util.function.Supplier<java.util.concurrent.ExecutorService> DEFAULT_SINGLE_THREAD_EXECUTOR
```
    Default supplier for creating a single-threaded executor service.
  - PROP_CONNECTION_CB
```
public static final java.lang.String PROP_CONNECTION_CB
```
    Property used to configure a builder from a Properties object. "io.nats.client.callback.connection", see connectionListener.
    
    See Also:
    
    Constant Field Values
  - PROP_DATA_PORT_TYPE
```
public static final java.lang.String PROP_DATA_PORT_TYPE
```
    Property used to configure a builder from a Properties object. "io.nats.client.dataport.type", see dataPortType.
    
    See Also:
    
    Constant Field Values
  - PROP_ERROR_LISTENER
```
public static final java.lang.String PROP_ERROR_LISTENER
```
    Property used to configure a builder from a Properties object. "io.nats.client.callback.error", see errorListener.
    
    See Also:
    
    Constant Field Values
  - PROP_TIME_TRACE_LOGGER
```
public static final java.lang.String PROP_TIME_TRACE_LOGGER
```
    Property used to configure a builder from a Properties object. "io.nats.client.time.trace", see timeTraceLogger.
    
    See Also:
    
    Constant Field Values
  - PROP_STATISTICS_COLLECTOR
```
public static final java.lang.String PROP_STATISTICS_COLLECTOR
```
    Property used to configure a builder from a Properties object. "io.nats.client.statisticscollector", see statisticsCollector.
    
    See Also:
    
    Constant Field Values
  - PROP_MAX_PINGS
```
public static final java.lang.String PROP_MAX_PINGS
```
    Property used to configure a builder from a Properties object. "io.nats.client.maxpings", see maxPingsOut.
    
    See Also:
    
    Constant Field Values
  - PROP_PING_INTERVAL
```
public static final java.lang.String PROP_PING_INTERVAL
```
    Property used to configure a builder from a Properties object. "io.nats.client.pinginterval", see pingInterval.
    
    See Also:
    
    Constant Field Values
  - PROP_CLEANUP_INTERVAL
```
public static final java.lang.String PROP_CLEANUP_INTERVAL
```
    Property used to configure a builder from a Properties object. "io.nats.client.cleanupinterval", see requestCleanupInterval.
    
    See Also:
    
    Constant Field Values
  - PROP_CONNECTION_TIMEOUT
```
public static final java.lang.String PROP_CONNECTION_TIMEOUT
```
    Property used to configure a builder from a Properties object. "io.nats.client.timeout", see connectionTimeout.
    
    See Also:
    
    Constant Field Values
  - PROP_SOCKET_READ_TIMEOUT_MS
```
public static final java.lang.String PROP_SOCKET_READ_TIMEOUT_MS
```
    Property used to configure a builder from a Properties object. "io.nats.client.socket.read.timeout.ms", see socketReadTimeoutMillis.
    
    See Also:
    
    Constant Field Values
  - PROP_SOCKET_WRITE_TIMEOUT
```
public static final java.lang.String PROP_SOCKET_WRITE_TIMEOUT
```
    Property used to configure a builder from a Properties object. "io.nats.client.socket.write.timeout", see socketWriteTimeout.
    
    See Also:
    
    Constant Field Values
  - PROP_SOCKET_SO_LINGER
```
public static final java.lang.String PROP_SOCKET_SO_LINGER
```
    Property used to configure a builder from a Properties object. "io.nats.client.socket.so.linger", see socketSoLinger.
    
    See Also:
    
    Constant Field Values
  - PROP_SOCKET_RECEIVE_BUFFER_SIZE
```
public static final java.lang.String PROP_SOCKET_RECEIVE_BUFFER_SIZE
```
    Property used to configure a builder from a Properties object. "io.nats.client.socket.receive.buffer.size", see receiveBufferSize. OVERRIDES THE UNDERLYING JAVA SOCKET IMPLEMENTATION - USE AT YOUR OWN RISK
    
    See Also:
    
    Constant Field Values
  - PROP_SOCKET_SEND_BUFFER_SIZE
```
public static final java.lang.String PROP_SOCKET_SEND_BUFFER_SIZE
```
    Property used to configure a builder from a Properties object. "io.nats.client.socket.send.buffer.size", see sendBufferSize. OVERRIDES THE UNDERLYING JAVA SOCKET IMPLEMENTATION - USE AT YOUR OWN RISK
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_BUF_SIZE
```
public static final java.lang.String PROP_RECONNECT_BUF_SIZE
```
    Property used to configure a builder from a Properties object. "io.nats.client.reconnect.buffer.size", see reconnectBufferSize.
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_WAIT
```
public static final java.lang.String PROP_RECONNECT_WAIT
```
    Property used to configure a builder from a Properties object. "io.nats.client.reconnect.wait", see reconnectWait.
    
    See Also:
    
    Constant Field Values
  - PROP_MAX_RECONNECT
```
public static final java.lang.String PROP_MAX_RECONNECT
```
    Property used to configure a builder from a Properties object. "io.nats.client.reconnect.max", see maxReconnects.
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_JITTER
```
public static final java.lang.String PROP_RECONNECT_JITTER
```
    Property used to configure a builder from a Properties object. "io.nats.client.reconnect.jitter", see reconnectJitter.
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_JITTER_TLS
```
public static final java.lang.String PROP_RECONNECT_JITTER_TLS
```
    Property used to configure a builder from a Properties object. "io.nats.client.reconnect.jitter.tls", see reconnectJitterTls.
    
    See Also:
    
    Constant Field Values
  - PROP_PEDANTIC
```
public static final java.lang.String PROP_PEDANTIC
```
    Property used to configure a builder from a Properties object. "io.nats.client.pedantic", see pedantic.
    
    See Also:
    
    Constant Field Values
  - PROP_VERBOSE
```
public static final java.lang.String PROP_VERBOSE
```
    Property used to configure a builder from a Properties object. "io.nats.client.verbose", see verbose.
    
    See Also:
    
    Constant Field Values
  - PROP_NO_ECHO
```
public static final java.lang.String PROP_NO_ECHO
```
    Property used to configure a builder from a Properties object. "io.nats.client.noecho", see noEcho.
    
    See Also:
    
    Constant Field Values
  - PROP_NO_HEADERS
```
public static final java.lang.String PROP_NO_HEADERS
```
    Property used to configure a builder from a Properties object. "io.nats.client.noheaders", see noHeaders.
    
    See Also:
    
    Constant Field Values
  - PROP_CONNECTION_NAME
```
public static final java.lang.String PROP_CONNECTION_NAME
```
    Property used to configure a builder from a Properties object. "io.nats.client.name", see connectionName.
    
    See Also:
    
    Constant Field Values
  - PROP_NO_NORESPONDERS
```
public static final java.lang.String PROP_NO_NORESPONDERS
```
    Property used to configure a builder from a Properties object. "io.nats.client.nonoresponders", see noNoResponders.
    
    See Also:
    
    Constant Field Values
  - PROP_NORANDOMIZE
```
public static final java.lang.String PROP_NORANDOMIZE
```
    Property used to configure a builder from a Properties object. "io.nats.client.norandomize", see noRandomize.
    
    See Also:
    
    Constant Field Values
  - PROP_NO_RESOLVE_HOSTNAMES
```
public static final java.lang.String PROP_NO_RESOLVE_HOSTNAMES
```
    Property used to configure a builder from a Properties object. "io.nats.client.noResolveHostnames", see noResolveHostnames.
    
    See Also:
    
    Constant Field Values
  - PROP_REPORT_NO_RESPONDERS
```
public static final java.lang.String PROP_REPORT_NO_RESPONDERS
```
    Property used to configure a builder from a Properties object. "io.nats.client.reportNoResponders", see reportNoResponders.
    
    See Also:
    
    Constant Field Values
  - PROP_CLIENT_SIDE_LIMIT_CHECKS
```
public static final java.lang.String PROP_CLIENT_SIDE_LIMIT_CHECKS
```
    Property used to configure a builder from a Properties object. "io.nats.client.clientsidelimitchecks", see clientSideLimitChecks.
    
    See Also:
    
    Constant Field Values
  - PROP_SERVERS
```
public static final java.lang.String PROP_SERVERS
```
    Property used to configure a builder from a Properties object. "io.nats.client.servers", see servers. The value can be a comma-separated list of server URLs.
    
    See Also:
    
    Constant Field Values
  - PROP_PASSWORD
```
public static final java.lang.String PROP_PASSWORD
```
    Property used to configure a builder from a Properties object. "io.nats.client.password", see userInfo.
    
    See Also:
    
    Constant Field Values
  - PROP_USERNAME
```
public static final java.lang.String PROP_USERNAME
```
    Property used to configure a builder from a Properties object. "io.nats.client.username", see userInfo.
    
    See Also:
    
    Constant Field Values
  - PROP_TOKEN
```
public static final java.lang.String PROP_TOKEN
```
    Property used to configure a builder from a Properties object. "io.nats.client.token", see token.
    
    See Also:
    
    Constant Field Values
  - PROP_TOKEN_SUPPLIER
```
public static final java.lang.String PROP_TOKEN_SUPPLIER
```
    Property used to configure the token supplier from a Properties object. "io.nats.client.token.supplier", see tokenSupplier.
    
    See Also:
    
    Constant Field Values
  - PROP_URL
```
public static final java.lang.String PROP_URL
```
    Property used to configure a builder from a Properties object. "io.nats.client.url", see server.
    
    See Also:
    
    Constant Field Values
  - PROP_SECURE
```
public static final java.lang.String PROP_SECURE
```
    Property used to configure a builder from a Properties object. "io.nats.client.secure", see sslContext. This property is a boolean flag, but it tells the options parser to use the default SSL context. Set the default context before creating the options.
    
    See Also:
    
    Constant Field Values
  - PROP_OPENTLS
```
public static final java.lang.String PROP_OPENTLS
```
    Property used to configure a builder from a Properties object. "io.nats.client.opentls", see sslContext. This property is a boolean flag, but it tells the options parser to use an SSL context that takes any server TLS certificate and does not provide its own. The server must have tls_verify turned OFF for this option to work.
    
    See Also:
    
    Constant Field Values
  - PROP_MAX_MESSAGES_IN_OUTGOING_QUEUE
```
public static final java.lang.String PROP_MAX_MESSAGES_IN_OUTGOING_QUEUE
```
    Property used to configure a builder from a Properties object. "io.nats.client.outgoingqueue.maxmessages", see maxMessagesInOutgoingQueue.
    
    See Also:
    
    Constant Field Values
  - PROP_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL
```
public static final java.lang.String PROP_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL
```
    Property used to configure a builder from a Properties object. "io.nats.client.outgoingqueue.discardwhenfull", see discardMessagesWhenOutgoingQueueFull.
    
    See Also:
    
    Constant Field Values
  - PROP_USE_OLD_REQUEST_STYLE
```
public static final java.lang.String PROP_USE_OLD_REQUEST_STYLE
```
    Property used to configure a builder from a Properties object. "use.old.request.style", see oldRequestStyle.
    
    See Also:
    
    Constant Field Values
  - PROP_MAX_CONTROL_LINE
```
public static final java.lang.String PROP_MAX_CONTROL_LINE
```
    Property used to configure a builder from a Properties object. "max.control.line", see maxControlLine.
    
    See Also:
    
    Constant Field Values
  - PROP_INBOX_PREFIX
```
public static final java.lang.String PROP_INBOX_PREFIX
```
    Property used to set the inbox prefix
    
    See Also:
    
    Constant Field Values
  - PROP_IGNORE_DISCOVERED_SERVERS
```
public static final java.lang.String PROP_IGNORE_DISCOVERED_SERVERS
```
    Property used to set whether to ignore discovered servers when connecting
    
    See Also:
    
    Constant Field Values
  - PROP_IGNORE_DISCOVERED_SERVERS_PREFERRED
```
public static final java.lang.String PROP_IGNORE_DISCOVERED_SERVERS_PREFERRED
```
    Preferred property used to set whether to ignore discovered servers when connecting
    
    See Also:
    
    Constant Field Values
  - PROP_SERVERS_POOL_IMPLEMENTATION_CLASS
```
public static final java.lang.String PROP_SERVERS_POOL_IMPLEMENTATION_CLASS
```
    Property used to set class name for ServerPool implementation serverPool.
    
    See Also:
    
    Constant Field Values
  - PROP_SERVERS_POOL_IMPLEMENTATION_CLASS_PREFERRED
```
public static final java.lang.String PROP_SERVERS_POOL_IMPLEMENTATION_CLASS_PREFERRED
```
    Preferred property used to set class name for ServerPool implementation serverPool.
    
    See Also:
    
    Constant Field Values
  - PROP_DISPATCHER_FACTORY_CLASS
```
public static final java.lang.String PROP_DISPATCHER_FACTORY_CLASS
```
    Property used to set class name for the Dispatcher Factory dispatcherFactory.
    
    See Also:
    
    Constant Field Values
  - PROP_SSL_CONTEXT_FACTORY_CLASS
```
public static final java.lang.String PROP_SSL_CONTEXT_FACTORY_CLASS
```
    Property used to set class name for the SSLContextFactory sslContextFactory.
    
    See Also:
    
    Constant Field Values
  - PROP_KEYSTORE
```
public static final java.lang.String PROP_KEYSTORE
```
    Property for the keystore path used to create an SSLContext
    
    See Also:
    
    Constant Field Values
  - PROP_KEYSTORE_PASSWORD
```
public static final java.lang.String PROP_KEYSTORE_PASSWORD
```
    Property for the keystore password used to create an SSLContext
    
    See Also:
    
    Constant Field Values
  - PROP_TRUSTSTORE
```
public static final java.lang.String PROP_TRUSTSTORE
```
    Property for the truststore path used to create an SSLContext
    
    See Also:
    
    Constant Field Values
  - PROP_TRUSTSTORE_PASSWORD
```
public static final java.lang.String PROP_TRUSTSTORE_PASSWORD
```
    Property for the truststore password used to create an SSLContext
    
    See Also:
    
    Constant Field Values
  - PROP_TLS_ALGORITHM
```
public static final java.lang.String PROP_TLS_ALGORITHM
```
    Property for the algorithm used to create an SSLContext
    
    See Also:
    
    Constant Field Values
  - PROP_CREDENTIAL_PATH
```
public static final java.lang.String PROP_CREDENTIAL_PATH
```
    Property used to set the path to a credentials file to be used in a FileAuthHandler
    
    See Also:
    
    Constant Field Values
  - PROP_TLS_FIRST
```
public static final java.lang.String PROP_TLS_FIRST
```
    Property used to configure tls first behavior This property is a boolean flag, telling connections whether to do TLS upgrade first, before INFO
    
    See Also:
    
    Constant Field Values
  - PROP_UTF8_SUBJECTS
```
public static final java.lang.String PROP_UTF8_SUBJECTS
```
    This property is used to enable support for UTF8 subjects. See supportUTF8Subjects()
    
    See Also:
    
    Constant Field Values
  - PROP_USE_TIMEOUT_EXCEPTION
```
public static final java.lang.String PROP_USE_TIMEOUT_EXCEPTION
```
    Property used to throw TimeoutException on timeout instead of CancellationException. Options.Builder.useTimeoutException().
    
    See Also:
    
    Constant Field Values
  - PROP_USE_DISPATCHER_WITH_EXECUTOR
```
public static final java.lang.String PROP_USE_DISPATCHER_WITH_EXECUTOR
```
    Property used to a dispatcher that dispatches messages via the executor service instead of with a blocking call. Options.Builder.useDispatcherWithExecutor().
    
    See Also:
    
    Constant Field Values
  - PROP_FORCE_FLUSH_ON_REQUEST
```
public static final java.lang.String PROP_FORCE_FLUSH_ON_REQUEST
```
    Property used to configure a builder from a Properties object. "io.nats.client.force.flush.on.request", see forceFlushOnRequest.
    
    See Also:
    
    Constant Field Values
  - PROP_EXECUTOR_SERVICE_CLASS
```
public static final java.lang.String PROP_EXECUTOR_SERVICE_CLASS
```
    Property used to set class name for the Executor Service (executor) class executor.
    
    See Also:
    
    Constant Field Values
  - PROP_SCHEDULED_EXECUTOR_SERVICE_CLASS
```
public static final java.lang.String PROP_SCHEDULED_EXECUTOR_SERVICE_CLASS
```
    Property used to set class name for the Executor Service (executor) class executor.
    
    See Also:
    
    Constant Field Values
  - PROP_CONNECT_THREAD_FACTORY_CLASS
```
public static final java.lang.String PROP_CONNECT_THREAD_FACTORY_CLASS
```
    Property used to set class name for the Connect Thread Factory connectThreadFactory.
    
    See Also:
    
    Constant Field Values
  - PROP_CALLBACK_THREAD_FACTORY_CLASS
```
public static final java.lang.String PROP_CALLBACK_THREAD_FACTORY_CLASS
```
    Property used to set class name for the Callback Thread Factory callbackThreadFactory.
    
    See Also:
    
    Constant Field Values
  - PROP_READ_LISTENER_CLASS
```
public static final java.lang.String PROP_READ_LISTENER_CLASS
```
    Property used to set class name for the ReaderListener implementation readListener.
    
    See Also:
    
    Constant Field Values
  - PROP_FAST_FALLBACK
```
public static final java.lang.String PROP_FAST_FALLBACK
```
    Property used to enable fast fallback algorithm for socket connection. enableFastFallback.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setOldRequestStyle
```
@Deprecated
public void setOldRequestStyle(boolean value)
```
    Deprecated. Use Builder
    
    Set old request style.
    
    Parameters:
    
    value - true to use the old request style
  - builder
```
public static Options.Builder builder()
```
    Creates a builder for the options in a fluent style
    
    Returns:
    
    the builder.
  - getExecutor
```
public java.util.concurrent.ExecutorService getExecutor()
```
    Get the general executor
    
    Returns:
    
    the executor, see executor() in the builder doc
  - getScheduledExecutor
```
public java.util.concurrent.ScheduledExecutorService getScheduledExecutor()
```
    Get the ScheduledExecutorService instance
    
    Returns:
    
    the ScheduledExecutorService, see scheduledExecutor() in the builder doc
  - executorIsInternal
```
public boolean executorIsInternal()
```
    whether the general executor is the internal one versus a user supplied one
    
    Returns:
    
    true if the executor is internal
  - scheduledExecutorIsInternal
```
public boolean scheduledExecutorIsInternal()
```
    whether the scheduled executor is the internal one versus a user supplied one
    
    Returns:
    
    true if the executor is internal
  - getCallbackExecutor
```
public java.util.concurrent.ExecutorService getCallbackExecutor()
```
    the callback executor, see callbackThreadFactory() in the builder doc
    
    Returns:
    
    the executor
  - getConnectExecutor
```
public java.util.concurrent.ExecutorService getConnectExecutor()
```
    the connect executor, see connectThreadFactory() in the builder doc
    
    Returns:
    
    the executor
  - getHttpRequestInterceptors
```
public java.util.List<java.util.function.Consumer<io.nats.client.support.HttpRequest>> getHttpRequestInterceptors()
```
    the list of HttpRequest interceptors.
    
    Returns:
    
    the list
  - getProxy
```
public java.net.Proxy getProxy()
```
    the proxy to used for all sockets.
    
    Returns:
    
    the proxy
  - getErrorListener
```
public ErrorListener getErrorListener()
```
    the error listener. Will be an instance of ErrorListenerLoggerImpl if not user supplied. See errorListener() in the builder doc
    
    Returns:
    
    the listener
  - getTimeTraceLogger
```
public TimeTraceLogger getTimeTraceLogger()
```
    If the user provided a TimeTraceLogger, it's returned here. If the user set traceConnection but did not supply their own, the original time trace logging will occur If the user did not provide a TimeTraceLogger and did not set traceConnection, this will be a no-op implementation.
    
    Returns:
    
    the time trace logger
  - getConnectionListener
```
public ConnectionListener getConnectionListener()
```
    the connection listener, or null, see connectionListener() in the builder doc
    
    Returns:
    
    the listener
  - getReadListener
```
public ReadListener getReadListener()
```
    the read listener, or null, see readListener() in the builder doc
    
    Returns:
    
    the listener
  - getStatisticsCollector
```
public StatisticsCollector getStatisticsCollector()
```
    the statistics collector, or null, see statisticsCollector() in the builder doc
    
    Returns:
    
    the collector
  - getAuthHandler
```
public AuthHandler getAuthHandler()
```
    the auth handler, or null, see authHandler() in the builder doc
    
    Returns:
    
    the handler
  - getReconnectDelayHandler
```
public ReconnectDelayHandler getReconnectDelayHandler()
```
    the reconnection delay handler, or null, see reconnectDelayHandler() in the builder doc
    
    Returns:
    
    the handler
  - getDataPortType
```
public java.lang.String getDataPortType()
```
    the DataPort class type for connections created by this options object, see dataPortType() in the builder doc
    
    Returns:
    
    the DataPort class type
  - buildDataPort
```
public io.nats.client.impl.DataPort buildDataPort()
```
    the data port described by these options
    
    Returns:
    
    the data port
  - getServers
```
public java.util.List<java.net.URI> getServers()
```
    the servers as configured in options as URI's, see servers() in the builder doc
    
    Returns:
    
    the processed servers
  - getNatsServerUris
```
public java.util.List<io.nats.client.support.NatsUri> getNatsServerUris()
```
    the servers as configured in options as NatsUri's, see servers() in the builder doc
    
    Returns:
    
    the processed servers
  - getUnprocessedServers
```
public java.util.List<java.lang.String> getUnprocessedServers()
```
    the servers as given to the options, since the servers are normalized
    
    Returns:
    
    the raw servers
  - isNoRandomize
```
public boolean isNoRandomize()
```
    should we turn off randomization for server connection attempts, see noRandomize() in the builder doc
    
    Returns:
    
    true if we should turn off randomization
  - isNoResolveHostnames
```
public boolean isNoResolveHostnames()
```
    should we resolve hostnames for server connection attempts, see noResolveHostnames() in the builder doc
    
    Returns:
    
    true if we should resolve hostnames
  - isReportNoResponders
```
public boolean isReportNoResponders()
```
    should complete with exception futures for requests that get no responders instead of cancelling the future, see reportNoResponders() in the builder doc
    
    Returns:
    
    true if we should report no responders instead of cancelling them
  - getConnectionName
```
public java.lang.String getConnectionName()
```
    the connectionName, see connectionName() in the builder doc
    
    Returns:
    
    the connectionName
  - isVerbose
```
public boolean isVerbose()
```
    are we in verbose mode, see verbose() in the builder doc
    
    Returns:
    
    true if we are in verbose mode
  - isNoEcho
```
public boolean isNoEcho()
```
    is echo-ing disabled, see noEcho() in the builder doc
    
    Returns:
    
    true if echo-ing is disabled
  - isNoHeaders
```
public boolean isNoHeaders()
```
    are headers disabled, see noHeaders() in the builder doc
    
    Returns:
    
    true if headers are disabled
  - isNoNoResponders
```
public boolean isNoNoResponders()
```
    is NoResponders ignored disabled, see noNoResponders() in the builder doc
    
    Returns:
    
    true if no no-responders
  - clientSideLimitChecks
```
public boolean clientSideLimitChecks()
```
    clientSideLimitChecks
    
    Returns:
    
    true if the client will perform limit checks
  - supportUTF8Subjects
```
public boolean supportUTF8Subjects()
```
    whether utf8 subjects are supported, see supportUTF8Subjects() in the builder doc.
    
    Returns:
    
    true if utf8 subjects are supported
  - isPedantic
```
public boolean isPedantic()
```
    are we using pedantic protocol, see pedantic() in the builder doc
    
    Returns:
    
    true if using pedantic protocol
  - isTrackAdvancedStats
```
public boolean isTrackAdvancedStats()
```
    should we track advanced stats, see turnOnAdvancedStats() in the builder doc
    
    Returns:
    
    true is advance stat tracking is on
  - isTraceConnection
```
public boolean isTraceConnection()
```
    If isTraceConnection is true, the user provided a TimeTraceLogger or manually called traceConnection in the builder
    
    Returns:
    
    should we trace the connection?
  - getMaxControlLine
```
public int getMaxControlLine()
```
    the maximum length of a control line, see maxControlLine() in the builder doc
    
    Returns:
    
    the maximum length
  - isTLSRequired
```
public boolean isTLSRequired()
```
    is there an sslContext for these Options, otherwise false, see secure() in the builder doc
    
    Returns:
    
    true if there is an sslContext
  - getSslContext
```
public javax.net.ssl.SSLContext getSslContext()
```
    the sslContext, see secure() in the builder doc
    
    Returns:
    
    the sslContext
  - getMaxReconnect
```
public int getMaxReconnect()
```
    the maxReconnect attempts to make before failing, see maxReconnects() in the builder doc
    
    Returns:
    
    the maxReconnect attempts
  - getReconnectWait
```
public java.time.Duration getReconnectWait()
```
    the reconnectWait, used between reconnect attempts, see reconnectWait() in the builder doc
    
    Returns:
    
    the reconnectWait
  - getReconnectJitter
```
public java.time.Duration getReconnectJitter()
```
    the reconnectJitter, used between reconnect attempts to vary the reconnect wait, see reconnectJitter() in the builder doc
    
    Returns:
    
    the reconnectJitter
  - getReconnectJitterTls
```
public java.time.Duration getReconnectJitterTls()
```
    the reconnectJitterTls, used between reconnect attempts to vary the reconnect wait whe using tls/secure, see reconnectJitterTls() in the builder doc
    
    Returns:
    
    the reconnectJitterTls
  - getConnectionTimeout
```
public java.time.Duration getConnectionTimeout()
```
    the connectionTimeout, see connectionTimeout() in the builder doc
    
    Returns:
    
    the connectionTimeout
  - getSocketReadTimeoutMillis
```
public int getSocketReadTimeoutMillis()
```
    the socketReadTimeoutMillis, see socketReadTimeoutMillis in the builder doc
    
    Returns:
    
    the socketReadTimeoutMillis
  - getSocketWriteTimeout
```
public java.time.Duration getSocketWriteTimeout()
```
    the socketWriteTimeout, see socketWriteTimeout in the builder doc
    
    Returns:
    
    the socketWriteTimeout
  - getSocketSoLinger
```
public int getSocketSoLinger()
```
    the socket so linger number of seconds, see socketSoLinger() in the builder doc
    
    Returns:
    
    the socket so linger number of seconds
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    the number of bytes to set the for the SO_RCVBUF property on the socket
    
    Returns:
    
    the number of bytes
  - getSendBufferSize
```
public int getSendBufferSize()
```
    the number of bytes to set the for the SO_SNDBUF property on the socket
    
    Returns:
    
    the number of bytes
  - getPingInterval
```
public java.time.Duration getPingInterval()
```
    the pingInterval, see pingInterval() in the builder doc
    
    Returns:
    
    interval
  - getRequestCleanupInterval
```
public java.time.Duration getRequestCleanupInterval()
```
    the request cleanup interval, see requestCleanupInterval() in the builder doc
    
    Returns:
    
    the interval
  - getMaxPingsOut
```
public int getMaxPingsOut()
```
    the maxPingsOut to limit the number of pings on the wire, see maxPingsOut() in the builder doc
    
    Returns:
    
    the max pings out
  - getReconnectBufferSize
```
public long getReconnectBufferSize()
```
    the reconnectBufferSize, to limit the amount of data held during reconnection attempts, see reconnectBufferSize() in the builder doc
    
    Returns:
    
    the reconnectBufferSize
  - getBufferSize
```
public int getBufferSize()
```
    the default size for buffers in the connection code, see bufferSize() in the builder doc
    
    Returns:
    
    the default size in bytes
  - getUsername
```
@Deprecated
public java.lang.String getUsername()
```
    Deprecated. converts the char array to a string, use getUserNameChars instead for more security
    
    Returns:
    
    the username to use for basic authentication, see userInfo() in the builder doc
  - getUsernameChars
```
public char[] getUsernameChars()
```
    the username to use for basic authentication, see userInfo() in the builder doc
    
    Returns:
    
    the username
  - getPassword
```
@Deprecated
public java.lang.String getPassword()
```
    Deprecated. converts the char array to a string, use getPasswordChars instead for more security
    
    Returns:
    
    the password to use for basic authentication, see userInfo() in the builder doc
  - getPasswordChars
```
public char[] getPasswordChars()
```
    the password to use for basic authentication, see userInfo() in the builder doc
    
    Returns:
    
    the password
  - getToken
```
@Deprecated
public java.lang.String getToken()
```
    Deprecated. converts the char array to a string, use getTokenChars instead for more security
    
    Returns:
    
    the token to be used for token-based authentication, see token() in the builder doc
  - getTokenChars
```
public char[] getTokenChars()
```
    the token to be used for token-based authentication, see token() in the builder doc generated from the token supplier if the user supplied one.
    
    Returns:
    
    the token
  - isOldRequestStyle
```
public boolean isOldRequestStyle()
```
    the flag to turn on old style requests, see oldStyleRequest() in the builder doc
    
    Returns:
    
    the flag
  - getInboxPrefix
```
public java.lang.String getInboxPrefix()
```
    the inbox prefix to use for requests, see inboxPrefix() in the builder doc
    
    Returns:
    
    the inbox prefix
  - getMaxMessagesInOutgoingQueue
```
public int getMaxMessagesInOutgoingQueue()
```
    the maximum number of messages in the outgoing queue, see maxMessagesInOutgoingQueue(int) in the builder doc
    
    Returns:
    
    the maximum number of messages
  - isDiscardMessagesWhenOutgoingQueueFull
```
public boolean isDiscardMessagesWhenOutgoingQueueFull()
```
    should we discard messages when the outgoing queue is full, see discardMessagesWhenOutgoingQueueFull() in the builder doc
    
    Returns:
    
    true if we should discard messages when the outgoing queue is full
  - isIgnoreDiscoveredServers
```
public boolean isIgnoreDiscoveredServers()
```
    Get whether to ignore discovered servers
    
    Returns:
    
    the flag
  - isTlsFirst
```
public boolean isTlsFirst()
```
    Get whether to do tls first
    
    Returns:
    
    the flag
  - useTimeoutException
```
public boolean useTimeoutException()
```
    Get whether to throw TimeoutException on timeout instead of CancellationException.
    
    Returns:
    
    the flag
  - useDispatcherWithExecutor
```
public boolean useDispatcherWithExecutor()
```
    Whether the dispatcher should use an executor to async messages to handlers
    
    Returns:
    
    the flag
  - forceFlushOnRequest
```
public boolean forceFlushOnRequest()
```
    Whether to flush on any user request
    
    Returns:
    
    the flag
  - getServerPool
```
public ServerPool getServerPool()
```
    Get the ServerPool implementation. If null, a default implementation is used.
    
    Returns:
    
    the ServerPool implementation
  - getDispatcherFactory
```
public io.nats.client.impl.DispatcherFactory getDispatcherFactory()
```
    Get the DispatcherFactory implementation. If null, a default implementation is used.
    
    Returns:
    
    the DispatcherFactory implementation
  - isEnableFastFallback
```
public boolean isEnableFastFallback()
```
    Whether Fast fallback algorithm is enabled for socket connect
    
    Returns:
    
    the flag
  - createURIForServer
```
public java.net.URI createURIForServer(java.lang.String serverURI)
                                throws java.net.URISyntaxException
```
    create a URI from a server uri.
    
    Parameters:
    
    serverURI - the text uri
    
    Returns:
    
    the URI object
    
    Throws:
    
    java.net.URISyntaxException - if the text version is malformed or illegal
  - buildProtocolConnectOptionsString
```
public java.nio.CharBuffer buildProtocolConnectOptionsString(java.lang.String serverURI,
                                                             boolean includeAuth,
                                                             byte[] nonce)
```
    Create the options string sent with the connect message. If includeAuth is true the auth information is included: If the server URIs have auth info it is used. Otherwise, the userInfo is used.
    
    Parameters:
    
    serverURI - the current server uri
    
    includeAuth - tells the options to build a connection string that includes auth information
    
    nonce - if the client is supposed to sign the nonce for authentication
    
    Returns:
    
    the options String, basically JSON

Class Options

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_URL

DEFAULT_PORT

DEFAULT_MAX_RECONNECT

DEFAULT_RECONNECT_WAIT

DEFAULT_RECONNECT_JITTER

DEFAULT_RECONNECT_JITTER_TLS

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_SOCKET_WRITE_TIMEOUT

MINIMUM_SOCKET_WRITE_TIMEOUT_GT_CONNECTION_TIMEOUT

MINIMUM_SOCKET_WRITE_TIMEOUT_NANOS

MINIMUM_SOCKET_READ_TIMEOUT_GT_CONNECTION_TIMEOUT

DEFAULT_PING_INTERVAL

DEFAULT_REQUEST_CLEANUP_INTERVAL

DEFAULT_MAX_PINGS_OUT

DEFAULT_SSL_PROTOCOL

DEFAULT_RECONNECT_BUF_SIZE

DEFAULT_MAX_CONTROL_LINE

DEFAULT_DATA_PORT_TYPE

DEFAULT_BUFFER_SIZE

DEFAULT_THREAD_NAME_PREFIX

DEFAULT_INBOX_PREFIX

MAX_MESSAGES_IN_NETWORK_BUFFER

DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE

DEFAULT_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL

DEFAULT_SINGLE_THREAD_EXECUTOR

PROP_CONNECTION_CB

PROP_DATA_PORT_TYPE

PROP_ERROR_LISTENER

PROP_TIME_TRACE_LOGGER

PROP_STATISTICS_COLLECTOR

PROP_MAX_PINGS

PROP_PING_INTERVAL

PROP_CLEANUP_INTERVAL

PROP_CONNECTION_TIMEOUT

PROP_SOCKET_READ_TIMEOUT_MS

PROP_SOCKET_WRITE_TIMEOUT

PROP_SOCKET_SO_LINGER

PROP_SOCKET_RECEIVE_BUFFER_SIZE

PROP_SOCKET_SEND_BUFFER_SIZE

PROP_RECONNECT_BUF_SIZE

PROP_RECONNECT_WAIT

PROP_MAX_RECONNECT

PROP_RECONNECT_JITTER

PROP_RECONNECT_JITTER_TLS

PROP_PEDANTIC

PROP_VERBOSE

PROP_NO_ECHO

PROP_NO_HEADERS

PROP_CONNECTION_NAME

PROP_NO_NORESPONDERS

PROP_NORANDOMIZE

PROP_NO_RESOLVE_HOSTNAMES

PROP_REPORT_NO_RESPONDERS

PROP_CLIENT_SIDE_LIMIT_CHECKS

PROP_SERVERS

PROP_PASSWORD

PROP_USERNAME

PROP_TOKEN

PROP_TOKEN_SUPPLIER

PROP_URL

PROP_SECURE

PROP_OPENTLS

PROP_MAX_MESSAGES_IN_OUTGOING_QUEUE

PROP_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL

PROP_USE_OLD_REQUEST_STYLE

PROP_MAX_CONTROL_LINE

PROP_INBOX_PREFIX

PROP_IGNORE_DISCOVERED_SERVERS

PROP_IGNORE_DISCOVERED_SERVERS_PREFERRED

PROP_SERVERS_POOL_IMPLEMENTATION_CLASS

PROP_SERVERS_POOL_IMPLEMENTATION_CLASS_PREFERRED

PROP_DISPATCHER_FACTORY_CLASS

PROP_SSL_CONTEXT_FACTORY_CLASS

PROP_KEYSTORE