io.spine.server.event

Class AbstractEventSubscriber

java.lang.Object

io.spine.server.event.AbstractEventSubscriber

All Implemented Interfaces:

MessageDispatcher<EventClass,EventEnvelope>, MulticastDispatcher<EventClass,EventEnvelope>, EventDispatcher, EventReceiver, EventSubscriber

public abstract class AbstractEventSubscriber
extends java.lang.Object
implements EventDispatcher, EventSubscriber

The abstract base for objects that can be subscribed to receive events from EventBus.

Objects may also receive events via EventDispatchers that can be registered with EventBus.

See Also:

Bus.register(MessageDispatcher), Subscribe

Constructor Summary

Constructors

Constructor and Description
AbstractEventSubscriber()

Method Summary

Modifier and Type	Method and Description
boolean	canDispatch(EventEnvelope event) Checks if this dispatcher can dispatch the given message.
void	dispatch(EventEnvelope event) Dispatches the event to the handling method.
com.google.common.collect.ImmutableSet<EventClass>	domesticEventClasses() Obtains classes of domestic events processed by this dispatcher.
com.google.common.collect.ImmutableSet<EventClass>	externalEventClasses() Obtains classes of external events processed by this dispatcher.
protected void	handle(EventEnvelope event) Handles an event dispatched to this subscriber instance.
boolean	isRegistered()
com.google.common.collect.ImmutableSet<EventClass>	messageClasses() Obtains a set of message classes that can be processed by this dispatcher.
void	registerWith(BoundedContext context)

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, eventClasses

Constructor Detail

AbstractEventSubscriber

public AbstractEventSubscriber()

Method Detail

registerWith

public void registerWith(BoundedContext context)

isRegistered

public boolean isRegistered()

dispatch

public final void dispatch(EventEnvelope event)

Dispatches the event to the handling method.

Specified by:

dispatch in interface MessageDispatcher<EventClass,EventEnvelope>

Parameters:

event - the envelope with the event

handle

protected void handle(EventEnvelope event)

Handles an event dispatched to this subscriber instance.

By default, passes the event to the corresponding subscriber method of the entity.

canDispatch

public boolean canDispatch(EventEnvelope event)

Description copied from interface: MessageDispatcher

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.

Specified by:

canDispatch in interface MessageDispatcher<EventClass,EventEnvelope>

Parameters:

event - the message to check

Returns:

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

messageClasses

public com.google.common.collect.ImmutableSet<EventClass> messageClasses()

Description copied from interface: MessageDispatcher

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

Specified by:

messageClasses in interface MessageDispatcher<EventClass,EventEnvelope>

Returns:

non-empty set of message classes

externalEventClasses

public com.google.common.collect.ImmutableSet<EventClass> externalEventClasses()

Description copied from interface: EventDispatcher

Obtains classes of external events processed by this dispatcher.

Specified by:

externalEventClasses in interface EventDispatcher

domesticEventClasses

public com.google.common.collect.ImmutableSet<EventClass> domesticEventClasses()

Description copied from interface: EventDispatcher

Obtains classes of domestic events processed by this dispatcher.

Specified by:

domesticEventClasses in interface EventDispatcher