io.spine.server.route

Class EventRouting<I>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

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

public final class EventRouting<I>
extends java.lang.Object
implements EventRoute<I,io.spine.base.EventMessage>

A routing schema used to deliver events.

A routing schema consists of a default route and custom routes per event class. When calculating a set of event targets, EventRouting will see if there is a custom route set for the type of the event. 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.
EventRoute<I,io.spine.base.EventMessage>	defaultRoute() Obtains the default route used by the schema.
<M extends io.spine.base.EventMessage> java.util.Optional<EventRoute<I,M>>	get(java.lang.Class<M> eventClass) Obtains a route for the passed event class.
void	remove(java.lang.Class<? extends M> messageClass) Removes a route for the passed message class.
EventRouting<I>	replaceDefault(EventRoute<I,io.spine.base.EventMessage> newDefault) Sets new default route in the schema.
<E extends io.spine.base.EventMessage> EventRouting<I>	route(java.lang.Class<E> eventType, EventRoute<I,? super E> via) Sets a custom route for the passed event type.
EventRouting<I>	routeStateUpdates(StateUpdateRouting<I> routing) Sets a custom routing schema for entity state updates.
boolean	supports(java.lang.Class<? extends M> messageType) Checks if the passed message type is supported by this instance of routing.
<E extends io.spine.base.EventMessage> EventRouting<I>	unicast(java.lang.Class<E> eventType, java.util.function.BiFunction<E,io.spine.core.EventContext,I> via) Sets a custom route for the passed event type by obtaining the target entity ID from the passed function over event message and its context.
<E extends io.spine.base.EventMessage> EventRouting<I>	unicast(java.lang.Class<E> eventType, java.util.function.Function<E,I> via) Sets a custom route for the passed event type by obtaining the target entity ID from the passed function.
static <I> EventRouting<I>	withDefault(EventRoute<I,io.spine.base.EventMessage> defaultRoute) Creates a new event routing with the passed default route.
static <I> EventRouting<I>	withDefaultByProducerId() Creates a new event routing with the default one by event producer ID.

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.route.EventRoute

byFirstMessageField, byProducerId, noTargets, withId

Methods inherited from interface io.spine.server.route.Route

apply

Methods inherited from interface java.util.function.BiFunction

andThen

Method Detail

withDefault

@CanIgnoreReturnValue
public static <I> EventRouting<I> withDefault(EventRoute<I,io.spine.base.EventMessage> defaultRoute)

Creates a new event routing with the passed default route.

Type Parameters:

I - the type of entity identifiers returned by new routing

Parameters:

defaultRoute - the default route

Returns:

new routing instance

withDefaultByProducerId

public static <I> EventRouting<I> withDefaultByProducerId()

Creates a new event routing with the default one by event producer ID.

See Also:

EventRouting.withDefault(EventRoute), EventRoute.byProducerId()

defaultRoute

public final EventRoute<I,io.spine.base.EventMessage> defaultRoute()

Obtains the default route used by the schema.

Overrides for return type covariance.

replaceDefault

@CanIgnoreReturnValue
public EventRouting<I> replaceDefault(EventRoute<I,io.spine.base.EventMessage> 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 <E extends io.spine.base.EventMessage> EventRouting<I> route(java.lang.Class<E> eventType,
                                                                                          EventRoute<I,? super E> via)
                                                                                   throws java.lang.IllegalStateException

Sets a custom route for the passed event type.

Such mapping may be required for the following cases:

• An event message should be matched to more than one entity, for example, several projections updated in response to one event.
• The type of an event producer ID (stored in the event context) differs from the type of entity identifiers (<I>.

The type of the event 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(MyEventClass.class, (event, context) -> { ... })
              .route(MyEventInterface.class, (event, context) -> { ... });
 

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

If there is no specific route for an event type, the default route will be used.

Type Parameters:

E - the type of the event message

Parameters:

eventType - the type of events 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 event type is already set either directly or via a super-interface

unicast

@CanIgnoreReturnValue
public <E extends io.spine.base.EventMessage> EventRouting<I> unicast(java.lang.Class<E> eventType,
                                                                                            java.util.function.Function<E,I> via)

Sets a custom route for the passed event type by obtaining the target entity ID from the passed function.

This is a convenience method for configuring routing when an event is to be delivered to only one entity which ID is calculated from the event message. A simplest case of that would be passing a method reference for an accessor of a field of the event message which contains the ID of interest.

Type Parameters:

E - the type of the event message

Parameters:

eventType - the type of the event to route

via - the function for obtaining the target entity ID

Returns:

this to allow chained calls when configuring routing

See Also:

EventRouting.route(Class, EventRoute), EventRouting.unicast(Class, BiFunction)

unicast

@CanIgnoreReturnValue
public <E extends io.spine.base.EventMessage> EventRouting<I> unicast(java.lang.Class<E> eventType,
                                                                                            java.util.function.BiFunction<E,io.spine.core.EventContext,I> via)

Sets a custom route for the passed event type by obtaining the target entity ID from the passed function over event message and its context.

This is a convenience method for configuring routing when an event is to be delivered to only one entity which ID is calculated from the event message and its context.

Type Parameters:

E - the type of the event message

Parameters:

eventType - the type of the event to route

via - the supplier of the target entity ID

Returns:

this to allow chained calls when configuring routing

See Also:

EventRouting.route(Class, EventRoute), EventRouting.unicast(Class, Function)

routeStateUpdates

@CanIgnoreReturnValue
public EventRouting<I> routeStateUpdates(StateUpdateRouting<I> routing)

Sets a custom routing schema for entity state updates.

Parameters:

routing - the routing schema for entity state updates

Returns:

this to allow chained calls when configuring the routing

Throws:

java.lang.IllegalStateException - if a route for EntityStateChanged is already set

get

public <M extends io.spine.base.EventMessage> java.util.Optional<EventRoute<I,M>> get(java.lang.Class<M> eventClass)

Obtains a route for the passed event class.

Type Parameters:

M - the type of the event message

Parameters:

eventClass - the class of the event 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