io.spine.server.route

Interface EventRoute<I,M extends io.spine.base.EventMessage>

Type Parameters:

I - the type of entity IDs

M - the type of event messages to get IDs from

All Superinterfaces:

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

All Known Implementing Classes:

EventRouting

@FunctionalInterface
public interface EventRoute<I,M extends io.spine.base.EventMessage>
extends Multicast<I,M,io.spine.core.EventContext>

Obtains a set of entity IDs for which to deliver an event.

Method Summary

Modifier and Type	Method and Description
static <I> EventRoute<I,io.spine.base.EventMessage>	byFirstMessageField(java.lang.Class<I> idClass) Creates an event route that obtains event producer ID from an EventContext and returns it as a sole element of the the immutable set.
static <I> EventRoute<I,io.spine.base.EventMessage>	byProducerId() Creates an event route that obtains event producer ID from an EventContext and returns it as a sole element of the immutable set.
static <I> java.util.Set<I>	noTargets() Returns the empty immutable set.
static <I> java.util.Set<I>	withId(I id) Creates an immutable singleton set with the passed ID.

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

apply

Methods inherited from interface java.util.function.BiFunction

andThen

Method Detail

byProducerId

static <I> EventRoute<I,io.spine.base.EventMessage> byProducerId()

Creates an event route that obtains event producer ID from an EventContext and returns it as a sole element of the immutable set.

Type Parameters:

I - the type of the entity IDs to which the event would be routed

Returns:

new route instance

byFirstMessageField

static <I> EventRoute<I,io.spine.base.EventMessage> byFirstMessageField(java.lang.Class<I> idClass)

Creates an event route that obtains event producer ID from an EventContext and returns it as a sole element of the the immutable set.

Type Parameters:

I - the type of the IDs of entities to which the event would be routed

Parameters:

idClass - the class of identifiers

Returns:

new route instance

noTargets

static <I> java.util.Set<I> noTargets()

Returns the empty immutable set.

API Note:

This is a convenience method for ignoring a type of messages when building a routing schema in a repository.

withId

static <I> java.util.Set<I> withId(I id)

Creates an immutable singleton set with the passed ID.

API Note:

This is a convenience method for customizing routing schemas when the target is only one entity.