io.spine.server.route

Class CommandRouting<I>

java.lang.Object

io.spine.server.route.CommandRouting<I>

Type Parameters:

I - the type of the entity IDs of this repository

All Implemented Interfaces:

Route<io.spine.base.CommandMessage,io.spine.core.CommandContext,I>, java.io.Serializable, java.util.function.BiFunction<io.spine.base.CommandMessage,io.spine.core.CommandContext,I>

public final class CommandRouting<I>
extends java.lang.Object

A routing schema used by a CommandDispatcher for delivering a command to its handler.

A routing schema consists of a default route and custom routes per command class. When finding a command target, the CommandRouting will see if there is a custom route set for the type of the command. If not found, the default route will be applied.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
R	apply(M message, C context) Obtains IDs of entities to which the passed message should be delivered.
CommandRoute<I,io.spine.base.CommandMessage>	defaultRoute() Obtains the default route used by the schema.
<M extends io.spine.base.CommandMessage> java.util.Optional<CommandRoute<I,M>>	get(java.lang.Class<M> commandClass) Obtains a route for the passed command class.
static <I> CommandRouting<I>	newInstance(java.lang.Class<I> idClass) Creates a new command routing.
void	remove(java.lang.Class<? extends M> messageClass) Removes a route for the passed message class.
CommandRouting<I>	replaceDefault(CommandRoute<I,io.spine.base.CommandMessage> newDefault) Sets new default route in the schema.
<M extends io.spine.base.CommandMessage> CommandRouting<I>	route(java.lang.Class<M> commandType, CommandRoute<I,M> via) Sets a custom route for the passed command type.
boolean	supports(java.lang.Class<? extends M> messageType) Checks if the passed message type is supported by this instance of routing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Method Detail

newInstance

public static <I> CommandRouting<I> newInstance(java.lang.Class<I> idClass)

Creates a new command routing.

Type Parameters:

I - the type of entity identifiers returned by new routing

Parameters:

idClass - the class of target entity identifiers

Returns:

new routing instance

defaultRoute

public final CommandRoute<I,io.spine.base.CommandMessage> defaultRoute()

Obtains the default route used by the schema.

replaceDefault

@CanIgnoreReturnValue
public CommandRouting<I> replaceDefault(CommandRoute<I,io.spine.base.CommandMessage> newDefault)

Sets new default route in the schema.

Parameters:

newDefault - the new route to be used as default

Returns:

this to allow chained calls when configuring the routing

route

@CanIgnoreReturnValue
public <M extends io.spine.base.CommandMessage> CommandRouting<I> route(java.lang.Class<M> commandType,
                                                                                              CommandRoute<I,M> via)
                                                                                       throws java.lang.IllegalStateException

Sets a custom route for the passed command type.

Such mapping may be required for the following cases:

• The first field of the command message is not an ID of the entity which handles the command as required by the default route.
• The command needs to be dispatched to an entity which ID differs from the value set in the first command message field.

The type of the command can be a class or an interface. If a routing schema needs to contain entries for specific classes and an interface that these classes implement, routes for interfaces should be defined after entries for the classes:

 customRouting.route(MyCommandClass.class, (event, context) -> { ... })
              .route(MyCommandInterface.class, (event, context) -> { ... });
 

Defining an entry for an interface and then for the class which implements the interface will result in IllegalStateException.

Type Parameters:

M - the type of the command message

Parameters:

commandType - the type of the command message

via - the route to be used for this type of commands

Returns:

this to allow chained calls when configuring the routing

Throws:

java.lang.IllegalStateException - if the route for this command class is already set either directly or via a super-interface

get

public <M extends io.spine.base.CommandMessage> java.util.Optional<CommandRoute<I,M>> get(java.lang.Class<M> commandClass)

Obtains a route for the passed command class.

Type Parameters:

M - the type of the command message

Parameters:

commandClass - the class of the command messages

Returns:

optionally available route

supports

public boolean supports(java.lang.Class<? extends M> messageType)

Checks if the passed message type is supported by this instance of routing.

remove

public void remove(java.lang.Class<? extends M> messageClass)

Removes a route for the passed message class.

Throws:

java.lang.IllegalStateException - if a custom route for this message class was not previously set

apply

public R apply(M message,
               C context)

Obtains IDs of entities to which the passed message should be delivered.

If there is no function for the passed message applies the default function.

Specified by:

apply in interface Route<M extends com.google.protobuf.Message,C extends io.spine.base.MessageContext,R>

Specified by:

apply in interface java.util.function.BiFunction<M extends com.google.protobuf.Message,C extends io.spine.base.MessageContext,R>

Parameters:

message - the message

context - the message context

Returns:

the set of entity IDs to which the message should be delivered