io.nats.streaming

Class Options.Builder

java.lang.Object

io.nats.streaming.Options.Builder

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Options

public static final class Options.Builder
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(Options template) Constructs a Options.Builder instance based on the supplied Options instance.

Method Summary

Modifier and Type	Method and Description
Options	build() Construct the options object.
Options.Builder	clientId(java.lang.String clientId) Set the client id for connections made with these options.
Options.Builder	clusterId(java.lang.String clusterId) Set the cluster id
Options.Builder	connectionListener(io.nats.client.ConnectionListener listener) Provide an connection listener to use when creating the nats connection.
Options.Builder	connectionLostHandler(ConnectionLostHandler handler) Provide an lost handler to be notified if the streaming server doesn't answer the client's pings.
Options.Builder	connectWait(java.time.Duration connectTimeout) Set the connect timeout
Options.Builder	discoverPrefix(java.lang.String discoverPrefix) Set the discovery prefix
Options.Builder	errorListener(io.nats.client.ErrorListener listener) Provide an error listener to use when creating the nats connection.
java.lang.String	getClientId()
java.lang.String	getClusterID()
Options.Builder	maxPingsOut(int max) Set the max pings that can be out to the server before it is considered lost.
Options.Builder	maxPubAcksInFlight(int maxPubAcksInFlight) Set the max pub acks the server/client will allow.
Options.Builder	natsConn(io.nats.client.Connection natsConn) Manually set the NATS connection
Options.Builder	natsUrl(java.lang.String natsUrl) Set the url to connect to for NATS
Options.Builder	pingInterval(java.time.Duration interval) Set the time between pings to the server, if it is supported.
Options.Builder	pubAckWait(java.time.Duration ackTimeout) Set the ack timeout
Options.Builder	traceConnection() Enable connection trace messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(Options template)

Constructs a Options.Builder instance based on the supplied Options instance.

Parameters:

template - the Options object to use as a template

Method Detail

clusterId

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

Set the cluster id

Parameters:

clusterId - the id for the streaming cluster ot connect to.

Returns:

the builder for chaining

getClusterID

public java.lang.String getClusterID()

Returns:

the cluster id for these options

clientId

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

Set the client id for connections made with these options.

Parameters:

clientId - the id for the streaming cluster ot connect to.

Returns:

the builder for chaining

getClientId

public java.lang.String getClientId()

Returns:

the client id for these options

errorListener

public Options.Builder errorListener(io.nats.client.ErrorListener listener)

Provide an error listener to use when creating the nats connection. If a manual connection is used, this setting is ignored.

Parameters:

listener - the ErrorListener

Returns:

the builder for chaining

connectionListener

public Options.Builder connectionListener(io.nats.client.ConnectionListener listener)

Provide an connection listener to use when creating the nats connection. If a manual connection is used, this setting is ignored.

Parameters:

listener - the ConnectionListener

Returns:

the builder for chaining

connectionLostHandler

public Options.Builder connectionLostHandler(ConnectionLostHandler handler)

Provide an lost handler to be notified if the streaming server doesn't answer the client's pings. The nats server may stay up when the streaming server goes down so this handler should respond accordingly.

Parameters:

handler - the ConnectionLostHandler

Returns:

the builder for chaining

pubAckWait

public Options.Builder pubAckWait(java.time.Duration ackTimeout)

Set the ack timeout

Parameters:

ackTimeout - the timeout

Returns:

the builder for chaining

connectWait

public Options.Builder connectWait(java.time.Duration connectTimeout)

Set the connect timeout

Parameters:

connectTimeout - the timeout

Returns:

the builder for chaining

discoverPrefix

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

Set the discovery prefix

Parameters:

discoverPrefix - the prefix, defaults to DEFAULT_DISCOVER_PREFIX.

Returns:

the builder for chaining

maxPubAcksInFlight

public Options.Builder maxPubAcksInFlight(int maxPubAcksInFlight)

Set the max pub acks the server/client will allow. Default is 16384.

Parameters:

maxPubAcksInFlight - the max acks

Returns:

the builder for chaining

natsConn

public Options.Builder natsConn(io.nats.client.Connection natsConn)

Manually set the NATS connection

Parameters:

natsConn - a valid nats connection (from the latest version of the library)

Returns:

the builder for chaining

natsUrl

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

Set the url to connect to for NATS

Parameters:

natsUrl - a valid nats url, see the client library for more information

Returns:

the builder for chaining

maxPingsOut

public Options.Builder maxPingsOut(int max)

Set the max pings that can be out to the server before it is considered lost.

Parameters:

max - the maxPings out

Returns:

the builder for chaining

pingInterval

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

Set the time between pings to the server, if it is supported. The server may override this.

Parameters:

interval - the time between server pings

Returns:

the builder for chaining

build

public Options build()

Construct the options object.

Returns:

the options object

traceConnection

public Options.Builder traceConnection()

Enable connection trace messages. Messages are printed to standard out. This options is for very fine grained debugging of connection issues. Effects streaming and Nats (if streaming creates the nats connection).

Returns:

the Builder for chaining