Connector & service config reference¶

Generated

This page is generated from the plugin config classes by tooling/config-schema-gen — do not edit by hand. The same data, machine-readable, is at schema.json (consumed by the Fluxtion project starter).

Plugins release 1.0.35-SNAPSHOT. Feeds bind under eventFeeds: / sinks under eventSinks: (key instance:); services under services: (key service:).

Connectors¶

FileEventSource `mongoose` · source¶

Built-in (mongoose-core): tail a file as an event source.

Class: com.telamin.mongoose.connector.file.FileEventSource
YAML: eventFeeds: → instance:
From: mongoose-core 1.0.25

Field	Type	Required	Default	Allowed / notes
`cacheEventLog`	boolean		`false`	Retain published lines in memory for replay.
`filename`	string	✔		format: path Path to the file to tail.
`readStrategy`	enum		`COMMITED`	`COMMITED` \| `EARLIEST` \| `LATEST` \| `ONCE_EARLIEST` \| `ONCE_LATEST` How much of the file to replay on start.

FileMessageSink `mongoose` · sink¶

Built-in (mongoose-core): append messages to a file.

Class: com.telamin.mongoose.connector.file.FileMessageSink
YAML: eventSinks: → instance:
From: mongoose-core 1.0.25

Field	Type	Required	Default	Allowed / notes
`filename`	string	✔		format: path Path of the output file.

InMemoryEventSource `mongoose` · source¶

Built-in (mongoose-core): in-memory event source (tests / in-process).

Class: com.telamin.mongoose.connector.memory.InMemoryEventSource
YAML: eventFeeds: → instance:
From: mongoose-core 1.0.25

Field	Type	Required	Default	Allowed / notes
`cacheEventLog`	boolean		`false`	Retain published events in memory for replay.

InMemoryMessageSink `mongoose` · sink¶

Built-in (mongoose-core): in-memory message sink.

Class: com.telamin.mongoose.connector.memory.InMemoryMessageSink
YAML: eventSinks: → instance:
From: mongoose-core 1.0.25

No configurable fields.

FileEventSource `connector-file` · source¶

Tail a file as an event source.

Class: com.telamin.mongoose.plugin.connector.file.FileEventSource
YAML: eventFeeds: → instance:

Field	Type	Required	Default	Allowed / notes
`cacheEventLog`	boolean		`false`	Retain published lines in memory for replay.
`filename`	string	✔		format: path Path to the file to tail.
`readStrategy`	enum		`COMMITED`	`COMMITED` \| `EARLIEST` \| `LATEST` \| `ONCE_EARLIEST` \| `ONCE_LATEST` How much of the file to replay on start.

FileMessageSink `connector-file` · sink¶

Append messages to a file.

Class: com.telamin.mongoose.plugin.connector.file.FileMessageSink
YAML: eventSinks: → instance:

Field	Type	Required	Default	Allowed / notes
`filename`	string	✔		format: path Path of the output file.
`maxBackupFiles`	int		`0`	Number of rotated backups to retain.
`rotateOnIntervalMillis`	long		`0`	format: millis Rotate on this interval; 0 = never.
`rotateOnSizeBytes`	long		`0`	Rotate when the file exceeds this many bytes; 0 = never.

KafkaMessageConsumer `connector-kafka` · source¶

Consume from a Kafka topic as an event source.

Class: com.telamin.mongoose.plugin.connector.kafka.KafkaMessageConsumer
YAML: eventFeeds: → instance:

Field	Type	Required	Default	Allowed / notes
`pollTimeoutMs`	long		`100`	format: millis Consumer poll timeout.
`properties`	map<string,string>	✔		Kafka consumer properties (bootstrap.servers, group.id, deserializers, …).
`topics`	list<string>	✔		Kafka topics to subscribe to.
`wakeupOnTearDown`	boolean		`true`

KafkaMessagePublisher `connector-kafka` · sink¶

