services.moleculer.transporter

Class JmsTransporter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.transporter.Transporter

services.moleculer.transporter.JmsTransporter

All Implemented Interfaces:

MetricConstants, MoleculerLifecycle

public class JmsTransporter
extends Transporter

JMS Transporter. The Java Message Service API is a Java Message Oriented Middleware API for sending messages between two or more clients. It is an implementation to handle the Producer-consumer problem. JMS is a part of the Java Enterprise Edition. Sample of usage with Active MQ:

 Transporter t = new JmsTransporter(new ActiveMQConnectionFactory());
 ServiceBroker broker = ServiceBroker.builder().transporter(t).build();
 

Required dependency:

// https://mvnrepository.com/artifact/javax.jms/javax.jms-api
compile group: 'javax.jms', name: 'javax.jms-api', version: '2.0.1'

+ dependencies of the JMS driver.

See Also:

TcpTransporter, RedisTransporter, NatsTransporter, NatsStreamingTransporter, MqttTransporter, KafkaTransporter, AmqpTransporter

Field Summary

Fields

Modifier and Type	Field and Description
protected int	acknowledgeMode
protected javax.jms.TopicConnection	client
protected java.lang.String	connectionFactoryJndiName
protected int	deliveryMode
protected javax.jms.TopicConnectionFactory	factory
protected java.lang.String	password
protected int	priority
protected java.util.HashMap<java.lang.String,javax.jms.TopicPublisher>	publishers
protected javax.jms.TopicSession	session
protected java.util.HashMap<java.lang.String,javax.jms.TopicSubscriber>	subscribers
protected boolean	transacted
protected int	ttl
protected java.lang.String	username

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
JmsTransporter()
JmsTransporter(java.lang.String connectionFactoryJndiName)
JmsTransporter(java.lang.String username, java.lang.String password, java.lang.String connectionFactoryJndiName)
JmsTransporter(java.lang.String username, java.lang.String password, javax.jms.TopicConnectionFactory connectionFactory)
JmsTransporter(javax.jms.TopicConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method and Description
void	connect()
protected javax.jms.TopicPublisher	createOrGetPublisher(java.lang.String channel)
protected void	disconnect()
protected void	error(java.lang.Throwable cause) Any I/O error occurred.
int	getAcknowledgeMode()
java.lang.String	getConnectionFactoryJndiName()
int	getDeliveryMode()
java.lang.String	getPassword()
int	getPriority()
javax.jms.TopicConnectionFactory	getTopicConnectionFactory()
int	getTtl()
java.lang.String	getUsername()
boolean	isTransacted()
void	publish(java.lang.String channel, io.datatree.Tree message)
protected void	reconnect(java.lang.Throwable cause)
void	setAcknowledgeMode(int acknowledgeMode)
void	setConnectionFactoryJndiName(java.lang.String connectionFactoryJndiName)
void	setDeliveryMode(int deliveryMode)
void	setPassword(java.lang.String password)
void	setPriority(int priority)
void	setTopicConnectionFactory(javax.jms.TopicConnectionFactory factory)
void	setTransacted(boolean transacted)
void	setTtl(int ttl)
void	setUsername(java.lang.String username)
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

password

protected java.lang.String password

transacted

protected boolean transacted

acknowledgeMode

protected int acknowledgeMode

deliveryMode

protected int deliveryMode

priority

protected int priority

ttl

protected int ttl

connectionFactoryJndiName

protected java.lang.String connectionFactoryJndiName

factory

protected javax.jms.TopicConnectionFactory factory

client

protected javax.jms.TopicConnection client

session

protected javax.jms.TopicSession session

publishers

protected final java.util.HashMap<java.lang.String,javax.jms.TopicPublisher> publishers

subscribers

protected final java.util.HashMap<java.lang.String,javax.jms.TopicSubscriber> subscribers

Constructor Detail

JmsTransporter

public JmsTransporter()

JmsTransporter

public JmsTransporter(java.lang.String connectionFactoryJndiName)

JmsTransporter

public JmsTransporter(javax.jms.TopicConnectionFactory connectionFactory)

JmsTransporter

public JmsTransporter(java.lang.String username,
                      java.lang.String password,
                      java.lang.String connectionFactoryJndiName)

JmsTransporter

public JmsTransporter(java.lang.String username,
                      java.lang.String password,
                      javax.jms.TopicConnectionFactory connectionFactory)

Method Detail

connect

public void connect()

Specified by:

connect in class Transporter

disconnect

protected void disconnect()

reconnect

protected void reconnect(java.lang.Throwable cause)

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

createOrGetPublisher

protected javax.jms.TopicPublisher createOrGetPublisher(java.lang.String channel)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

publish

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

Specified by:

publish in class Transporter

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getAcknowledgeMode

public int getAcknowledgeMode()

setAcknowledgeMode

public void setAcknowledgeMode(int acknowledgeMode)

getDeliveryMode

public int getDeliveryMode()

setDeliveryMode

public void setDeliveryMode(int deliveryMode)

getTopicConnectionFactory

public javax.jms.TopicConnectionFactory getTopicConnectionFactory()

setTopicConnectionFactory

public void setTopicConnectionFactory(javax.jms.TopicConnectionFactory factory)

isTransacted

public boolean isTransacted()

setTransacted

public void setTransacted(boolean transacted)

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

getTtl

public int getTtl()

setTtl

public void setTtl(int ttl)

getConnectionFactoryJndiName

public java.lang.String getConnectionFactoryJndiName()

setConnectionFactoryJndiName

public void setConnectionFactoryJndiName(java.lang.String connectionFactoryJndiName)