io.spine.server.bus

Interface MessageDispatcher<C extends io.spine.type.MessageClass,E extends MessageEnvelope>

Type Parameters:

C - the type of class of the dispatched messages

E - the type of the message envelopes

All Known Subinterfaces:

CommandDispatcher, EventDispatcher, MulticastDispatcher<C,E>, UnicastDispatcher<C,E>

All Known Implementing Classes:

AbstractCommandDispatcher, AbstractCommander, AbstractCommandHandler, AbstractEventReactor, AbstractEventSubscriber, AbstractStatefulReactor, AggregatePartRepository, AggregateRepository, CatchUpProcess, EventDispatchingRepository, ProcessManagerRepository, ProjectionRepository

public interface MessageDispatcher<C extends io.spine.type.MessageClass,E extends MessageEnvelope>

A dispatcher of a message.

Method Summary

Modifier and Type	Method and Description
default boolean	canDispatch(E envelope) Checks if this dispatcher can dispatch the given message.
void	dispatch(E envelope) Dispatches the message contained in the passed envelope.
com.google.common.collect.ImmutableSet<C>	messageClasses() Obtains a set of message classes that can be processed by this dispatcher.

Method Detail

messageClasses

com.google.common.collect.ImmutableSet<C> messageClasses()

Obtains a set of message classes that can be processed by this dispatcher.

Returns:

non-empty set of message classes

dispatch

void dispatch(E envelope)

Dispatches the message contained in the passed envelope.

Parameters:

envelope - the envelope with the message

canDispatch

default boolean canDispatch(E envelope)

Checks if this dispatcher can dispatch the given message.

This method does not check that the type of the message is one of the dispatched message classes. Instead, it validates the message upon some custom rules of this dispatcher.

Extend this method to forbid messages from being dispatched to this instance.

Parameters:

envelope - the message to check

Returns:

true is the given message can be dispatched by this dispatcher, false otherwise