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.

Constructor Summary

Constructors

Constructor and Description
StreamingConnectionFactory()
StreamingConnectionFactory(java.lang.String clusterId, java.lang.String clientId)

Method Summary

Modifier and Type	Method and Description
StreamingConnection	createConnection() Creates an active connection to a NATS Streaming server.
java.time.Duration	getAckTimeout() Returns the ACK timeout.
java.lang.String	getClientId() Returns the client ID of the current NATS streaming session.
java.lang.String	getClusterId() Returns the cluster ID of the current NATS streaming session.
io.nats.client.ConnectionListener	getConnectionListener()
java.time.Duration	getConnectTimeout() Returns the connect timeout interval in milliseconds.
java.lang.String	getDiscoverPrefix() Returns the currently configured discover prefix string.
io.nats.client.ErrorListener	getErrorListener()
int	getMaxPubAcksInFlight() Returns the maximum number of publish ACKs that may be in flight at any point in time.
io.nats.client.Connection	getNatsConnection() Returns the NATS StreamingConnection, if set.
java.lang.String	getNatsUrl() Returns the NATS connection URL.
void	setAckTimeout(java.time.Duration ackTimeout) Sets the ACK timeout duration.
void	setAckTimeout(long ackTimeout, java.util.concurrent.TimeUnit unit) Sets the ACK timeout in the specified time unit.
void	setClientId(java.lang.String clientId) Sets the client ID for the current NATS streaming session.
void	setClusterId(java.lang.String clusterId) Sets the cluster ID of the current NATS streaming session.
void	setConnectionListener(io.nats.client.ConnectionListener l) Set a connection listener for the underlying nats connection.
void	setConnectTimeout(java.time.Duration connectTimeout) Sets the connect timeout duration.
void	setConnectTimeout(long connectTimeout, java.util.concurrent.TimeUnit unit) Sets the connect timeout in the specified time unit.
void	setDiscoverPrefix(java.lang.String discoverPrefix) Sets the discover prefix string that is used to establish a nats streaming session.
void	setErrorListener(io.nats.client.ErrorListener l) Set a error listener for the underlying nats connection.
void	setMaxPubAcksInFlight(int maxPubAcksInFlight) Sets the maximum number of publish ACKs that may be in flight at any point in time.
void	setNatsConnection(io.nats.client.Connection natsConn) Sets the NATS StreamingConnection.
void	setNatsUrl(java.lang.String natsUrl) Sets the NATS URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingConnectionFactory

public StreamingConnectionFactory()

StreamingConnectionFactory

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

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

getAckTimeout

public java.time.Duration getAckTimeout()

Returns the ACK timeout.

Returns:

the pubAckWait

setAckTimeout

public void setAckTimeout(java.time.Duration ackTimeout)

Sets the ACK timeout duration.

Parameters:

ackTimeout - the pubAckWait to set

setAckTimeout

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

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()

Returns the connect timeout interval in milliseconds.

Returns:

the connectWait

setConnectTimeout

public void setConnectTimeout(java.time.Duration connectTimeout)

Sets the connect timeout duration.

Parameters:

connectTimeout - the connectWait to set

setConnectTimeout

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

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()

Returns the currently configured discover prefix string.

Returns:

the discoverPrefix

setDiscoverPrefix

public void setDiscoverPrefix(java.lang.String discoverPrefix)

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

Parameters:

discoverPrefix - the discoverPrefix to set

getMaxPubAcksInFlight

public int getMaxPubAcksInFlight()

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)

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()

Returns the NATS connection URL.

Returns:

the NATS connection URL

setNatsUrl

public void setNatsUrl(java.lang.String natsUrl)

Sets the NATS URL.

Parameters:

natsUrl - the natsUrl to set

getNatsConnection

public io.nats.client.Connection getNatsConnection()

Returns the NATS StreamingConnection, if set.

Returns:

the NATS StreamingConnection

setNatsConnection

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

Sets the NATS StreamingConnection.

Parameters:

natsConn - the NATS connection to set

getClientId

public java.lang.String getClientId()

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)

Sets the client ID for the current NATS streaming session.

Parameters:

clientId - the clientId to set

getClusterId

public java.lang.String getClusterId()

Returns the cluster ID of the current NATS streaming session.

Returns:

the clusterId

setClusterId

public void setClusterId(java.lang.String clusterId)

Sets the cluster ID of the current NATS streaming session.

Parameters:

clusterId - the clusterId to set

getConnectionListener

public io.nats.client.ConnectionListener getConnectionListener()

Returns:

the connection listener configured for this factory

setConnectionListener

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

Set a connection listener for the underlying nats connection.

Parameters:

l - The new connection listener

getErrorListener

public io.nats.client.ErrorListener getErrorListener()

Returns:

the error listener associated with this factory

setErrorListener

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

Set a error listener for the underlying nats connection.

Parameters:

l - The new error listener