server/io.spine.server.route/EventRouting

EventRouting

public final class EventRouting extends MessageRouting<M, C, R> implements EventRoute<I, M>

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.

Parameters

the type of the entity IDs to which events are routed

Functions

defaultRoute

public final EventRoute<I, EventMessage> defaultRoute()

Obtains the default route used by the schema.

get

public Optional<EventRoute<I, M>> get<M extends EventMessage>(Class<M> eventClass)

Obtains a route for the passed event class.

replaceDefault

public EventRouting replaceDefault(EventRoute<I, EventMessage> newDefault)

Sets new default route in the schema.

route

public EventRouting route<E extends EventMessage>(Class<E> eventType, EventRoute<I, ? extends Object> via)

Sets a custom route for the passed event type.

routeStateUpdates

public EventRouting routeStateUpdates(StateUpdateRouting routing)

Sets a custom routing schema for entity state updates.

unicast

public EventRouting unicast<E extends EventMessage>(Class<E> eventType, BiFunction<E, 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.

public EventRouting unicast<E extends EventMessage>(Class<E> eventType, Function<E, I> via)

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

withDefault

public static EventRouting withDefault(EventRoute<I, EventMessage> defaultRoute)

Creates a new event routing with the passed default route.

withDefaultByProducerId

public static EventRouting withDefaultByProducerId()

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

Inherited functions

andThen

public BiFunction<T, U, V> andThen<V>(Function<? extends Object, ? extends V> after)

apply

public R apply(M message, C context)

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

public abstract R apply(T p, U p1)

byFirstMessageField

public static EventRoute<I, EventMessage> byFirstMessageField(Class idClass)

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

byProducerId

public static EventRoute<I, 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.

noTargets

public static Set noTargets()

Returns the empty immutable set.

remove

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

Removes a route for the passed message class.

supports

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

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

withId

public static Set withId(I id)

Creates an immutable singleton set with the passed ID.