reactor.core.spec.support

Class DispatcherComponentSpec<SPEC extends DispatcherComponentSpec<SPEC,TARGET>,TARGET>

java.lang.Object

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

Type Parameters:

SPEC - The DispatcherComponentSpec subclass

TARGET - The type that this spec will create

All Implemented Interfaces:

Supplier<TARGET>

Direct Known Subclasses:

ComposableSpec, EventRoutingComponentSpec

public abstract class DispatcherComponentSpec<SPEC extends DispatcherComponentSpec<SPEC,TARGET>,TARGET>
extends java.lang.Object
implements Supplier<TARGET>

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

Constructor Summary

Constructors

Constructor and Description
DispatcherComponentSpec()

Method Summary

Modifier and Type	Method and Description
SPEC	actorSystem(Function<java.lang.Object,Dispatcher> actorMapper) Configures the component to use an ActorDispatcher.
SPEC	actorSystem(java.lang.String name) Configures the component to use an Environment based ActorDispatcher.
protected abstract TARGET	configure(Dispatcher dispatcher, Environment environment)
SPEC	defaultDispatcher() Configures the component to use the configured Environment's default dispatcher
SPEC	dispatcher(Dispatcher dispatcher) Configures the component to use the given dispatcher
SPEC	dispatcher(java.lang.String dispatcherName) Configures the component to the dispatcher in the configured Environment with the given dispatcherName
SPEC	env(Environment env) Configures the spec, and potentially the component being configured, to use the given environment
TARGET	get() Get an object.
SPEC	synchronousDispatcher() Configures the component to use a synchronous dispatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatcherComponentSpec

public DispatcherComponentSpec()

Method Detail

env

public final SPEC env(Environment env)

Configures the spec, and potentially the component being configured, to use the given environment

Parameters:

env - The environment to use

Returns:

this

actorSystem

public final SPEC actorSystem(java.lang.String name)

Configures the component to use an Environment based ActorDispatcher. An Actor Dispatcher assigns a unique key to a dispatcher provided by a mapping function. In this case, each Dispatcher mapper call will delegate to Environment.getDispatcher(String), returning a new dispatcher from the pool using round robin selection.

Parameters:

name - The dispatcher to use

Returns:

this

Throws:

java.lang.IllegalStateException - if no Environment has been configured

See Also:

Environment.getDefaultDispatcher(), env(Environment)

actorSystem

public final SPEC actorSystem(Function<java.lang.Object,Dispatcher> actorMapper)

Configures the component to use an ActorDispatcher. An Actor Dispatcher assigns a unique key to a dispatcher provided by a mapping function.

Parameters:

actorMapper - The dispatcher to use

Returns:

this

Throws:

java.lang.IllegalStateException - if no Environment has been configured

See Also:

Environment.getDefaultDispatcher(), env(Environment)

defaultDispatcher

public final SPEC defaultDispatcher()

Configures the component to use the configured Environment's default dispatcher

Returns:

this

Throws:

java.lang.IllegalStateException - if no Environment has been configured

See Also:

Environment.getDefaultDispatcher(), env(Environment)

synchronousDispatcher

public final SPEC synchronousDispatcher()

Configures the component to use a synchronous dispatcher

Returns:

this

dispatcher

public final SPEC dispatcher(Dispatcher dispatcher)

Configures the component to use the given dispatcher

Parameters:

dispatcher - The dispatcher to use

Returns:

this

dispatcher

public final SPEC dispatcher(java.lang.String dispatcherName)

Configures the component to the dispatcher in the configured Environment with the given dispatcherName

Parameters:

dispatcherName - The name of the dispatcher

Returns:

this

Throws:

java.lang.IllegalStateException - if no Environment has been configured

See Also:

Environment.getDispatcher(String), env(Environment)

get

public final TARGET get()

Description copied from interface: Supplier

Get an object.

Specified by:

get in interface Supplier<TARGET>

Returns:

An object.

configure

protected abstract TARGET configure(Dispatcher dispatcher,
                                    Environment environment)