Publish messages to a Kafka topic.

Class: com.telamin.mongoose.plugin.connector.kafka.KafkaMessagePublisher
YAML: eventSinks: → instance:

Field	Type	Required	Default	Allowed / notes
`closeTimeoutMs`	long		`5000`
`flushEveryMessage`	boolean		`true`
`properties`	map<string,string>	✔		Kafka producer properties (bootstrap.servers, serializers, …).
`registerShutdownHook`	boolean		`true`
`topic`	string	✔		Destination Kafka topic.

AeronArchiveEventSource `connector-aeron` · source¶

Subscribe to an Aeron stream / replay from an Aeron Archive.

Class: com.telamin.mongoose.plugin.connector.aeron.AeronArchiveEventSource
YAML: eventFeeds: → instance:

Field	Type	Default	Allowed / notes
`aeronDirectoryName`	string		format: path Aeron media-driver directory; blank = embedded/default.
`binaryMode`	boolean	`false`
`cacheEventLog`	boolean	`false`
`channel`	string	`aeron:ipc`	Aeron channel URI (e.g. aeron:ipc or aeron:udp?endpoint=host:port).
`fragmentLimit`	int	`50`
`launchEmbeddedDriver`	boolean	`false`
`mode`	enum	`LIVE`	`LIVE` \| `ARCHIVE`
`replayChannel`	string	`aeron:ipc`
`streamId`	int	`10`	Aeron stream id.

AeronMessageSink `connector-aeron` · sink¶

Publish messages to an Aeron stream.

Class: com.telamin.mongoose.plugin.connector.aeron.AeronMessageSink
YAML: eventSinks: → instance:

Field	Type	Default	Allowed / notes
`aeronDirectoryName`	string		format: path Aeron media-driver directory; blank = embedded/default.
`channel`	string	`aeron:ipc`	Aeron channel URI.
`initialBufferCapacity`	int	`4096`
`launchEmbeddedDriver`	boolean	`false`
`offerTimeoutNanos`	long	`2000000000`
`streamId`	int	`10`	Aeron stream id.

ChronicleEventSource `connector-chronicle` · source¶

Read events from a Chronicle Queue.

Class: com.telamin.mongoose.plugin.connector.chronicle.ChronicleEventSource
YAML: eventFeeds: → instance:

Field	Type	Required	Default	Allowed / notes
`cacheEventLog`	boolean		`false`
`chroniclePath`	string	✔		format: path Chronicle Queue directory to read from.
`readStrategy`	enum		`COMMITED`	`COMMITED` \| `EARLIEST` \| `LATEST` How much of the queue to replay on start.

ChronicleMessageSink `connector-chronicle` · sink¶

Append messages to a Chronicle Queue.

Class: com.telamin.mongoose.plugin.connector.chronicle.ChronicleMessageSink
YAML: eventSinks: → instance:

Field	Type	Required	Default	Allowed / notes
`chroniclePath`	string	✔		format: path Chronicle Queue directory to append to.

MulticastEventSource `connector-multicast` · source¶

Receive events over UDP multicast.

Class: com.telamin.mongoose.plugin.connector.multicast.MulticastEventSource
YAML: eventFeeds: → instance:

Field	Type	Required	Default	Allowed / notes
`cacheEventLog`	boolean		`false`
`multicastGroup`	string	✔	`224.0.0.1`	Multicast group address (e.g. 224.0.0.1).
`multicastPort`	int	✔	`4446`	format: port Multicast port.
`networkInterfaceName`	string			NIC to bind; blank = default route.
`useLoopbackInterface`	boolean		`false`

MulticastMessageSink `connector-multicast` · sink¶

Send messages over UDP multicast.

Class: com.telamin.mongoose.plugin.connector.multicast.MulticastMessageSink
YAML: eventSinks: → instance:

