io.nats.client

Class Options.Builder

java.lang.Object

io.nats.client.Options.Builder

Enclosing class:

Options

public static class Options.Builder
extends java.lang.Object

Options are created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls. The builder can also be created from a properties object using the property names defined with the prefix PROP_ in this class.

A common usage for testing might be new Options.Builder().server(myserverurl).noReconnect.build()

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a new Builder with the default values.
Builder(Options o)
Builder(java.util.Properties props) Constructs a new Builder from a Properties object.
Builder(java.lang.String propertiesFilePath) Constructs a new Builder from a file that contains properties.

Method Summary

Modifier and Type	Method and Description
Options.Builder	authHandler(AuthHandler handler) Set the AuthHandler to sign the server nonce for authentication in nonce-mode.
Options.Builder	bufferSize(int size) Sets the initial size for buffers in the connection, primarily for testing.
Options	build() Build an Options object from this Builder.
Options.Builder	clientSideLimitChecks(boolean checks) Set client side limit checks.
Options.Builder	connectionListener(ConnectionListener listener) Set the ConnectionListener to receive asynchronous notifications of disconnect events.
Options.Builder	connectionName(java.lang.String name) Set the connection's optional Name.
Options.Builder	connectionTimeout(java.time.Duration connectionTimeout) Set the timeout for connection attempts.
Options.Builder	connectionTimeout(long connectionTimeoutMillis) Set the timeout for connection attempts.
Options.Builder	credentialPath(java.lang.String credentialPath)
Options.Builder	dataPortType(java.lang.String dataPortClassName) The class to use for this connections data port.
Options.Builder	discardMessagesWhenOutgoingQueueFull() Enable discard messages when the outgoing queue full.
Options.Builder	dispatcherFactory(io.nats.client.impl.DispatcherFactory dispatcherFactory) Set the DispatcherFactory implementation for connections to use instead of the default implementation
Options.Builder	errorListener(ErrorListener listener) Set the ErrorListener to receive asynchronous error events related to this connection.
Options.Builder	executor(java.util.concurrent.ExecutorService executor) Set the ExecutorService used to run threaded tasks.
Options.Builder	httpRequestInterceptor(java.util.function.Consumer<HttpRequest> interceptor) Add an HttpRequest interceptor which can be used to modify the HTTP request when using websockets
Options.Builder	httpRequestInterceptors(java.util.Collection<? extends java.util.function.Consumer<HttpRequest>> interceptors) Overwrite the list of HttpRequest interceptors which can be used to modify the HTTP request when using websockets
Options.Builder	ignoreDiscoveredServers() Turn off use of discovered servers when connecting / reconnecting.
Options.Builder	inboxPrefix(java.lang.String prefix) Set the connection's inbox prefix.
Options.Builder	keystorePassword(char[] keystorePassword)
Options.Builder	keystorePath(java.lang.String keystore)
Options.Builder	maxControlLine(int bytes) Set the maximum length of a control line sent by this connection.
Options.Builder	maxMessagesInOutgoingQueue(int maxMessagesInOutgoingQueue) Set the maximum number of messages in the outgoing queue.
Options.Builder	maxPingsOut(int max) Set the maximum number of pings the client can have in flight.
Options.Builder	maxReconnects(int max) Set the maximum number of reconnect attempts.
Options.Builder	noEcho() Turn off echo.
Options.Builder	noHeaders() Turn off header support.
Options.Builder	noNoResponders() Turn off noresponder support.
Options.Builder	noRandomize() For the default server list provider, turn off server pool randomization.
Options.Builder	noReconnect() Equivalent to calling maxReconnects with 0, maxReconnects.
Options.Builder	noResolveHostnames() For the default server list provider, whether to resolve hostnames when building server list.
Options.Builder	oldRequestStyle() Turn on the old request style that uses a new inbox and subscriber for each request.
Options.Builder	opentls() Set the options to use an SSL context that accepts any server certificate and has no client certificates.
Options.Builder	pedantic() Turn on pedantic mode for the server, in relation to this connection.
Options.Builder	pingInterval(java.time.Duration time) Set the interval between attempts to pings the server.
Options.Builder	properties(java.util.Properties props) Add settings defined in the properties object
Options.Builder	proxy(java.net.Proxy proxy) Define a proxy to use when connecting.
Options.Builder	reconnectBufferSize(long size) Set the maximum number of bytes to buffer in the client when trying to reconnect.
Options.Builder	reconnectDelayHandler(ReconnectDelayHandler handler) Set the ReconnectDelayHandler for custom reconnect duration
Options.Builder	reconnectJitter(java.time.Duration time) Set the jitter time to wait between reconnect attempts to the same server.
Options.Builder	reconnectJitterTls(java.time.Duration time) Set the jitter time for a tls/secure connection to wait between reconnect attempts to the same server.
Options.Builder	reconnectWait(java.time.Duration time) Set the time to wait between reconnect attempts to the same server.
Options.Builder	reportNoResponders()
Options.Builder	requestCleanupInterval(java.time.Duration time) Set the interval between cleaning passes on outstanding request futures that are cancelled or timeout in the application code.
Options.Builder	secure() Sets the options to use the default SSL Context, if it exists.
Options.Builder	server(java.lang.String serverURL) Add a server to the list of known servers.
Options.Builder	serverPool(ServerPool serverPool) Set the ServerPool implementation for connections to use instead of the default implementation
Options.Builder	servers(java.lang.String[] servers) Add an array of servers to the list of known servers.
Options.Builder	socketReadTimeoutMillis(int socketReadTimeoutMillis) Set the timeout to use around socket reads
Options.Builder	socketSoLinger(int socketSoLinger) Set the value of the socket SO LINGER property in seconds.
Options.Builder	socketWriteTimeout(java.time.Duration socketWriteTimeout) Set the timeout to use around socket writes
Options.Builder	socketWriteTimeout(long socketWriteTimeoutMillis) Set the timeout to use around socket writes
Options.Builder	sslContext(javax.net.ssl.SSLContext ctx) Set the SSL context, requires that the server supports TLS connections and the URI specifies TLS.
Options.Builder	sslContextFactory(io.nats.client.impl.SSLContextFactory sslContextFactory) Set the factory that provides the ssl context.
Options.Builder	statisticsCollector(StatisticsCollector collector) Set the StatisticsCollector to collect connection metrics.
Options.Builder	supportUTF8Subjects() The client protocol is not clear about the encoding for subject names.
Options.Builder	timeTraceLogger(TimeTraceLogger logger) Set the TimeTraceLogger to receive trace events related to this connection.
Options.Builder	tlsAlgorithm(java.lang.String tlsAlgorithm)
Options.Builder	tlsFirst() Set TLS Handshake First behavior on.
Options.Builder	token(char[] token) Set the token for token-based authentication.
Options.Builder	token(java.lang.String token) Deprecated. use the char[] version instead for better security
Options.Builder	traceConnection() Enable connection trace messages.
Options.Builder	truststorePassword(char[] truststorePassword)
Options.Builder	truststorePath(java.lang.String truststore)
Options.Builder	turnOnAdvancedStats() Turn on advanced stats, primarily for test/benchmarks.
Options.Builder	useDispatcherWithExecutor() Instruct dispatchers to dispatch all messages as a task, instead of directly from dispatcher thread
Options.Builder	userInfo(char[] userName, char[] password) Set the username and password for basic authentication.
Options.Builder	userInfo(java.lang.String userName, java.lang.String password) Set the username and password for basic authentication.
Options.Builder	useTimeoutException() Throw TimeoutException on timeout instead of CancellationException?
Options.Builder	verbose() Turn on verbose mode with the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs a new Builder with the default values.

