server/io.spine.server.commandbus/CommandBus

CommandBus

public final class CommandBus extends UnicastBus<T, E, C, D>

Dispatches the incoming commands to the corresponding handler.

Types

Builder

public class Builder extends BusBuilder<B, T, E, C, D>

The Builder for CommandBus.

Functions

deadMessageHandler

protected DeadMessageHandler<CommandEnvelope> deadMessageHandler()

Obtains the instance of DeadMessageHandler for this bus.

dispatch

protected void dispatch(CommandEnvelope command)

Passes the given envelope for dispatching.

initObservers

public void initObservers(EventBus eventBus)

Initializes the immediateRejectionObserver with the passed EventBus.

isMultitenant

public final boolean isMultitenant()

newBuilder

public static CommandBus.Builder newBuilder()

Creates a new Builder for the CommandBus.

prepareObserver

protected StreamObserver<Ack> prepareObserver(Iterable<Command> commands, StreamObserver<Ack> source)

Prepares the given to post messages into this bus.

registeredCommandClasses

public final Set<CommandClass> registeredCommandClasses()

Obtains the view Set of commands that are known to this CommandBus.

registry

protected CommandDispatcherRegistry registry()

Obtains the dispatcher registry.

setupFilters

protected Iterable<BusFilter<CommandEnvelope>> setupFilters(Iterable<BusFilter<CommandEnvelope>> filters)

Places a CommandReceivedTap first and a CommandScheduler last in the filter chain.

store

protected void store(Iterable<Command> commands)

Stores the given messages into the underlying storage.

toEnvelope

protected CommandEnvelope toEnvelope(Command message)

Packs the given message of type T into an envelope of type E.

validator

protected EnvelopeValidator<CommandEnvelope> validator()

Obtains the instance of EnvelopeValidator for this bus.

Inherited functions

checkOpen

public void checkOpen()

Ensures that the object is open.

public void close()

Closes the filters of this bus and unregisters all the dispatchers.

public abstract void close()

dispatcherOf

protected D dispatcherOf(E envelope)

hasFilter

public boolean hasFilter(BusFilter<E> filter)

hasListener

public boolean hasListener(Listener<E> listener)

isOpen

public final boolean isOpen()

Tells if this bus can accept messages for posting.

onDispatched

protected void onDispatched(SignalId signal)

Called after the dispatching of the signal to all of the target dispatchers has been completed.

onDispatchingStarted

protected void onDispatchingStarted(SignalId signal)

Called before the dispatching of the signal with the passed ID is started.

post

public final void post(T message, StreamObserver<Ack> observer)

Posts the message to the bus.

public final void post(Iterable<T> messages, StreamObserver<Ack> observer)

Posts the given messages to the bus.

public void register(D dispatcher)

Registers the passed dispatcher.

unregister

public void unregister(D dispatcher)

Unregisters dispatching for message classes of the passed dispatcher.