io.spine.server.entity

Class EventDispatchingRepository<I,E extends AbstractEntity<I,S>,S extends io.spine.base.EntityState>

java.lang.Object

io.spine.server.entity.Repository<I,E>

io.spine.server.entity.RecordBasedRepository<I,E,S>

io.spine.server.entity.DefaultRecordBasedRepository<I,E,S>

io.spine.server.entity.EventDispatchingRepository<I,E,S>

All Implemented Interfaces:

io.spine.logging.Logging, MessageDispatcher<EventClass,EventEnvelope>, MulticastDispatcher<EventClass,EventEnvelope>, Closeable, EventDispatcher, java.lang.AutoCloseable

Direct Known Subclasses:

ProcessManagerRepository, ProjectionRepository

public abstract class EventDispatchingRepository<I,E extends AbstractEntity<I,S>,S extends io.spine.base.EntityState>
extends DefaultRecordBasedRepository<I,E,S>
implements EventDispatcher

Abstract base for repositories that deliver events to entities they manage.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventDispatchingRepository()

Method Summary

Modifier and Type	Method and Description
void	dispatch(EventEnvelope event) Dispatches the event to the corresponding entities.
protected abstract void	dispatchTo(I id, io.spine.core.Event event) Dispatches the given event to an entity with the given ID.
void	registerWith(BoundedContext context) Registers itself as an event dispatcher with the parent BoundedContext.
protected java.util.Set<I>	route(EventEnvelope event) Determines the targets of the given event.
protected void	setupEventRouting(EventRouting<I> routing) A callback for derived repository classes to customize routing schema for events.

Methods inherited from class io.spine.server.entity.DefaultRecordBasedRepository

entityFactory, storageConverter

Methods inherited from class io.spine.server.entity.RecordBasedRepository

applyMigration, applyMigration, create, createStorage, find, find, findActive, findOrCreate, iterator, loadAll, loadAll, recordStorage, store, store, toEntity

Methods inherited from class io.spine.server.entity.Repository

checkStorage, close, context, entityClass, entityStateType, eventFilter, hasContext, idClass, index, isOpen, isRegistered, onRegistered, open, storage, storageAssigned

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.event.EventDispatcher

dispatchesEvents, dispatchesExternalEvents, domesticEventClasses, eventClasses, externalEventClasses

Methods inherited from interface io.spine.server.bus.MessageDispatcher

canDispatch, messageClasses

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

Constructor Detail

EventDispatchingRepository

protected EventDispatchingRepository()

Method Detail

registerWith

@OverridingMethodsMustInvokeSuper
public void registerWith(BoundedContext context)

Registers itself as an event dispatcher with the parent BoundedContext.

Overrides:

registerWith in class DefaultRecordBasedRepository<I,E extends AbstractEntity<I,S>,S extends io.spine.base.EntityState>

Parameters:

context - the BoundedContext of this repository

setupEventRouting

protected void setupEventRouting(EventRouting<I> routing)

A callback for derived repository classes to customize routing schema for events.

Default routing returns the ID of the entity which produced the event. This allows to “link” different kinds of entities by having the same class of IDs. More complex scenarios (e.g. one-to-many relationships) may require custom routing schemas.

Parameters:

routing - the routing schema to customize

dispatch

@CanIgnoreReturnValue
public final void dispatch(EventEnvelope event)

Dispatches the event to the corresponding entities.

If there is no stored entity with such an ID, a new one is created and stored after it handles the passed event.

Specified by:

dispatch in interface MessageDispatcher<EventClass,EventEnvelope>

Parameters:

event - the event to dispatch

dispatchTo

protected abstract void dispatchTo(I id,
                                   io.spine.core.Event event)

Dispatches the given event to an entity with the given ID.

Parameters:

id - the target entity ID

event - the event to dispatch

route

protected java.util.Set<I> route(EventEnvelope event)

Determines the targets of the given event.

Parameters:

event - the event to find targets for

Returns:

a set of IDs of projections to dispatch the given event to