When build() is called on a default builder it will add the default url to its list of servers if there were no servers defined.

Builder

public Builder(java.util.Properties props)
        throws java.lang.IllegalArgumentException

Constructs a new Builder from a Properties object.

Methods called on the builder after construction can override the properties.

Parameters:

props - the Properties object

Throws:

java.lang.IllegalArgumentException

Builder

public Builder(java.lang.String propertiesFilePath)
        throws java.io.IOException

Constructs a new Builder from a file that contains properties.

Parameters:

propertiesFilePath - a resolvable path to a file from the location the application is running, either relative or absolute

Throws:

java.io.IOException - if the properties file cannot be found, opened or read

Builder

public Builder(Options o)

Method Detail

properties

public Options.Builder properties(java.util.Properties props)

Add settings defined in the properties object

Parameters:

props - the properties object

Returns:

the Builder for chaining

Throws:

java.lang.IllegalArgumentException - if the properties object is null

server

public Options.Builder server(java.lang.String serverURL)

Add a server to the list of known servers.

Parameters:

serverURL - the URL for the server to add

Returns:

the Builder for chaining

Throws:

java.lang.IllegalArgumentException - if the url is not formatted correctly.

servers

public Options.Builder servers(java.lang.String[] servers)

Add an array of servers to the list of known servers.

