services.moleculer.transporter

Class NatsTransporter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.transporter.Transporter

services.moleculer.transporter.NatsTransporter

All Implemented Interfaces:

io.nats.client.ConnectionListener, io.nats.client.MessageHandler, MetricConstants, MoleculerLifecycle

public class NatsTransporter
extends Transporter
implements io.nats.client.MessageHandler, io.nats.client.ConnectionListener

NATS Transporter. NATS Server is a simple, high performance open source messaging system for cloud native applications, IoT messaging, and microservices architectures (website: https://nats.io). Tested with NATS server version 1.3.0. Usage:

 ServiceBroker broker = ServiceBroker.builder().nodeID("node1")
 .transporter(new NatsTransporter("localhost")).build();
 

Required dependency:

// https://mvnrepository.com/artifact/io.nats/jnats
compile group: 'io.nats', name: 'jnats', version: '2.6.6'

See Also:

TcpTransporter, RedisTransporter, NatsStreamingTransporter, MqttTransporter, JmsTransporter, KafkaTransporter, AmqpTransporter

Nested Class Summary

Nested classes/interfaces inherited from interface io.nats.client.ConnectionListener

io.nats.client.ConnectionListener.Events

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	advancedStats Turn on advanced stats, primarily for test/benchmarks.
protected io.nats.client.AuthHandler	authHandler Optional AuthHandler.
protected int	bufferSize Sets the initial size for buffers in the connection.
protected io.nats.client.Connection	client
protected long	connectionTimeout Set the timeout for connection attempts in MILLISECONDS.
protected io.nats.client.Dispatcher	dispatcher
protected int	maxPingsOut Set the maximum number of pings the client can have in flight.
protected boolean	noEcho Turn off echo.
protected boolean	noRandomize Turn off server pool randomization.
protected boolean	oldRequestStyle Turn on the old request style that uses a new inbox and subscriber for each request.
protected boolean	opentls Set the SSL context to one that accepts any server certificate and has no client certificate.
protected java.lang.String	password Password for basic authentication.
protected boolean	pedantic Turn on pedantic mode for the server.
protected long	pingInterval Set the interval between attempts to pings the server in MILLISECONDS.
protected boolean	secure Use the default SSL Context, if it exists.
protected javax.net.ssl.SSLContext	sslContext Optional SSL Context.
protected java.util.concurrent.atomic.AtomicBoolean	started
protected java.lang.String[]	urls Nats server url(s).
protected java.lang.String	username Username for basic authentication.
protected boolean	utf8Support Enable UTF8 channels.
protected boolean	verbose Turn on verbose mode with the server.

Fields inherited from class services.moleculer.transporter.Transporter

checkTimeoutTimer, counterTransporterPacketsReceivedBytes, counterTransporterPacketsReceivedTotal, counterTransporterPacketsSentBytes, counterTransporterPacketsSentTotal, debug, debugHeartbeats, disconnectChannel, discoverBroadcastChannel, discoverChannel, eventbus, eventChannel, executor, gaugeTransitConnected, heartbeatChannel, heartbeatInterval, heartbeatTimeout, heartBeatTimer, infoBroadcastChannel, infoChannel, infoScheduled, infoScheduledAt, instanceID, lastReceivedMessageAt, metrics, monitor, namespace, nodeID, nodes, offlineTimeout, PACKET_DISCONNECT, PACKET_DISCOVER, PACKET_EVENT, PACKET_HEARTBEAT, PACKET_INFO, PACKET_PING, PACKET_PONG, PACKET_REQUEST, PACKET_RESPONSE, pingChannel, pongChannel, preferHostname, prefix, protocolVersion, registry, requestChannel, responseChannel, scheduler, serializer, serviceInvoker, subscriptionTimeout, uidGenerator, usingJsonSerializer

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Fields inherited from interface services.moleculer.metrics.MetricConstants

MOLECULER_CACHER_CLEAN_TIME, MOLECULER_CACHER_CLEAN_TIME_DESC, MOLECULER_CACHER_CLEAN_TOTAL, MOLECULER_CACHER_CLEAN_TOTAL_DESC, MOLECULER_CACHER_DEL_TIME, MOLECULER_CACHER_DEL_TIME_DESC, MOLECULER_CACHER_DEL_TOTAL, MOLECULER_CACHER_DEL_TOTAL_DESC, MOLECULER_CACHER_EXPIRED_TOTAL, MOLECULER_CACHER_EXPIRED_TOTAL_DESC, MOLECULER_CACHER_FOUND_TOTAL, MOLECULER_CACHER_FOUND_TOTAL_DESC, MOLECULER_CACHER_GET_TIME, MOLECULER_CACHER_GET_TIME_DESC, MOLECULER_CACHER_GET_TOTAL, MOLECULER_CACHER_GET_TOTAL_DESC, MOLECULER_CACHER_SET_TIME, MOLECULER_CACHER_SET_TIME_DESC, MOLECULER_CACHER_SET_TOTAL, MOLECULER_CACHER_SET_TOTAL_DESC, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL_DESC, MOLECULER_EVENT_BROADCAST_TOTAL, MOLECULER_EVENT_BROADCAST_TOTAL_DESC, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL_DESC, MOLECULER_EVENT_EMIT_TOTAL, MOLECULER_EVENT_EMIT_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_ACTIVE, MOLECULER_EVENT_RECEIVED_ACTIVE_DESC, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_TIME, MOLECULER_EVENT_RECEIVED_TIME_DESC, MOLECULER_EVENT_RECEIVED_TOTAL, MOLECULER_EVENT_RECEIVED_TOTAL_DESC, MOLECULER_EXECUTOR, MOLECULER_REQUEST_ACTIVE, MOLECULER_REQUEST_ACTIVE_DESC, MOLECULER_REQUEST_ERROR_TOTAL, MOLECULER_REQUEST_ERROR_TOTAL_DESC, MOLECULER_REQUEST_LEVELS, MOLECULER_REQUEST_LEVELS_DESC, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL_DESC, MOLECULER_REQUEST_TIME, MOLECULER_REQUEST_TIME_DESC, MOLECULER_REQUEST_TIMEOUT_TOTAL, MOLECULER_REQUEST_TIMEOUT_TOTAL_DESC, MOLECULER_REQUEST_TOTAL, MOLECULER_REQUEST_TOTAL_DESC, MOLECULER_SCHEDULER, MOLECULER_TRANSIT_CONNECTED, MOLECULER_TRANSIT_CONNECTED_DESC, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL_DESC, MOLECULER_TRANSIT_REQUESTS_ACTIVE, MOLECULER_TRANSIT_REQUESTS_ACTIVE_DESC, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL_DESC

Constructor Summary

Constructors

Constructor and Description
NatsTransporter()
NatsTransporter(java.lang.String... urls)
NatsTransporter(java.lang.String username, java.lang.String password, boolean secure, java.lang.String... urls)

Method Summary

Modifier and Type	Method and Description
void	connect()
void	connectionEvent(io.nats.client.Connection conn, io.nats.client.ConnectionListener.Events type)
protected void	disconnect()
protected void	error(java.lang.Throwable cause) Any I/O error occurred.
io.nats.client.AuthHandler	getAuthHandler()
int	getBufferSize()
long	getConnectionTimeout()
int	getMaxPingsOut()
java.lang.String	getPassword()
long	getPingInterval()
javax.net.ssl.SSLContext	getSslContext()
io.nats.client.Statistics	getStatistics()
java.lang.String[]	getUrls()
java.lang.String	getUsername()
boolean	isAdvancedStats()
boolean	isNoEcho()
boolean	isNoRandomize()
boolean	isOldRequestStyle()
boolean	isOpentls()
boolean	isPedantic()
boolean	isSecure()
boolean	isUtf8Support()
boolean	isVerbose()
void	onMessage(io.nats.client.Message msg)
void	publish(java.lang.String channel, io.datatree.Tree message)
protected void	reconnect()
void	setAdvancedStats(boolean advancedStats)
void	setAuthHandler(io.nats.client.AuthHandler authHandler)
void	setBufferSize(int bufferSize)
void	setConnectionTimeout(long connectionTimeout)
void	setMaxPingsOut(int maxPingsOut)
void	setNoEcho(boolean noEcho)
void	setNoRandomize(boolean noRandomize)
void	setOldRequestStyle(boolean oldRequestStyle)
void	setOpentls(boolean opentls)
void	setPassword(java.lang.String password)
void	setPedantic(boolean pedantic)
void	setPingInterval(long pingInterval)
void	setSecure(boolean secure)
void	setSslContext(javax.net.ssl.SSLContext sslContext)
void	setUrls(java.lang.String... urls)
void	setUsername(java.lang.String username)
void	setUtf8Support(boolean utf8Support)
void	setVerbose(boolean verbose)
void	stopped() Closes transporter.
io.datatree.Promise	subscribe(java.lang.String channel)

Methods inherited from class services.moleculer.transporter.Transporter

broadcastInfoPacket, broadcastNodeConnected, broadcastNodeDisconnected, broadcastNodeUpdated, broadcastTransporterConnected, broadcastTransporterDisconnected, channel, checkTimeouts, connected, connected, createPingPacket, getAddress, getAllNodeIDs, getCpuUsage, getDescriptor, getHeartbeatInterval, getHeartbeatTimeout, getInstanceID, getLastHeartbeatTime, getNamespace, getOfflineTimeout, getPrefix, getSerializer, getSubscriptionTimeout, isDebug, isDebugHeartbeats, isOnline, isPreferHostname, processReceivedMessage, processReceivedMessage, publish, received, scheduleInfoPacket, sendClosePacket, sendDataPacket, sendDisconnectPacket, sendDiscoverPacket, sendErrorPacket, sendEventPacket, sendHeartbeatPacket, sendInfoPacket, sendPongPacket, sendRequestPacket, setDebug, setDebugHeartbeats, setHeartbeatInterval, setHeartbeatTimeout, setNamespace, setOfflineTimeout, setPreferHostname, setPrefix, setSerializer, setSubscriptionTimeout, started, subscribe, updateNodeInfo

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class java.lang.Object

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

Field Detail

username

protected java.lang.String username

Username for basic authentication.

password

protected java.lang.String password

Password for basic authentication.

secure

protected boolean secure

Use the default SSL Context, if it exists.

urls

protected java.lang.String[] urls

Nats server url(s).

sslContext

protected javax.net.ssl.SSLContext sslContext

Optional SSL Context.

noRandomize

protected boolean noRandomize

Turn off server pool randomization.

maxPingsOut

protected int maxPingsOut

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

pingInterval

protected long pingInterval

Set the interval between attempts to pings the server in MILLISECONDS.

connectionTimeout

protected long connectionTimeout

Set the timeout for connection attempts in MILLISECONDS.

verbose

protected boolean verbose

Turn on verbose mode with the server.

bufferSize

protected int bufferSize

Sets the initial size for buffers in the connection.

authHandler

protected io.nats.client.AuthHandler authHandler

Optional AuthHandler.

noEcho

protected boolean noEcho

Turn off echo.

utf8Support

protected boolean utf8Support

Enable UTF8 channels.

pedantic

protected boolean pedantic

Turn on pedantic mode for the server.

advancedStats

protected boolean advancedStats

Turn on advanced stats, primarily for test/benchmarks.

opentls

protected boolean opentls

Set the SSL context to one that accepts any server certificate and has no client certificate.

oldRequestStyle

protected boolean oldRequestStyle

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

client

protected io.nats.client.Connection client

dispatcher

protected io.nats.client.Dispatcher dispatcher

started

protected final java.util.concurrent.atomic.AtomicBoolean started

Constructor Detail

NatsTransporter

public NatsTransporter()

NatsTransporter

public NatsTransporter(java.lang.String... urls)

NatsTransporter

public NatsTransporter(java.lang.String username,
                       java.lang.String password,
                       boolean secure,
                       java.lang.String... urls)

Method Detail

connect

public void connect()

Specified by:

connect in class Transporter

connectionEvent

public void connectionEvent(io.nats.client.Connection conn,
                            io.nats.client.ConnectionListener.Events type)

Specified by:

connectionEvent in interface io.nats.client.ConnectionListener

disconnect

protected void disconnect()

reconnect

protected void reconnect()

error

protected void error(java.lang.Throwable cause)

Description copied from class: Transporter

Any I/O error occurred. Implementation-specific error handling goes here (reconnection, etc.).

Overrides:

error in class Transporter

Parameters:

cause - I/O error

stopped

public void stopped()

Closes transporter.

Specified by:

stopped in interface MoleculerLifecycle

Overrides:

stopped in class Transporter

subscribe

public io.datatree.Promise subscribe(java.lang.String channel)

Specified by:

subscribe in class Transporter

onMessage

public void onMessage(io.nats.client.Message msg)

Specified by:

onMessage in interface io.nats.client.MessageHandler

publish

public void publish(java.lang.String channel,
                    io.datatree.Tree message)

Specified by:

publish in class Transporter

getStatistics

public io.nats.client.Statistics getStatistics()

Returns:

Statistics

getConnectionTimeout

public long getConnectionTimeout()

Returns:

the connectionTimeout

setConnectionTimeout

public void setConnectionTimeout(long connectionTimeout)

Parameters:

connectionTimeout - the connectionTimeout to set

getBufferSize

public int getBufferSize()

Returns:

the bufferSize

setBufferSize

public void setBufferSize(int bufferSize)

Parameters:

bufferSize - the bufferSize to set

getAuthHandler

public io.nats.client.AuthHandler getAuthHandler()

Returns:

the authHandler

setAuthHandler

public void setAuthHandler(io.nats.client.AuthHandler authHandler)

Parameters:

authHandler - the authHandler to set

isNoEcho

public boolean isNoEcho()

Returns:

the noEcho

setNoEcho

public void setNoEcho(boolean noEcho)

Parameters:

noEcho - the noEcho to set

isUtf8Support

public boolean isUtf8Support()

Returns:

the utf8Support

setUtf8Support

public void setUtf8Support(boolean utf8Support)

Parameters:

utf8Support - the utf8Support to set

isPedantic

public boolean isPedantic()

Returns:

the pedantic

setPedantic

public void setPedantic(boolean pedantic)

Parameters:

pedantic - the pedantic to set

isAdvancedStats

public boolean isAdvancedStats()

Returns:

the advancedStats

setAdvancedStats

public void setAdvancedStats(boolean advancedStats)

Parameters:

advancedStats - the advancedStats to set

isOpentls

public boolean isOpentls()

Returns:

the opentls

setOpentls

public void setOpentls(boolean opentls)

Parameters:

opentls - the opentls to set

getUsername

public java.lang.String getUsername()

Returns:

the username

setUsername

public void setUsername(java.lang.String username)

Parameters:

username - the username to set

getPassword

public java.lang.String getPassword()

Returns:

the password

setPassword

public void setPassword(java.lang.String password)

Parameters:

password - the password to set

isSecure

public boolean isSecure()

Returns:

the secure

setSecure

public void setSecure(boolean secure)

Parameters:

secure - the secure to set

getUrls

public java.lang.String[] getUrls()

Returns:

the urls

setUrls

public void setUrls(java.lang.String... urls)

Parameters:

urls - the urls to set

getSslContext

public javax.net.ssl.SSLContext getSslContext()

Returns:

the sslContext

setSslContext

public void setSslContext(javax.net.ssl.SSLContext sslContext)

Parameters:

sslContext - the sslContext to set

isNoRandomize

public boolean isNoRandomize()

Returns:

the noRandomize

setNoRandomize

public void setNoRandomize(boolean noRandomize)

Parameters:

noRandomize - the noRandomize to set

getMaxPingsOut

public int getMaxPingsOut()

Returns:

the maxPingsOut

setMaxPingsOut

public void setMaxPingsOut(int maxPingsOut)

Parameters:

maxPingsOut - the maxPingsOut to set

getPingInterval

public long getPingInterval()

Returns:

the pingInterval

setPingInterval

public void setPingInterval(long pingInterval)

Parameters:

pingInterval - the pingInterval to set

isVerbose

public boolean isVerbose()

Returns:

the verbose

setVerbose

public void setVerbose(boolean verbose)

Parameters:

verbose - the verbose to set

isOldRequestStyle

public boolean isOldRequestStyle()

Returns:

the oldRequestStyle

setOldRequestStyle

public void setOldRequestStyle(boolean oldRequestStyle)

Parameters:

oldRequestStyle - the oldRequestStyle to set