io.spine.server.event

Class AbstractStatefulReactor<I,S extends com.google.protobuf.Message,B extends io.spine.protobuf.ValidatingBuilder<S>>

java.lang.Object

io.spine.server.event.AbstractEventReactor

io.spine.server.event.AbstractStatefulReactor<I,S,B>

All Implemented Interfaces:

MessageDispatcher<EventClass,EventEnvelope>, MulticastDispatcher<EventClass,EventEnvelope>, EventDispatcher, EventReactor, EventReceiver, EventProducer

Direct Known Subclasses:

CatchUpProcess

public abstract class AbstractStatefulReactor<I,S extends com.google.protobuf.Message,B extends io.spine.protobuf.ValidatingBuilder<S>>
extends AbstractEventReactor

An abstract base for AbstractEventReactors which have state and require delivering the messages through an Inbox.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStatefulReactor(io.spine.type.TypeUrl stateType) Creates a new instance of the reactor and initializes the Inbox for it.

Method Summary

Modifier and Type	Method and Description
protected B	builder() Returns the current state as a ValidatingBuilder for the respective message.
void	dispatch(EventEnvelope event) Dispatches the message contained in the passed envelope.
protected void	flushState() Immediately writes the changes made to the current builder to the storage.
protected abstract java.util.Optional<S>	load(I id) Loads the state from the storage by ID.
protected abstract B	newStateBuilderWith(I id) Creates a new instance of the respective state ValidatingBuilder and sets the passed identifier to it.
protected abstract com.google.common.collect.ImmutableSet<I>	route(EventEnvelope event) Selects the target to which the event should be dispatched.
protected abstract void	store(S updatedState) Stores the passed state in the storage.

Methods inherited from class io.spine.server.event.AbstractEventReactor

domesticEventClasses, externalEventClasses, isRegistered, messageClasses, producedEvents, producerId, registerWith, version

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.EventProducer

nothing

Methods inherited from interface io.spine.server.event.EventDispatcher

dispatchesEvents, dispatchesExternalEvents, eventClasses

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

canDispatch

Constructor Detail

AbstractStatefulReactor

protected AbstractStatefulReactor(io.spine.type.TypeUrl stateType)

Creates a new instance of the reactor and initializes the Inbox for it.

Method Detail

builder

protected B builder()

Returns the current state as a ValidatingBuilder for the respective message.

dispatch

@CanIgnoreReturnValue
public void dispatch(EventEnvelope event)

Description copied from interface: MessageDispatcher

Dispatches the message contained in the passed envelope.

Specified by:

dispatch in interface MessageDispatcher<EventClass,EventEnvelope>

Overrides:

dispatch in class AbstractEventReactor

Parameters:

event - the envelope with the message

load

protected abstract java.util.Optional<S> load(I id)

Loads the state from the storage by ID.

Returns Optional.empty() if there is no such object found.

store

protected abstract void store(S updatedState)

Stores the passed state in the storage.

newStateBuilderWith

protected abstract B newStateBuilderWith(I id)

Creates a new instance of the respective state ValidatingBuilder and sets the passed identifier to it.

flushState

protected final void flushState()

Immediately writes the changes made to the current builder to the storage.

The builder state is validated prior to storing. Any validation exceptions are propagated as-is.

route

protected abstract com.google.common.collect.ImmutableSet<I> route(EventEnvelope event)

Selects the target to which the event should be dispatched.

Parameters:

event - the event to dispatch

Returns:

the set of the target identifiers