Parameters:

servers - A list of server URIs

Returns:

the Builder for chaining

Throws:

java.lang.IllegalArgumentException - if any url is not formatted correctly.

oldRequestStyle

public Options.Builder oldRequestStyle()

Turn on the old request style that uses a new inbox and subscriber for each request.

Returns:

the Builder for chaining

noRandomize

public Options.Builder noRandomize()

For the default server list provider, turn off server pool randomization. The default provider will pick servers from its list randomly on a reconnect. When noRandomize is set to true the default provider supplies a list that first contains servers as configured and then contains the servers as sent from the connected server.

Returns:

the Builder for chaining

noResolveHostnames

public Options.Builder noResolveHostnames()

For the default server list provider, whether to resolve hostnames when building server list.

Returns:

the Builder for chaining

reportNoResponders

public Options.Builder reportNoResponders()

noEcho

public Options.Builder noEcho()

Turn off echo. If supported by the nats-server version you are connecting to this flag will prevent the server from echoing messages back to the connection if it has subscriptions on the subject being published to.

Returns:

the Builder for chaining

noHeaders

public Options.Builder noHeaders()

Turn off header support. Some versions of the server don't support it. It's also not required if you don't use headers

Returns:

the Builder for chaining

noNoResponders

public Options.Builder noNoResponders()

Turn off noresponder support. Some versions of the server don't support it.

Returns:

the Builder for chaining

clientSideLimitChecks

public Options.Builder clientSideLimitChecks(boolean checks)

Set client side limit checks. Default is true

Parameters:

checks - the checks flag

Returns:

the Builder for chaining

supportUTF8Subjects

public Options.Builder supportUTF8Subjects()

The client protocol is not clear about the encoding for subject names. For performance reasons, the Java client defaults to ASCII. You can enable UTF8 with this method. The server, written in go, treats byte to string as UTF8 by default and should allow UTF8 subjects, but make sure to test any clients when using them.

Returns:

the Builder for chaining

connectionName

public Options.Builder connectionName(java.lang.String name)

Set the connection's optional Name.

Parameters:

name - the connections new name.

Returns:

the Builder for chaining

inboxPrefix

public Options.Builder inboxPrefix(java.lang.String prefix)

Set the connection's inbox prefix. All inboxes will start with this string.

Parameters:

prefix - prefix to use.

Returns:

the Builder for chaining

verbose

public Options.Builder verbose()

Turn on verbose mode with the server.

Returns:

the Builder for chaining

pedantic

public Options.Builder pedantic()

Turn on pedantic mode for the server, in relation to this connection.

Returns:

the Builder for chaining

turnOnAdvancedStats

public Options.Builder turnOnAdvancedStats()

Turn on advanced stats, primarily for test/benchmarks. These are visible if you call toString on the Statistics object.

Returns:

the Builder for chaining

