Package su.onno.cluster

Interface ClusterEvent

All Known Implementing Classes:

ClusterEvent.EntityChanged, ClusterEvent.Notification, ClusterEvent.Presence, ClusterEvent.ProcessTasksChanged

public sealed interface ClusterEvent
permits ClusterEvent.EntityChanged, ClusterEvent.Presence, ClusterEvent.Notification, ClusterEvent.ProcessTasksChanged

Wire form of a cross-node notice carried by a ClusterEventBus.

It is a sealed family discriminated by kind(): each permitted variant is a distinct payload shape that shares the one bus channel without a wire break. ClusterEvent.EntityChanged mirrors su.onno.events.EntityChangedEvent; future kinds add a sibling record and a new KIND_* tag, and receivers switch on the type.

The variants are kept as plain strings with no Jackson annotations so the core module stays free of spring-context and Jackson — the ClusterEventBus implementation owns the JSON encoding, writing the kind() tag explicitly so a receiver can pick the right variant (see PostgresClusterEventBus).

originNodeId() is the id of the node that published the event. A bus delivers an event back to its own subscribers (Postgres NOTIFY echoes to the publisher's LISTEN), so receivers drop events whose origin equals their own node id: the originating node already fanned the change out to its local SSE clients synchronously.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ClusterEvent.EntityChanged	An entity create/update/delete/post notice mirroring the fields of su.onno.events.EntityChangedEvent.
static final record	ClusterEvent.Notification	A per-user notification raised on one node whose recipient may be connected to another.
static final record	ClusterEvent.Presence	A user-presence notice for record-level collaboration markers: one user has entered, refreshed, or left the live view of a specific record.
static final record	ClusterEvent.ProcessTasksChanged	A process mutation changed which task rows are visible to one or more users or roles.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KIND_ENTITY_CHANGED	kind() tag for an ClusterEvent.EntityChanged notice mirroring EntityChangedEvent.
static final String	KIND_NOTIFICATION	kind() tag for a ClusterEvent.Notification notice — a per-user notification to wake on a peer node.
static final String	KIND_PRESENCE	kind() tag for a ClusterEvent.Presence notice — a user entering/leaving a record's live view.
static final String	KIND_PROCESS_TASKS_CHANGED	kind() tag for an audience-scoped process-task inbox invalidation.

Method Summary

Modifier and Type	Method	Description
static ClusterEvent.EntityChanged	entityChanged(String changeType, String entityType, String entityName, String id, String naturalKey)	Build an ClusterEvent.EntityChanged event with no originNodeId() set — the publishing ClusterEventBus stamps that during ClusterEventBus.publish(su.onno.cluster.ClusterEvent).
String	kind()	The payload-shape tag identifying which permitted variant this event is.
static ClusterEvent.Notification	notification(String recipientId, String notificationId, String type, String title, String body, String link, String actorName)	Build a ClusterEvent.Notification event with no originNodeId() set — the publishing ClusterEventBus stamps that during ClusterEventBus.publish(su.onno.cluster.ClusterEvent).
String	originNodeId()	The publishing node's id, used by receivers to filter out their own echoes.
static ClusterEvent.Presence	presence(String action, String entityType, String entityName, String id, String userId, String displayName, String avatarUrl)	Build a ClusterEvent.Presence event with no originNodeId() set — the publishing ClusterEventBus stamps that during ClusterEventBus.publish(su.onno.cluster.ClusterEvent).
static ClusterEvent.ProcessTasksChanged	processTasksChanged(String instanceId, Set<String> audienceUsers, Set<String> audienceRoles)	Build an audience-scoped process-task inbox invalidation.
ClusterEvent	withOrigin(String originNodeId)	A copy of this event with originNodeId() set — used by a bus to stamp its identity on send.

Field Details

KIND_ENTITY_CHANGED

static final String KIND_ENTITY_CHANGED

kind() tag for an ClusterEvent.EntityChanged notice mirroring EntityChangedEvent.

See Also:

• Constant Field Values

KIND_PRESENCE

static final String KIND_PRESENCE

kind() tag for a ClusterEvent.Presence notice — a user entering/leaving a record's live view.

See Also:

• Constant Field Values

KIND_NOTIFICATION

static final String KIND_NOTIFICATION

kind() tag for a ClusterEvent.Notification notice — a per-user notification to wake on a peer node.

See Also:

• Constant Field Values

KIND_PROCESS_TASKS_CHANGED

static final String KIND_PROCESS_TASKS_CHANGED

kind() tag for an audience-scoped process-task inbox invalidation.

See Also:

• Constant Field Values

Method Details

kind

String kind()

The payload-shape tag identifying which permitted variant this event is.

originNodeId

String originNodeId()

The publishing node's id, used by receivers to filter out their own echoes. null until the publishing ClusterEventBus stamps it via withOrigin(String) on publish.

withOrigin

ClusterEvent withOrigin(String originNodeId)

A copy of this event with originNodeId() set — used by a bus to stamp its identity on send.

entityChanged

static ClusterEvent.EntityChanged entityChanged(String changeType,
 String entityType,
 String entityName,
 String id,
 String naturalKey)

Build an ClusterEvent.EntityChanged event with no originNodeId() set — the publishing ClusterEventBus stamps that during ClusterEventBus.publish(su.onno.cluster.ClusterEvent). This is the form the change-relay constructs, so it never needs to know the local node id.

presence

static ClusterEvent.Presence presence(String action,
 String entityType,
 String entityName,
 String id,
 String userId,
 String displayName,
 String avatarUrl)

Build a ClusterEvent.Presence event with no originNodeId() set — the publishing ClusterEventBus stamps that during ClusterEventBus.publish(su.onno.cluster.ClusterEvent).

notification

static ClusterEvent.Notification notification(String recipientId,
 String notificationId,
 String type,
 String title,
 String body,
 String link,
 String actorName)

Build a ClusterEvent.Notification event with no originNodeId() set — the publishing ClusterEventBus stamps that during ClusterEventBus.publish(su.onno.cluster.ClusterEvent). Carries enough to paint the notification on the recipient's other-node browsers without a refetch; a receiver that gets only recipientId (its richer fields dropped to fit the payload cap) refetches instead.

processTasksChanged

static ClusterEvent.ProcessTasksChanged processTasksChanged(String instanceId,
 Set<String> audienceUsers,
 Set<String> audienceRoles)

Build an audience-scoped process-task inbox invalidation. It carries no task data: eligible browsers re-read their own authenticated inbox from the shared durable store.