reactor.core.spec.support

Class EventRoutingComponentSpec<SPEC extends EventRoutingComponentSpec<SPEC,TARGET>,TARGET>

java.lang.Object

reactor.core.spec.support.DispatcherComponentSpec<SPEC,TARGET>

reactor.core.spec.support.EventRoutingComponentSpec<SPEC,TARGET>

Type Parameters:

SPEC - The DispatcherComponentSpec subclass

TARGET - The type that this spec will create

All Implemented Interfaces:

Supplier<TARGET>

Direct Known Subclasses:

ReactorSpec

public abstract class EventRoutingComponentSpec<SPEC extends EventRoutingComponentSpec<SPEC,TARGET>,TARGET>
extends DispatcherComponentSpec<SPEC,TARGET>

A generic environment-aware class for specifying components that need to be configured with an Environment, Dispatcher, and EventRouter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EventRoutingComponentSpec.EventRoutingStrategy

Constructor Summary

Constructors

Constructor and Description
EventRoutingComponentSpec()

Method Summary

Modifier and Type	Method and Description
SPEC	broadcastEventRouting() Configures the component's EventRouter to broadcast events to all matching consumers
protected TARGET	configure(Dispatcher dispatcher, Environment environment)
protected abstract TARGET	configure(Reactor reactor, Environment environment)
SPEC	consumerInvoker(ConsumerInvoker consumerInvoker) Assigns the component's Consumer Invoker
SPEC	consumerNotFoundHandler(Consumer<java.lang.Object> consumerNotFoundHandler) Configures the callback to invoke if a notification key is sent into this component and there are no consumers registered to respond to it.
SPEC	consumerRegistry(Registry<Consumer<? extends Event<?>>> consumerRegistry) Configures the Registry to use when creating this component.
SPEC	converters(Converter... converters) Configures the component's EventRouter to use the given {code converters}.
SPEC	converters(java.util.List<Converter> converters) Configures the component's EventRouter to use the given {code converters}.
SPEC	dispatchErrorHandler(Consumer<java.lang.Throwable> dispatchErrorHandler) Configures the component's error handler for any errors occurring during dispatch (e.g.
SPEC	eventFilter(Filter filter) Assigns the component's Filter
SPEC	eventRouter(EventRouter router) Assigns the component's EventRouter
SPEC	firstEventRouting() Configures the component's EventRouter to route events to the first of the matching consumers
SPEC	randomEventRouting() Configures the component's EventRouter to route events to one consumer that's randomly selected from that matching consumers
SPEC	roundRobinEventRouting() Configures the component's EventRouter to route events to one consumer selected from the matching consumers using a round-robin algorithm consumers
SPEC	traceEventPath() Configures this component to provide event tracing when dispatching and routing an event.
SPEC	traceEventPath(boolean b) Configures this component to provide or not provide event tracing when dispatching and routing an event.
SPEC	uncaughtErrorHandler(Consumer<java.lang.Throwable> uncaughtErrorHandler) Configures the component's uncaught error handler for any errors that get reported into this component but aren't a direct result of dispatching (e.g.

Methods inherited from class reactor.core.spec.support.DispatcherComponentSpec

actorSystem, actorSystem, defaultDispatcher, dispatcher, dispatcher, env, get, synchronousDispatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

EventRoutingComponentSpec

public EventRoutingComponentSpec()

Method Detail

converters

public final SPEC converters(Converter... converters)

Configures the component's EventRouter to use the given {code converters}.

Parameters:

converters - The converters to be used by the event router

Returns:

this

converters

public final SPEC converters(java.util.List<Converter> converters)

Configures the component's EventRouter to use the given {code converters}.

Parameters:

converters - The converters to be used by the event router

Returns:

this

eventFilter

public final SPEC eventFilter(Filter filter)

Assigns the component's Filter

Returns:

this

consumerInvoker

public final SPEC consumerInvoker(ConsumerInvoker consumerInvoker)

Assigns the component's Consumer Invoker

Returns:

this

eventRouter

public final SPEC eventRouter(EventRouter router)

Assigns the component's EventRouter

Returns:

this

broadcastEventRouting

public final SPEC broadcastEventRouting()

Configures the component's EventRouter to broadcast events to all matching consumers

Returns:

this

randomEventRouting

public final SPEC randomEventRouting()

Configures the component's EventRouter to route events to one consumer that's randomly selected from that matching consumers

Returns:

this

firstEventRouting

public final SPEC firstEventRouting()

Configures the component's EventRouter to route events to the first of the matching consumers

Returns:

this

roundRobinEventRouting

public final SPEC roundRobinEventRouting()

Configures the component's EventRouter to route events to one consumer selected from the matching consumers using a round-robin algorithm consumers

Returns:

this

dispatchErrorHandler

public SPEC dispatchErrorHandler(Consumer<java.lang.Throwable> dispatchErrorHandler)

Configures the component's error handler for any errors occurring during dispatch (e.g. Exceptions resulting from calling a Consumer#accept method.

Parameters:

dispatchErrorHandler - the error handler for dispatching errors

Returns:

this

uncaughtErrorHandler

public SPEC uncaughtErrorHandler(Consumer<java.lang.Throwable> uncaughtErrorHandler)

Configures the component's uncaught error handler for any errors that get reported into this component but aren't a direct result of dispatching (e.g. errors that originate from another component).

Parameters:

uncaughtErrorHandler - the error handler for uncaught errors

Returns:

this

traceEventPath

public final SPEC traceEventPath()

Configures this component to provide event tracing when dispatching and routing an event.

Returns:

this

traceEventPath

public final SPEC traceEventPath(boolean b)

Configures this component to provide or not provide event tracing when dispatching and routing an event.

Parameters:

b - whether to trace the event path or not

Returns:

this

consumerRegistry

public SPEC consumerRegistry(Registry<Consumer<? extends Event<?>>> consumerRegistry)

Configures the Registry to use when creating this component. Registries can be shared to reduce GC pressure and potentially be persisted across restarts.

Parameters:

consumerRegistry - the consumer registry to use

Returns:

this

consumerNotFoundHandler

public SPEC consumerNotFoundHandler(Consumer<java.lang.Object> consumerNotFoundHandler)

Configures the callback to invoke if a notification key is sent into this component and there are no consumers registered to respond to it.

Parameters:

consumerNotFoundHandler - the not found handler to use

Returns:

this

configure

protected abstract TARGET configure(Reactor reactor,
                                    Environment environment)

configure

protected final TARGET configure(Dispatcher dispatcher,
                                 Environment environment)

Specified by:

configure in class DispatcherComponentSpec<SPEC extends EventRoutingComponentSpec<SPEC,TARGET>,TARGET>