traceConnection

public Options.Builder traceConnection()

Enable connection trace messages. Messages are printed to standard out. This option is for very fine-grained debugging of connection issues.

Returns:

the Builder for chaining

secure

public Options.Builder secure()
                       throws java.security.NoSuchAlgorithmException

Sets the options to use the default SSL Context, if it exists.

Returns:

the Builder for chaining

Throws:

java.security.NoSuchAlgorithmException - Not thrown, deferred to build() method, left in for backward compatibility

opentls

public Options.Builder opentls()
                        throws java.security.NoSuchAlgorithmException

Set the options to use an SSL context that accepts any server certificate and has no client certificates.

Returns:

the Builder for chaining

Throws:

java.security.NoSuchAlgorithmException - Not thrown, deferred to build() method, left in for backward compatibility

sslContext

public Options.Builder sslContext(javax.net.ssl.SSLContext ctx)

Set the SSL context, requires that the server supports TLS connections and the URI specifies TLS. If provided, the context takes precedence over any other TLS/SSL properties set in the builder, including the sslContextFactory

Parameters:

ctx - the SSL Context to use for TLS connections

Returns:

the Builder for chaining

sslContextFactory

public Options.Builder sslContextFactory(io.nats.client.impl.SSLContextFactory sslContextFactory)

Set the factory that provides the ssl context. The factory is superseded by an instance of SSLContext

Parameters:

sslContextFactory - the SSL Context for use to create a ssl context

Returns:

the Builder for chaining

keystorePath

public Options.Builder keystorePath(java.lang.String keystore)

Parameters:

keystore - the path to the keystore file

Returns:

the Builder for chaining

keystorePassword

public Options.Builder keystorePassword(char[] keystorePassword)

Parameters:

keystorePassword - the password for the keystore

Returns:

the Builder for chaining

truststorePath

public Options.Builder truststorePath(java.lang.String truststore)

Parameters:

truststore - the path to the trust store file

Returns:

the Builder for chaining

truststorePassword

public Options.Builder truststorePassword(char[] truststorePassword)

Parameters:

truststorePassword - the password for the trust store

Returns:

the Builder for chaining

tlsAlgorithm

public Options.Builder tlsAlgorithm(java.lang.String tlsAlgorithm)

Parameters:

tlsAlgorithm - the tls algorithm. Default is

Returns:

the Builder for chaining

credentialPath

public Options.Builder credentialPath(java.lang.String credentialPath)

Parameters:

credentialPath - the path to the credentials file for creating an AuthHandler

Returns:

the Builder for chaining

noReconnect

public Options.Builder noReconnect()

Equivalent to calling maxReconnects with 0, maxReconnects.

Returns:

the Builder for chaining

maxReconnects

public Options.Builder maxReconnects(int max)

Set the maximum number of reconnect attempts. Use 0 to turn off auto-reconnect. Use -1 to turn on infinite reconnects.

The reconnect count is incremented on a per-server basis, so if the server list contains 5 servers but max reconnects is set to 3, only 3 of those servers will be tried.

This library has a slight difference from some NATS clients, if you set the maxReconnects to zero there will not be any reconnect attempts, regardless of the number of known servers.

The reconnect state is entered when the connection is connected and loses that connection. During the initial connection attempt, the client will cycle over its server list one time, regardless of what maxReconnects is set to. The only exception to this is the experimental async connect method connectAsynchronously.

Parameters:

max - the maximum reconnect attempts

Returns:

the Builder for chaining

reconnectWait

public Options.Builder reconnectWait(java.time.Duration time)

Set the time to wait between reconnect attempts to the same server. This setting is only used by the client when the same server appears twice in the reconnect attempts, either because it is the only known server or by random chance. Note, the randomization of the server list doesn't occur per attempt, it is performed once at the start, so if there are 2 servers in the list you will never encounter the reconnect wait.

Parameters:

time - the time to wait

Returns:

the Builder for chaining

reconnectJitter

