io.nats.streaming

Class StreamingConnectionFactory

java.lang.Object

io.nats.streaming.StreamingConnectionFactory

public class StreamingConnectionFactory
extends java.lang.Object

A StreamingConnectionFactory object encapsulates a set of connection configuration options. A client uses it to create a connection to the NATS streaming data system. This class provides some options that are mapped to the underlying NATS connection, but you can also create a streaming connection from an existing NATS core connection. Using an existing connection allows complete control over the core NATS options. As of version 2.2.0 the way this class should be used has changed and accessors on this class are deprecated. Instead create an Options.Builder, set the attributes there and assign that options builder to a connection factory with setOptions or use the new constructor. New properties will only be added to the options class and not replicated here. The existing accessors work, but should be moved away from.

Constructor Summary

Constructors

Constructor and Description
StreamingConnectionFactory() Create a new, un-configured, connection factory.
StreamingConnectionFactory(Options options) Create a connection factory with the specified cluster and client ids.
StreamingConnectionFactory(java.lang.String clusterId, java.lang.String clientId) Create a connection factory with the specified cluster and client ids.

Method Summary

Modifier and Type	Method and Description
StreamingConnection	createConnection() Creates an active connection to a NATS Streaming server.
java.time.Duration	getAckTimeout() Deprecated. use options directly
java.lang.String	getClientId() Deprecated. use options directly
java.lang.String	getClusterId() Deprecated. use options directly
io.nats.client.ConnectionListener	getConnectionListener() Deprecated. use options directly
java.time.Duration	getConnectTimeout() Deprecated. use options directly
java.lang.String	getDiscoverPrefix() Deprecated. use options directly
io.nats.client.ErrorListener	getErrorListener() Deprecated. use options directly
int	getMaxPubAcksInFlight() Deprecated. use options directly
io.nats.client.Connection	getNatsConnection() Deprecated. use options directly
java.lang.String	getNatsUrl() Deprecated. use options directly
void	setAckTimeout(java.time.Duration ackTimeout) Deprecated. use options directly
void	setAckTimeout(long ackTimeout, java.util.concurrent.TimeUnit unit) Deprecated. use options directly
void	setClientId(java.lang.String clientId) Deprecated. use options directly
void	setClusterId(java.lang.String clusterId) Deprecated. use options directly
void	setConnectionListener(io.nats.client.ConnectionListener l) Deprecated. use options directly
void	setConnectTimeout(java.time.Duration connectTimeout) Deprecated. use options directly
void	setConnectTimeout(long connectTimeout, java.util.concurrent.TimeUnit unit) Deprecated. use options directly
void	setDiscoverPrefix(java.lang.String discoverPrefix) Deprecated. use options directly
void	setErrorListener(io.nats.client.ErrorListener l) Deprecated. use options directly
void	setMaxPubAcksInFlight(int maxPubAcksInFlight) Deprecated. use options directly
void	setNatsConnection(io.nats.client.Connection natsConn) Deprecated. use options directly
void	setNatsUrl(java.lang.String natsUrl) Deprecated. use options directly
void	setOptions(Options o) Copies the options for use in future connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingConnectionFactory

public StreamingConnectionFactory()

Create a new, un-configured, connection factory. The cluster and client id must be set before use.

StreamingConnectionFactory

public StreamingConnectionFactory(java.lang.String clusterId,
                                  java.lang.String clientId)

Create a connection factory with the specified cluster and client ids.

Parameters:

clusterId - the cluster id to connect to

clientId - the id for this client, with respect to the cluster

StreamingConnectionFactory

public StreamingConnectionFactory(Options options)

Create a connection factory with the specified cluster and client ids.

Parameters:

options - the options to create this factory with

Method Detail

createConnection

public StreamingConnection createConnection()
                                     throws java.io.IOException,
                                            java.lang.InterruptedException

Creates an active connection to a NATS Streaming server.

Returns:

the StreamingConnection.

Throws:

java.io.IOException - if a StreamingConnection cannot be established for some reason.

java.lang.InterruptedException - if the calling thread is interrupted before the connection can be established

setOptions

public void setOptions(Options o)

Copies the options for use in future connections.

Parameters:

o - the options to copy

getAckTimeout

public java.time.Duration getAckTimeout()

