services.moleculer.transporter

Class FileSystemTransporter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.transporter.Transporter

services.moleculer.transporter.FileSystemTransporter

All Implemented Interfaces:

MetricConstants, MoleculerLifecycle

public class FileSystemTransporter
extends Transporter

Filesystem-based transporter. It is primarily not for production use (its safe but much slower than other Transporters). Rather it can be considered as a reference implementation or a sample. With this Transporter multiple Service Brokers can communicate with each other through a common directory structure. Usage:

 ServiceBroker broker = ServiceBroker.builder().nodeID("node1")
 .transporter(new FileSystemTransporter("/temp")).build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FileSystemTransporter.DirectoryHandler
protected static class	FileSystemTransporter.RemovableFile

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	directory Root directory of message files (eg.
protected long	fileTimeout Read timeout of request in MILLISECONDS (deleted request files after this limit).
protected java.util.HashMap<java.lang.String,FileSystemTransporter.DirectoryHandler>	inputDirectories
protected java.util.HashMap<java.lang.String,FileSystemTransporter.DirectoryHandler>	outputDirectories
protected java.util.concurrent.ScheduledFuture<?>	pollerProcess Cancelable timer of poller/cleanup process
protected long	pollingDelay Poll period in MILLISECONDS.
protected int	storedFileNames Max stored file names (per channel).
protected java.util.concurrent.ScheduledFuture<?>	timeoutProcess Cancelable timer of poller/cleanup process

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
FileSystemTransporter()
FileSystemTransporter(java.lang.String directory)
FileSystemTransporter(java.lang.String directory, long pollingDelay)

Method Summary

Modifier and Type	Method and Description
void	connect()
protected java.io.File	getChannelDirectory(java.lang.String channel)
java.lang.String	getDirectory()
long	getFileTimeout()
long	getPollingDelay()
int	getStoredFileNames()
protected void	pollerProcess()
void	publish(java.lang.String channel, io.datatree.Tree message)
void	setDirectory(java.lang.String directory)
void	setFileTimeout(long fileTimeout)
void	setPollingDelay(long pollingDelay)
void	setStoredFileNames(int storedFileNames)
void	started(ServiceBroker broker) Initializes transporter instance.
void	stopped() Closes transporter.
io.datatree.Promise	subscribe(java.lang.String channel)
protected void	timeoutProcess()

Methods inherited from class services.moleculer.transporter.Transporter

broadcastInfoPacket, broadcastNodeConnected, broadcastNodeDisconnected, broadcastNodeUpdated, broadcastTransporterConnected, broadcastTransporterDisconnected, channel, checkTimeouts, connected, connected, createPingPacket, error, 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, 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

directory

protected java.lang.String directory

Root directory of message files (eg. "/moleculer")

pollingDelay

protected long pollingDelay

Poll period in MILLISECONDS.

fileTimeout

protected long fileTimeout

Read timeout of request in MILLISECONDS (deleted request files after this limit).

storedFileNames

protected int storedFileNames

Max stored file names (per channel).

inputDirectories

protected java.util.HashMap<java.lang.String,FileSystemTransporter.DirectoryHandler> inputDirectories

outputDirectories

protected java.util.HashMap<java.lang.String,FileSystemTransporter.DirectoryHandler> outputDirectories

pollerProcess

protected volatile java.util.concurrent.ScheduledFuture<?> pollerProcess

Cancelable timer of poller/cleanup process

timeoutProcess

protected volatile java.util.concurrent.ScheduledFuture<?> timeoutProcess

Cancelable timer of poller/cleanup process

Constructor Detail

FileSystemTransporter

public FileSystemTransporter()

FileSystemTransporter

public FileSystemTransporter(java.lang.String directory)

FileSystemTransporter

public FileSystemTransporter(java.lang.String directory,
                             long pollingDelay)

Method Detail

started

public void started(ServiceBroker broker)
             throws java.lang.Exception

Description copied from class: Transporter

Initializes transporter instance.

Specified by:

started in interface MoleculerLifecycle

Overrides:

started in class Transporter

Parameters:

broker - parent ServiceBroker

Throws:

java.lang.Exception

stopped

public void stopped()

Description copied from class: Transporter

Closes transporter.

Specified by:

stopped in interface MoleculerLifecycle

Overrides:

stopped in class Transporter

pollerProcess

protected void pollerProcess()

timeoutProcess

protected void timeoutProcess()

connect

public void connect()

Specified by:

connect in class Transporter

publish

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

Specified by:

publish in class Transporter

subscribe

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

Specified by:

subscribe in class Transporter

getChannelDirectory

protected java.io.File getChannelDirectory(java.lang.String channel)

getDirectory

public java.lang.String getDirectory()

setDirectory

public void setDirectory(java.lang.String directory)

getPollingDelay

public long getPollingDelay()

setPollingDelay

public void setPollingDelay(long pollingDelay)

getFileTimeout

public long getFileTimeout()

setFileTimeout

public void setFileTimeout(long fileTimeout)

getStoredFileNames

public int getStoredFileNames()

setStoredFileNames

public void setStoredFileNames(int storedFileNames)