Field	Type	Required	Default	Allowed / notes
`multicastGroup`	string	✔	`224.0.0.1`	Multicast group address.
`multicastPort`	int	✔	`4446`	format: port Multicast port.
`networkInterfaceName`	string			NIC to bind; blank = default route.
`useLoopbackInterface`	boolean		`false`

Services¶

JsonFileCache `svc-cache` · service¶

JSON-persistent key/value cache service.

Class: com.telamin.mongoose.plugin.svc.cache.JsonFileCache
YAML: services: → service:

Field	Type	Required	Default	Allowed / notes
`asyncWrite`	boolean		`false`	Flush writes on a background thread.
`fileName`	string	✔		format: path Backing JSON file path.
`maxSize`	int		`0`	0 = unbounded; >0 enables LRU eviction.

JdbcConnectionLoaderService `svc-jdbc` · service¶

Named JDBC connection registry (HikariCP-backed).

Class: com.telamin.mongoose.plugin.svc.jdbc.impl.JdbcConnectionLoaderService
YAML: services: → service:

Field	Type	Required	Default	Allowed / notes
`connections`	map<string,nested>	✔	`{}`	Named JDBC connections (name → pool config: url, user, password, sizing). object — see below
`fastFail`	boolean		`false`	Fail boot if a startup connectivity test fails.
`testConnection`	boolean		`false`	Run a validation query for each pool at startup.

connections value object:

Field	Type	Default
`connectionTimeoutMs`	long	`30000`
`idleTimeoutMs`	long	`600000`
`maxLifetimeMs`	long	`1800000`
`maximumPoolSize`	int	`10`
`minimumIdle`	int	`0`
`password`	string
`poolName`	string
`pooled`	boolean	`true`
`url`	string
`username`	string
`validationQuery`	string

MicrometerBridge `svc-micrometer` · service¶

Bridge Mongoose counters to a Micrometer registry.

Class: com.telamin.mongoose.plugin.svc.micrometer.MicrometerBridge
YAML: services: → service:

Field	Type	Default	Allowed / notes
`counterPrefix`	string	`mongoose`
`latencyPrefix`	string	`mongoose.latency`
`sampleIntervalMs`	long	`1000`	format: millis How often counters are pushed to the registry.

TelnetAdminCommandProcessor `svc-admin-telnet` · service¶

Telnet admin endpoint (JLine completion + history).

Class: com.telamin.mongoose.plugin.svc.admintelnet.TelnetAdminCommandProcessor
YAML: services: → service:

Field	Type	Required	Default	Allowed / notes
`interfaceName`	string		`127.0.0.1`	format: host Bind address; loopback by default.
`listenPort`	int		`2019`	format: port Telnet listen port.

JavalinAdminCommandService `svc-admin-rest` · service¶

Javalin REST admin endpoint.

Class: com.telamin.mongoose.plugin.svc.adminrest.JavalinAdminCommandService
YAML: services: → service:

Field	Type	Default	Allowed / notes
`authMode`	enum	`NONE`	`NONE` \| `BASIC` \| `BEARER` NONE \| BASIC \| BEARER.
`bearerToken`	string		BEARER credential ($ENV. resolvable).
`host`	string	`0.0.0.0`	format: host Bind address (0.0.0.0 = all interfaces — front with TLS).
`listenPort`	int	`8080`	format: port
`password`	string		BASIC credential ($ENV. resolvable).
`realm`	string	`mongoose-admin`
`staticDir`	string		format: path Optional static SPA directory to host.
`username`	string		BASIC credential ($ENV. resolvable).

WebAdminService `svc-admin-web` · service¶

Browser admin & monitoring console (REST + WebSocket + SPA).

Class: com.telamin.mongoose.plugin.svc.adminweb.WebAdminService
YAML: services: → service:

