Package org.apache.juneau.console.bus

package org.apache.juneau.console.bus

Server half of the console message bus.

A ServerBus holds retained topic values and the sessions that bridge them to pages; a BusPolicy says what may flow, in which direction, to whom (everything else is denied); BusEventsMixin exposes the CSRF-guarded session POST and the capability-gated SSE stream on a REST resource. The WebSocket transport is the separate juneau-console-bus-websocket module.

Example:

@Rest(path="/ops/jobs") public class JobsRest extends BasicRestServlet implements BusEventsMixin { static final ServerBus BUS = ServerBus.create(BusPolicy.create() .downstream("ops.jobs", true).build()); @Override public ServerBus serverBus() { return BUS; } } // Anywhere in the application: JobsRest.BUS.publish("ops.jobs", JsonMap.of("schemaVersion", 1, "running", running));

Since:

10.0.0

Related Packages

Package	Description
org.apache.juneau.console	Engine-agnostic themeable admin-console chrome: Theme, the stock theme stylesheets, the bundled chrome.css asset, and ConsoleChromeMixin.
org.apache.juneau.console.bus.websocket	Jakarta WebSocket 2.2 transport for the console message bus.

Class	Description
BusEventsMixin	Exposes the bus's session POST and SSE stream on a REST resource.
BusFrames	The bus wire format, version 1: one JSON object per frame, in a canonical field order shared with the browser codec and pinned by bus-frames-corpus.json.
BusPolicy	What a ServerBus will carry, in which direction, to whom.
BusPolicy.Builder	Builder for BusPolicy.
BusRefusal	A named refusal from the bus: the session POST's 400/403/429/501 answers and the codec's bus:bad-frame.
BusSession	One page's bridge session.
FrameSink	A transport's outbound side, handed to ServerBus.connect(BusSession, FrameSink) for one connection.
ServerBus	The server half of the console message bus: a retained-value store plus the sessions that bridge it to pages.
UpstreamHandler	Handles one upstream topic (page → server, WebSocket bridges only).