public Options.Builder reconnectJitter(java.time.Duration time)

Set the jitter time to wait between reconnect attempts to the same server. This setting is used to vary the reconnect wait to avoid multiple clients trying to reconnect to servers at the same time.

Parameters:

time - the time to wait

Returns:

the Builder for chaining

reconnectJitterTls

public Options.Builder reconnectJitterTls(java.time.Duration time)

Set the jitter time for a tls/secure connection to wait between reconnect attempts to the same server. This setting is used to vary the reconnect wait to avoid multiple clients trying to reconnect to servers at the same time.

Parameters:

time - the time to wait

Returns:

the Builder for chaining

maxControlLine

public Options.Builder maxControlLine(int bytes)

Set the maximum length of a control line sent by this connection. This value is also configured in the server but the protocol doesn't currently forward that setting. Configure it here so that the client can ensure that messages are valid before sending to the server.

Parameters:

bytes - the max byte count

Returns:

the Builder for chaining

connectionTimeout

public Options.Builder connectionTimeout(java.time.Duration connectionTimeout)

Set the timeout for connection attempts. Each server in the options is allowed this timeout so if 3 servers are tried with a timeout of 5s the total time could be 15s.

Parameters:

connectionTimeout - the time to wait

Returns:

the Builder for chaining

connectionTimeout

public Options.Builder connectionTimeout(long connectionTimeoutMillis)

Set the timeout for connection attempts. Each server in the options is allowed this timeout so if 3 servers are tried with a timeout of 5s the total time could be 15s.

Parameters:

connectionTimeoutMillis - the time to wait in milliseconds

Returns:

the Builder for chaining

socketReadTimeoutMillis

public Options.Builder socketReadTimeoutMillis(int socketReadTimeoutMillis)

Set the timeout to use around socket reads

Parameters:

socketReadTimeoutMillis - the timeout milliseconds

Returns:

the Builder for chaining

socketWriteTimeout

public Options.Builder socketWriteTimeout(long socketWriteTimeoutMillis)

Set the timeout to use around socket writes

Parameters:

socketWriteTimeoutMillis - the timeout milliseconds

Returns:

the Builder for chaining

socketWriteTimeout

public Options.Builder socketWriteTimeout(java.time.Duration socketWriteTimeout)

Set the timeout to use around socket writes

Parameters:

socketWriteTimeout - the timeout duration

Returns:

the Builder for chaining

socketSoLinger

public Options.Builder socketSoLinger(int socketSoLinger)

Set the value of the socket SO LINGER property in seconds. This feature is used by library data port implementations. Setting this is a last resort if socket closes are a problem in your environment, otherwise it's generally not necessary to set this. The value must be greater than or equal to 0 to have the code call socket.setSoLinger with true and the timeout value

Parameters:

socketSoLinger - the number of seconds to linger

Returns:

the Builder for chaining

pingInterval

public Options.Builder pingInterval(java.time.Duration time)

Set the interval between attempts to pings the server. These pings are automated, and capped by maxPingsOut(). As of 2.4.4 the library may wait up to 2 * time to send a ping. Incoming traffic from the server can postpone the next ping to avoid pings taking up bandwidth during busy messaging. Keep in mind that a ping requires a round trip to the server. Setting this value to a small number can result in quick failures due to maxPingsOut being reached, these failures will force a disconnect/reconnect which can result in messages being held back or failed. In general, the ping interval should be set in seconds but this value is not enforced as it would result in an API change from the 2.0 release.

Parameters:

time - the time between client to server pings

Returns:

the Builder for chaining

requestCleanupInterval

public Options.Builder requestCleanupInterval(java.time.Duration time)

Set the interval between cleaning passes on outstanding request futures that are cancelled or timeout in the application code.

The default value is probably reasonable, but this interval is useful in a very noisy network situation where lots of requests are used.

Parameters:

time - the cleaning interval

Returns:

the Builder for chaining

maxPingsOut

public Options.Builder maxPingsOut(int max)

