io.spine.server.aggregate

Class ImportBus

java.lang.Object

io.spine.server.bus.Bus<T,E,C,D>

io.spine.server.bus.UnicastBus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

io.spine.server.aggregate.ImportBus

All Implemented Interfaces:

io.spine.logging.Logging, Closeable, java.lang.AutoCloseable

public final class ImportBus
extends UnicastBus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

Dispatches events to repositories of aggregates that import these events.

Usage Scenarios

Importing events may be used for registering facts occurred in a legacy or a third-party system, which the Bounded Context translates into facts (events) of its history.

Another scenario is registering facts occurred within a Bounded Context without having intermediate commands or events.

Adding an event to an aggregate history normally requires either a command (handling of which produces the event) or an event (reaction on which may produce the event). Such a command or an event:

1. serves as a dispatched message type which is used as the first argument of the corresponding aggregate handler method;
2. carries the information about the fact we want to remember.

Marking events and ensuring proper routing allows to store aggregate events without having intermediate messages.

Temporal Logic

Importing events through dispatching one or several events is designed for importing of events as they occur.

Importing events which occurred before the events already stored in the aggregate history may result in hard to track bugs, and is not recommended.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportBus.Builder The builder for ImportBus.

Method Summary

Modifier and Type	Method and Description
protected DeadMessageHandler<EventEnvelope>	deadMessageHandler() Obtains the instance of DeadMessageHandler for this bus.
protected void	dispatch(EventEnvelope event) Passes the given envelope for dispatching.
static ImportBus.Builder	newBuilder() Creates a builder for creating a new ImportBus.
protected io.spine.server.aggregate.ImportBus.Registry	registry() Obtains the dispatcher registry.
protected void	store(java.lang.Iterable<io.spine.core.Event> events) Updates the TenantIndex with the ID obtained from the passed events.
protected EventEnvelope	toEnvelope(io.spine.core.Event wrapper) Packs the given message of type T into an envelope of type E.
protected EnvelopeValidator<EventEnvelope>	validator() Obtains the instance of EnvelopeValidator for this bus.

Methods inherited from class io.spine.server.bus.UnicastBus

dispatcherOf

Methods inherited from class io.spine.server.bus.Bus

close, hasFilter, hasListener, isOpen, onDispatched, onDispatchingStarted, post, post, prepareObserver, register, setupFilters, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.spine.server.Closeable

checkOpen

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Method Detail

newBuilder

public static ImportBus.Builder newBuilder()

Creates a builder for creating a new ImportBus.

deadMessageHandler

protected DeadMessageHandler<EventEnvelope> deadMessageHandler()

Description copied from class: Bus

Obtains the instance of DeadMessageHandler for this bus.

Specified by:

deadMessageHandler in class Bus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

validator

protected EnvelopeValidator<EventEnvelope> validator()

Description copied from class: Bus

Obtains the instance of EnvelopeValidator for this bus.

Specified by:

validator in class Bus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

toEnvelope

protected EventEnvelope toEnvelope(io.spine.core.Event wrapper)

Description copied from class: Bus

Packs the given message of type T into an envelope of type E.

Specified by:

toEnvelope in class Bus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

Parameters:

wrapper - the message to pack

Returns:

new envelope with the given message inside

dispatch

protected void dispatch(EventEnvelope event)

Description copied from class: Bus

Passes the given envelope for dispatching.

Finds and invokes the MessageDispatcher(s) for the given message.

This method assumes that the given message has passed the filtering.

Specified by:

dispatch in class Bus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

See Also:

for the public API

registry

protected io.spine.server.aggregate.ImportBus.Registry registry()

Description copied from class: Bus

Obtains the dispatcher registry.

Overrides:

registry in class Bus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

store

protected void store(java.lang.Iterable<io.spine.core.Event> events)

Updates the TenantIndex with the ID obtained from the passed events.

Specified by:

store in class Bus<io.spine.core.Event,EventEnvelope,EventClass,EventImportDispatcher<?>>

Parameters:

events - the messages to store