io.spine.server.command

Class AbstractCommander

java.lang.Object

io.spine.server.command.AbstractCommandDispatcher

io.spine.server.command.AbstractCommander

All Implemented Interfaces:

MessageDispatcher<CommandClass,CommandEnvelope>, UnicastDispatcher<CommandClass,CommandEnvelope>, Commander, CommandReceiver, CommandDispatcher, EventReceiver, EventProducer

public abstract class AbstractCommander
extends AbstractCommandDispatcher
implements Commander

The abstract base for classes that generate commands in response to incoming messages.

Constructor Summary

Constructors

Constructor and Description
AbstractCommander()

Method Summary

Modifier and Type	Method and Description
void	dispatch(CommandEnvelope command) Dispatches the message contained in the passed envelope.
void	dispatchEvent(EventEnvelope event)
com.google.common.collect.ImmutableSet<EventClass>	domesticEvents()
com.google.common.collect.ImmutableSet<EventClass>	events()
com.google.common.collect.ImmutableSet<EventClass>	externalEvents()
com.google.common.collect.ImmutableSet<CommandClass>	messageClasses() Obtains a set of message classes that can be processed by this dispatcher.
com.google.common.collect.ImmutableSet<EventClass>	producedEvents() Obtains classes of the events produced by this object.
void	registerWith(BoundedContext context)
io.spine.core.Version	version() The version of the object to be put into events.

Methods inherited from class io.spine.server.command.AbstractCommandDispatcher

equals, hashCode, id, isRegistered, onError, onRejection, postEvents, producerId

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.server.command.Commander

doNothing

Methods inherited from interface io.spine.server.EventProducer

nothing, producerId

Methods inherited from interface io.spine.server.commandbus.CommandDispatcher

dispatchesCommands

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

canDispatch

Constructor Detail

AbstractCommander

public AbstractCommander()

Method Detail

registerWith

public void registerWith(BoundedContext context)

Overrides:

registerWith in class AbstractCommandDispatcher

messageClasses

public com.google.common.collect.ImmutableSet<CommandClass> 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<CommandClass,CommandEnvelope>

Returns:

non-empty set of message classes

dispatch

@CanIgnoreReturnValue
public void dispatch(CommandEnvelope command)

Description copied from interface: MessageDispatcher

Dispatches the message contained in the passed envelope.

Specified by:

dispatch in interface MessageDispatcher<CommandClass,CommandEnvelope>

Parameters:

command - the envelope with the message

events

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

externalEvents

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

domesticEvents

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

dispatchEvent

public void dispatchEvent(EventEnvelope event)

version

public io.spine.core.Version version()

The version of the object to be put into events.

If empty, no version will be added to the generated events.

Always returns a version with number 0 and current time.

Specified by:

version in interface EventProducer

producedEvents

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

Obtains classes of the events produced by this object.

Always returns an empty set.

Specified by:

producedEvents in interface EventProducer