Set the maximum number of pings the client can have in flight.

Parameters:

max - the max pings

Returns:

the Builder for chaining

bufferSize

public Options.Builder bufferSize(int size)

Sets the initial size for buffers in the connection, primarily for testing.

Parameters:

size - the size in bytes to make buffers for connections created with this options

Returns:

the Builder for chaining

reconnectBufferSize

public Options.Builder reconnectBufferSize(long size)

Set the maximum number of bytes to buffer in the client when trying to reconnect. When this value is exceeded the client will start to drop messages. The count of dropped messages can be read from the Statistics. A value of zero will disable the reconnect buffer, a value less than zero means unlimited. Caution should be used for negative numbers as they can result in an unreliable network connection plus a high message rate leading to an out of memory error.

Parameters:

size - the size in bytes

Returns:

the Builder for chaining

userInfo

public Options.Builder userInfo(java.lang.String userName,
                                java.lang.String password)

Set the username and password for basic authentication. If the user and password are set in the server URL, they will override these values. However, in a clustering situation, these values can be used as a fallback. use the char[] version instead for better security

Parameters:

userName - a non-empty userName

password - the password, in plain text

Returns:

the Builder for chaining

userInfo

public Options.Builder userInfo(char[] userName,
                                char[] password)

Set the username and password for basic authentication. If the user and password are set in the server URL, they will override these values. However, in a clustering situation, these values can be used as a fallback.

Parameters:

userName - a non-empty userName

password - the password, in plain text

Returns:

the Builder for chaining

token

@Deprecated
public Options.Builder token(java.lang.String token)

Deprecated. use the char[] version instead for better security

Set the token for token-based authentication. If a token is provided in a server URI it overrides this value.

Parameters:

token - The token

Returns:

the Builder for chaining

token

public Options.Builder token(char[] token)

Set the token for token-based authentication. If a token is provided in a server URI it overrides this value.

Parameters:

token - The token

Returns:

the Builder for chaining

authHandler

public Options.Builder authHandler(AuthHandler handler)

Set the AuthHandler to sign the server nonce for authentication in nonce-mode.

Parameters:

handler - The new AuthHandler for this connection.

Returns:

the Builder for chaining

reconnectDelayHandler

public Options.Builder reconnectDelayHandler(ReconnectDelayHandler handler)

Set the ReconnectDelayHandler for custom reconnect duration

Parameters:

handler - The new ReconnectDelayHandler for this connection.

Returns:

the Builder for chaining

errorListener

public Options.Builder errorListener(ErrorListener listener)

Set the ErrorListener to receive asynchronous error events related to this connection.

Parameters:

listener - The new ErrorListener for this connection.

Returns:

the Builder for chaining

timeTraceLogger

public Options.Builder timeTraceLogger(TimeTraceLogger logger)

Set the TimeTraceLogger to receive trace events related to this connection.

Parameters:

logger - The new TimeTraceLogger for this connection.

Returns:

the Builder for chaining

connectionListener

public Options.Builder connectionListener(ConnectionListener listener)

Set the ConnectionListener to receive asynchronous notifications of disconnect events.

Parameters:

listener - The new ConnectionListener for this type of event.

Returns:

the Builder for chaining

statisticsCollector

public Options.Builder statisticsCollector(StatisticsCollector collector)

Set the StatisticsCollector to collect connection metrics.

If not set, then a default implementation will be used.

Parameters:

collector - the new StatisticsCollector for this connection.

Returns:

the Builder for chaining

executor

public Options.Builder executor(java.util.concurrent.ExecutorService executor)

Set the ExecutorService used to run threaded tasks. The default is a cached thread pool that names threads after the connection name (or a default). This executor is used for reading and writing the underlying sockets as well as for each Dispatcher. The default executor uses a short keepalive time, 500ms, to insure quick shutdowns. This is reasonable since most threads from the executor are long-lived. If you customize, be sure to keep the shutdown effect in mind, executors can block for their keepalive time. The default executor also marks threads with priority normal and as non-daemon.

