io.nats.stan

Class ConnectionFactory

java.lang.Object

io.nats.stan.ConnectionFactory

public class ConnectionFactory
extends Object

A ConnectionFactory object encapsulates a set of connection configuration options. A client uses it to create a connection to the STAN streaming data system.

Constructor Summary

Constructors

Constructor and Description
ConnectionFactory()
ConnectionFactory(String clusterId, String clientId)

Method Summary

Modifier and Type	Method and Description
Connection	createConnection() Creates an active connection to a NATS Streaming server.
Duration	getAckTimeout() Returns the ACK timeout.
String	getClientId() Returns the client ID of the current STAN session.
String	getClusterId() Returns the cluster ID of the current STAN session.
Duration	getConnectTimeout() Returns the connect timeout interval in milliseconds.
String	getDiscoverPrefix() Returns the currently configured discover prefix string.
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 Connection, if set.
String	getNatsUrl() Returns the NATS connection URL.
void	setAckTimeout(Duration ackTimeout) Sets the ACK timeout duration.
void	setAckTimeout(long ackTimeout, TimeUnit unit) Sets the ACK timeout in the specified time unit.
void	setClientId(String clientId) Sets the client ID for the current STAN session.
void	setClusterId(String clusterId) Sets the cluster ID of the current STAN session.
void	setConnectTimeout(Duration connectTimeout) Sets the connect timeout duration.
void	setConnectTimeout(long connectTimeout, TimeUnit unit) Sets the connect timeout in the specified time unit.
void	setDiscoverPrefix(String discoverPrefix) Sets the discover prefix string that is used to establish a STAN session.
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 Connection.
void	setNatsUrl(String natsUrl) Sets the NATS URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionFactory

public ConnectionFactory()

ConnectionFactory

public ConnectionFactory(String clusterId,
                         String clientId)

Method Detail

createConnection

public Connection createConnection()
                            throws IOException,
                                   TimeoutException

Creates an active connection to a NATS Streaming server.

Returns:

the Connection.

Throws:

IOException - if a Connection cannot be established for some reason.

TimeoutException - if the connection timeout has been exceeded.

getAckTimeout

public Duration getAckTimeout()

Returns the ACK timeout.

Returns:

the ackTimeout

setAckTimeout

public void setAckTimeout(Duration ackTimeout)

Sets the ACK timeout duration.

Parameters:

ackTimeout - the ackTimeout to set

setAckTimeout

public void setAckTimeout(long ackTimeout,
                          TimeUnit unit)

Sets the ACK timeout in the specified time unit.

Parameters:

ackTimeout - the ackTimeout to set

unit - the time unit to set

getConnectTimeout

public Duration getConnectTimeout()

Returns the connect timeout interval in milliseconds.

Returns:

the connectTimeout

setConnectTimeout

public void setConnectTimeout(Duration connectTimeout)

Sets the connect timeout duration.

Parameters:

connectTimeout - the connectTimeout to set

setConnectTimeout

public void setConnectTimeout(long connectTimeout,
                              TimeUnit unit)

Sets the connect timeout in the specified time unit.

Parameters:

connectTimeout - the connectTimeout to set

unit - the time unit to set

getDiscoverPrefix

public String getDiscoverPrefix()

Returns the currently configured discover prefix string.

Returns:

the discoverPrefix

setDiscoverPrefix

public void setDiscoverPrefix(String discoverPrefix)

Sets the discover prefix string that is used to establish a STAN 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 String getNatsUrl()

Returns the NATS connection URL.

Returns:

the NATS connection URL

setNatsUrl

public void setNatsUrl(String natsUrl)

Sets the NATS URL.

Parameters:

natsUrl - the natsUrl to set

getNatsConnection

public io.nats.client.Connection getNatsConnection()

Returns the NATS Connection, if set.

Returns:

the NATS Connection

setNatsConnection

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

Sets the NATS Connection.

Parameters:

natsConn - the NATS connection to set

getClientId

public String getClientId()

Returns the client ID of the current STAN session.

Returns:

the client ID of the current STAN session

setClientId

public void setClientId(String clientId)

Sets the client ID for the current STAN session.

Parameters:

clientId - the clientId to set

getClusterId

public String getClusterId()

Returns the cluster ID of the current STAN session.

Returns:

the clusterId

setClusterId

public void setClusterId(String clusterId)

Sets the cluster ID of the current STAN session.

Parameters:

clusterId - the clusterId to set