Field	Type	Default	Allowed / notes
`authMode`	enum	`NONE`	`NONE` \| `BASIC` \| `BEARER` NONE \| BASIC \| BEARER.
`basePath`	string
`bearerToken`	string		BEARER credential ($ENV. resolvable).
`graphmlRoots`	list<string>	`[]`	Dirs the processor-graph panel reads .graphml from.
`host`	string	`127.0.0.1`	format: host Bind address; loopback by default — front with TLS for multi-host.
`listenPort`	int	`8181`	format: port
`loaderBaseDir`	string		format: path Root for the loader file picker; unset disables it.
`logTailBuffer`	int	`500`	Max retained log records for the log tail.
`metricsIntervalMs`	int	`1000`	format: millis JVM/throughput sampler period.
`password`	string		BASIC credential ($ENV. resolvable).
`realm`	string	`mongoose-admin`
`sessionMinutes`	int	`60`	Session cookie lifetime.
`sessionSecret`	string		HMAC key for session cookies ($ENV. resolvable); pin to survive restarts.
`sourceRoots`	list<string>	`[]`	Dirs the node-source viewer reads .java from.
`username`	string		BASIC credential ($ENV. resolvable).

EventHandlerLoader `svc-loader-yaml` · service¶

Load/reload processors at runtime from YAML or Java source.

Class: com.telamin.mongoose.plugin.loader.yaml.EventHandlerLoader
YAML: services: → service:

Field	Type	Default	Allowed / notes
`generatedResourcesDir`	string		format: path
`generatedSourceDir`	string		format: path
`loadAtStartup`	list<nested>	`[]`	Descriptors to compile + load at boot. object — see below
`packageName`	string	`com.telamin.mongoose.runtime.loaded.yaml`
`persistentConfigDir`	string		format: path

loadAtStartup element object:

Field	Type	Default
`addEventAuditor`	boolean	`false`
`compile`	boolean	`true`
`group`	string	`yamlLoader`
`yamlFile`	string

SpringEventHandlerLoader `svc-loader-spring` · service¶

Load/reload processors at runtime from Spring XML.

Class: com.telamin.mongoose.plugin.loader.spring.SpringEventHandlerLoader
YAML: services: → service:

Field	Type	Default	Allowed / notes
`generatedResourcesDir`	string		format: path
`generatedSourceDir`	string		format: path
`loadAtStartup`	list<nested>	`[]`	Spring files to load at boot. object — see below
`packageName`	string	`com.telamin.mongoose.runtime.loaded.spring`
`persistentConfigDir`	string		format: path

loadAtStartup element object:

Field	Type	Default
`addEventAuditor`	boolean	`true`
`compile`	boolean	`true`
`group`	string	`springBeanLoader`
`springFile`	string

FeedLoader `svc-loader-feed` · service¶

Add/remove event feeds at runtime.

Class: com.telamin.mongoose.plugin.loader.feed.FeedLoader
YAML: services: → service:

Field	Type	Required	Default	Allowed / notes
`persistentConfigDir`	string			format: path Where runtime-added feed configs are persisted.

SinkLoader `svc-loader-sink` · service¶

Add/remove event sinks at runtime.

Class: com.telamin.mongoose.plugin.loader.sink.SinkLoader
YAML: services: → service:

Field	Type	Required	Default	Allowed / notes
`persistentConfigDir`	string			format: path Where runtime-added sink configs are persisted.

Connector & service config reference¶

Connectors¶

FileEventSource mongoose · source¶

FileMessageSink mongoose · sink¶

InMemoryEventSource mongoose · source¶

InMemoryMessageSink mongoose · sink¶

FileEventSource connector-file · source¶

FileMessageSink connector-file · sink¶

KafkaMessageConsumer connector-kafka · source¶

KafkaMessagePublisher connector-kafka · sink¶

AeronArchiveEventSource connector-aeron · source¶

AeronMessageSink connector-aeron · sink¶

ChronicleEventSource connector-chronicle · source¶

ChronicleMessageSink connector-chronicle · sink¶

MulticastEventSource connector-multicast · source¶

MulticastMessageSink connector-multicast · sink¶