Parameters:

executor - The ExecutorService to use for connections built with these options.

Returns:

the Builder for chaining

httpRequestInterceptor

public Options.Builder httpRequestInterceptor(java.util.function.Consumer<HttpRequest> interceptor)

Add an HttpRequest interceptor which can be used to modify the HTTP request when using websockets

Parameters:

interceptor - The interceptor

Returns:

the Builder for chaining

httpRequestInterceptors

public Options.Builder httpRequestInterceptors(java.util.Collection<? extends java.util.function.Consumer<HttpRequest>> interceptors)

Overwrite the list of HttpRequest interceptors which can be used to modify the HTTP request when using websockets

Parameters:

interceptors - The list of interceptors

Returns:

the Builder for chaining

proxy

public Options.Builder proxy(java.net.Proxy proxy)

Define a proxy to use when connecting.

Parameters:

proxy - is the HTTP or socks proxy to use.

Returns:

the Builder for chaining

dataPortType

public Options.Builder dataPortType(java.lang.String dataPortClassName)

The class to use for this connections data port. This is an advanced setting and primarily useful for testing.

Parameters:

dataPortClassName - a valid and accessible class name

Returns:

the Builder for chaining

maxMessagesInOutgoingQueue

public Options.Builder maxMessagesInOutgoingQueue(int maxMessagesInOutgoingQueue)

Set the maximum number of messages in the outgoing queue.

Parameters:

maxMessagesInOutgoingQueue - the maximum number of messages in the outgoing queue

Returns:

the Builder for chaining

discardMessagesWhenOutgoingQueueFull

public Options.Builder discardMessagesWhenOutgoingQueueFull()

Enable discard messages when the outgoing queue full. See maxMessagesInOutgoingQueue

Returns:

the Builder for chaining

ignoreDiscoveredServers

public Options.Builder ignoreDiscoveredServers()

Turn off use of discovered servers when connecting / reconnecting. Used in the default server list provider.

Returns:

the Builder for chaining

tlsFirst

public Options.Builder tlsFirst()

Set TLS Handshake First behavior on. Default is off. TLS Handshake First is used to instruct the library perform the TLS handshake right after the connect and before receiving the INFO protocol from the server. If this option is enabled but the server is not configured to perform the TLS handshake first, the connection will fail.

Returns:

the Builder for chaining

useTimeoutException

public Options.Builder useTimeoutException()

Throw TimeoutException on timeout instead of CancellationException?

Returns:

the Builder for chaining

useDispatcherWithExecutor

public Options.Builder useDispatcherWithExecutor()

Instruct dispatchers to dispatch all messages as a task, instead of directly from dispatcher thread

Returns:

the Builder for chaining

serverPool

public Options.Builder serverPool(ServerPool serverPool)

Set the ServerPool implementation for connections to use instead of the default implementation

Parameters:

serverPool - the implementation

Returns:

the Builder for chaining

dispatcherFactory

public Options.Builder dispatcherFactory(io.nats.client.impl.DispatcherFactory dispatcherFactory)

Set the DispatcherFactory implementation for connections to use instead of the default implementation

Parameters:

dispatcherFactory - the implementation

Returns:

the Builder for chaining

build

public Options build()
              throws java.lang.IllegalStateException

Build an Options object from this Builder.

If the Options builder was not provided with a server, a default one will be included Options.DEFAULT_URL. If only a single server URI is included, the builder will try a few things to make connecting easier:

• If there is no user/password is set but the URI has them, nats://user:password@server:port, they will be used.
• If there is no token is set but the URI has one, nats://token@server:port, it will be used.
• If the URI is of the form tls:// and no SSL context was assigned, one is created, see secure().
• If the URI is of the form opentls:// and no SSL context was assigned one will be created that does not check the servers certificate for validity. This is not secure and only provided for tests and development.

Returns:

the new options object

Throws:

java.lang.IllegalStateException - if there is a conflict in the options, like a token and a user/pass