io.spine.server.route

Class StateUpdateRouting<I>

java.lang.Object

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

Type Parameters:

I - the type of the entity IDs to which the updates are routed

All Implemented Interfaces:

Route<io.spine.base.EntityState,io.spine.core.EventContext,java.util.Set<I>>, java.io.Serializable, java.util.function.BiFunction<io.spine.base.EntityState,io.spine.core.EventContext,java.util.Set<I>>

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

A routing schema used to deliver entity state updates.

A routing schema consists of a default route and custom routes per entity state class. When calculating targets to be notified on the updated state, StateUpdateRouting would see if there is a custom route set for the type of the entity state. 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.
protected Route<M,C,R>	defaultRoute() Obtains the default route used by the schema.
static <I> StateUpdateRouting<I>	newInstance(java.lang.Class<I> idClass) Creates a new StateUpdateRouting.
void	remove(java.lang.Class<? extends M> messageClass) Removes a route for the passed message class.
<S extends io.spine.base.EntityState> StateUpdateRouting<I>	route(java.lang.Class<S> stateClass, StateUpdateRoute<I,S> via) Sets a custom route for the passed entity state class.
boolean	supports(java.lang.Class<? extends io.spine.base.EntityState> stateType) Verifies if the passed state type can be routed by a custom route, or the message has a field matching the type of identifiers served by this 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> StateUpdateRouting<I> newInstance(java.lang.Class<I> idClass)

Creates a new StateUpdateRouting.

The resulting routing schema has the ignoring default route, i.e. if a custom route is not set, the entity state update is ignored.

Type Parameters:

I - the type of the entity IDs to which the updates are routed

Parameters:

idClass - the class of identifiers served by this routing

Returns:

new StateUpdateRouting

supports

public boolean supports(java.lang.Class<? extends io.spine.base.EntityState> stateType)

Verifies if the passed state type can be routed by a custom route, or the message has a field matching the type of identifiers served by this routing.

route

@CanIgnoreReturnValue
public <S extends io.spine.base.EntityState> StateUpdateRouting<I> route(java.lang.Class<S> stateClass,
                                                                                               StateUpdateRoute<I,S> via)
                                                                                        throws java.lang.IllegalStateException

Sets a custom route for the passed entity state class.

If there is no specific route for the class of the passed entity state, the routing will use the default route.

Type Parameters:

S - the type of the entity state message

Parameters:

stateClass - the class of entity states to route

via - the instance of the route to be used

Returns:

this to allow chained calls when configuring the routing

Throws:

java.lang.IllegalStateException - if the route for this class is already set

defaultRoute

protected Route<M,C,R> defaultRoute()

Obtains the default route used by the schema.

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