Deprecated. use options directly

Returns the ACK timeout.

Returns:

the pubAckWait

setAckTimeout

public void setAckTimeout(java.time.Duration ackTimeout)

Deprecated. use options directly

Sets the ACK timeout duration.

Parameters:

ackTimeout - the pubAckWait to set

setAckTimeout

public void setAckTimeout(long ackTimeout,
                          java.util.concurrent.TimeUnit unit)

Deprecated. use options directly

Sets the ACK timeout in the specified time unit.

Parameters:

ackTimeout - the pubAckWait to set

unit - the time unit to set

getConnectTimeout

public java.time.Duration getConnectTimeout()

Deprecated. use options directly

Returns the connect timeout interval in milliseconds.

Returns:

the connectWait

setConnectTimeout

public void setConnectTimeout(java.time.Duration connectTimeout)

Deprecated. use options directly

Sets the connect timeout duration.

Parameters:

connectTimeout - the connectWait to set

setConnectTimeout

public void setConnectTimeout(long connectTimeout,
                              java.util.concurrent.TimeUnit unit)

Deprecated. use options directly

Sets the connect timeout in the specified time unit.

Parameters:

connectTimeout - the connectWait to set

unit - the time unit to set

getDiscoverPrefix

public java.lang.String getDiscoverPrefix()

Deprecated. use options directly

Returns the currently configured discover prefix string.

Returns:

the discoverPrefix

setDiscoverPrefix

public void setDiscoverPrefix(java.lang.String discoverPrefix)

Deprecated. use options directly

Sets the discover prefix string that is used to establish a nats streaming session.

Parameters:

discoverPrefix - the discoverPrefix to set

getMaxPubAcksInFlight

public int getMaxPubAcksInFlight()

Deprecated. use options directly

Returns the maximum number of publish ACKs that may be in flight at any point in time.

Returns:

the maxPubAcksInFlight

setMaxPubAcksInFlight

public void setMaxPubAcksInFlight(int maxPubAcksInFlight)

Deprecated. use options directly

Sets the maximum number of publish ACKs that may be in flight at any point in time.

Parameters:

maxPubAcksInFlight - the maxPubAcksInFlight to set

getNatsUrl

public java.lang.String getNatsUrl()

Deprecated. use options directly

Returns the NATS connection URL.

Returns:

the NATS connection URL

setNatsUrl

public void setNatsUrl(java.lang.String natsUrl)

Deprecated. use options directly

Sets the NATS URL.

Parameters:

natsUrl - the natsUrl to set

getNatsConnection

public io.nats.client.Connection getNatsConnection()

Deprecated. use options directly

Returns the NATS StreamingConnection, if set.

Returns:

the NATS StreamingConnection

setNatsConnection

public void setNatsConnection(io.nats.client.Connection natsConn)

Deprecated. use options directly

Sets the NATS StreamingConnection.

Parameters:

natsConn - the NATS connection to set

getClientId

public java.lang.String getClientId()

Deprecated. use options directly

Returns the client ID of the current NATS streaming session.

Returns:

the client ID of the current NATS streaming session

setClientId

public void setClientId(java.lang.String clientId)

Deprecated. use options directly

Sets the client ID for the current NATS streaming session.

Parameters:

clientId - the clientId to set

getClusterId

public java.lang.String getClusterId()

Deprecated. use options directly

Returns the cluster ID of the current NATS streaming session.

Returns:

the clusterId

setClusterId

public void setClusterId(java.lang.String clusterId)

Deprecated. use options directly

Sets the cluster ID of the current NATS streaming session.

Parameters:

clusterId - the clusterId to set

getConnectionListener

public io.nats.client.ConnectionListener getConnectionListener()

Deprecated. use options directly

Returns:

the connection listener configured for this factory

setConnectionListener

public void setConnectionListener(io.nats.client.ConnectionListener l)

Deprecated. use options directly

Set a connection listener for the underlying nats connection.

Parameters:

l - The new connection listener

getErrorListener

public io.nats.client.ErrorListener getErrorListener()

Deprecated. use options directly

Returns:

the error listener associated with this factory

setErrorListener

public void setErrorListener(io.nats.client.ErrorListener l)

Deprecated. use options directly

Set a error listener for the underlying nats connection.

Parameters:

l - The new error listener