Class ReactiveAdapterRegistry
Publisher
to/from various
async/reactive types such as CompletableFuture
, RxJava Flowable
, etc.
This is designed to complement Spring's Reactor Mono
/Flux
support while
also being usable without Reactor, e.g. just for org.reactivestreams
bridging.
By default, depending on classpath availability, adapters are registered for Reactor
(including CompletableFuture
and Flow.Publisher
adapters), RxJava 3,
Kotlin Coroutines' Deferred
(bridged via Reactor) and SmallRye Mutiny 1.x.
- Since:
- 5.0
- Author:
- Rossen Stoyanchev, Sebastien Deleuze, Juergen Hoeller
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
BlockHoundIntegration
for spring-core classes. -
Constructor Summary
ConstructorDescriptionCreate a registry and auto-register default adapters. -
Method Summary
Modifier and TypeMethodDescriptiongetAdapter
(Class<?> reactiveType) Get the adapter for the given reactive type.getAdapter
(Class<?> reactiveType, Object source) Get the adapter for the given reactive type.static ReactiveAdapterRegistry
Return a shared defaultReactiveAdapterRegistry
instance, lazily building it once needed.boolean
Return whether the registry has any adapters.void
registerReactiveType
(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toAdapter, Function<Publisher<?>, Object> fromAdapter) Register a reactive type along with functions to adapt to and from a Reactive StreamsPublisher
.void
registerReactiveTypeOverride
(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toAdapter, Function<Publisher<?>, Object> fromAdapter) Register a reactive type along with functions to adapt to and from a Reactive StreamsPublisher
.
-
Constructor Details
-
ReactiveAdapterRegistry
public ReactiveAdapterRegistry()Create a registry and auto-register default adapters.- See Also:
-
-
Method Details
-
registerReactiveType
public void registerReactiveType(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toAdapter, Function<Publisher<?>, Object> fromAdapter) Register a reactive type along with functions to adapt to and from a Reactive StreamsPublisher
. The function arguments assume that their input is neithernull
norOptional
.This variant registers the new adapter after existing adapters. It will be matched for the exact reactive type if no earlier adapter was registered for the specific type, and it will be matched for assignability in a second pass if no earlier adapter had an assignable type before.
-
registerReactiveTypeOverride
public void registerReactiveTypeOverride(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toAdapter, Function<Publisher<?>, Object> fromAdapter) Register a reactive type along with functions to adapt to and from a Reactive StreamsPublisher
. The function arguments assume that their input is neithernull
norOptional
.This variant registers the new adapter first, effectively overriding any previously registered adapters for the same reactive type. This allows for overriding existing adapters, in particular default adapters.
Note that existing adapters for specific types will still match before an assignability match with the new adapter. In order to override all existing matches, a new reactive type adapter needs to be registered for every specific type, not relying on subtype assignability matches.
-
hasAdapters
public boolean hasAdapters()Return whether the registry has any adapters. -
getAdapter
Get the adapter for the given reactive type.- Returns:
- the corresponding adapter, or
null
if none available
-
getAdapter
@Nullable public ReactiveAdapter getAdapter(@Nullable Class<?> reactiveType, @Nullable Object source) Get the adapter for the given reactive type. Or if a "source" object is provided, its actual type is used instead.- Parameters:
reactiveType
- the reactive type (may benull
if a concrete source object is given)source
- an instance of the reactive type (i.e. to adapt from; may benull
if the reactive type is specified)- Returns:
- the corresponding adapter, or
null
if none available
-