Skip to content

Listeners Editor

Editor for *.listener artefacts. A listener binds a queue or topic name to a handler module. engine-listeners (ActiveMQ-style message bus) invokes the handler on every incoming message.

Component: editor-listeners. Synchronizer: ListenerSynchronizer.

Artefact shape

json
{
    "name": "sales/orders-created",
    "kind": "Q",
    "handler": "sales/listeners/order-created.ts",
    "description": "Persist new order events"
}
FieldRequiredNotes
nameyesDestination name. Interpreted as a queue name when kind is Q, or a topic name when kind is T.
kindyesQ for QUEUE (point-to-point), T for TOPIC (publish / subscribe).
handleryesRepository path to the handler module. TS / JS via engine-javascript, Java via engine-java.
descriptionnoHuman-readable description.

Editor fields

  • Name - the destination name.
  • Kind - dropdown: QUEUE / TOPIC.
  • Handler - file picker.
  • Description.

Runtime

On synchronization, the listener is registered with the configured message broker. Active listeners are visible in the Listeners view. The handler receives the raw message payload via the platform's listener context.

See also

Released under the EPL-2.0 License.