A registry of adapters to adapt Reactive Streams 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/2.x. If Reactor is not present, a simple Flow.Publisher bridge will be registered.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ReactiveAdapterRegistry.CoroutinesRegistrar
private static class	ReactiveAdapterRegistry.EmptyCompletableFuture<T>
private static class	ReactiveAdapterRegistry.FlowAdaptersRegistrar
private static class	ReactiveAdapterRegistry.MutinyRegistrar
private static class	ReactiveAdapterRegistry.ReactorAdapter ReactiveAdapter variant that wraps adapted Publishers as `Flux` or `Mono` depending on `ReactiveTypeDescriptor#isMultiValue()`.
private static class	ReactiveAdapterRegistry.ReactorRegistrar
private static class	ReactiveAdapterRegistry.RxJava3Registrar
public static class	ReactiveAdapterRegistry.SpringCoreBlockHoundIntegration `BlockHoundIntegration` for spring-core classes.

Field Summary

Modifier and Type	Field and Description
private final List<ReactiveAdapter>	adapters
private static final boolean	kotlinCoroutinesPresent
private static final boolean	mutinyPresent
private static final boolean	reactiveStreamsPresent
private static final boolean	reactorPresent
private static final boolean	rxjava3Present
private static volatile ReactiveAdapterRegistry	sharedInstance

Constructor Summary

Access	Constructor and Description
public	ReactiveAdapterRegistry() Create a registry and auto-register default adapters.

Method Summary

Modifier and Type	Method and Description
private ReactiveAdapter	buildAdapter(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toAdapter, Function<Publisher<?>, Object> fromAdapter)
public ReactiveAdapter	Returns: the corresponding adapter, or `null` if none available getAdapter(Class<?> reactiveType) Get the adapter for the given reactive type.
public ReactiveAdapter	Returns: the corresponding adapter, or `null` if none available getAdapter(Class<?> the reactive type (may be `null` if a concrete source object is given) reactiveType, Object an instance of the reactive type (i.e. to adapt from; may be `null` if the reactive type is specified) source) Get the adapter for the given reactive type.
public static ReactiveAdapterRegistry	Returns: the shared `ReactiveAdapterRegistry` instance getSharedInstance() Return a shared default `ReactiveAdapterRegistry` instance, lazily building it once needed.
public boolean	hasAdapters() Return whether the registry has any adapters.
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 Streams `Publisher`.
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 Streams `Publisher`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

adapters	back to summary
private final List<ReactiveAdapter> adapters

kotlinCoroutinesPresent	back to summary
private static final boolean kotlinCoroutinesPresent

mutinyPresent	back to summary
private static final boolean mutinyPresent

reactiveStreamsPresent	back to summary
private static final boolean reactiveStreamsPresent

reactorPresent	back to summary
private static final boolean reactorPresent

rxjava3Present	back to summary
private static final boolean rxjava3Present

sharedInstance	back to summary
private static volatile ReactiveAdapterRegistry sharedInstance Annotations @Nullable

Constructor Detail

ReactiveAdapterRegistry back to summary

ReactiveAdapterRegistry	back to summary
public ReactiveAdapterRegistry() Create a registry and auto-register default adapters. See Also `getSharedInstance()`

public ReactiveAdapterRegistry()

Create a registry and auto-register default adapters.

See Also: getSharedInstance()

Method Detail

buildAdapter	back to summary
private ReactiveAdapter buildAdapter(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toAdapter, Function<Publisher<?>, Object> fromAdapter)

getAdapter back to summary

getAdapter	back to summary
public ReactiveAdapter getAdapter(Class<?> reactiveType) Get the adapter for the given reactive type. Returns:ReactiveAdapter the corresponding adapter, or `null` if none available Annotations @Nullable

public ReactiveAdapter getAdapter(Class<?> reactiveType)

Get the adapter for the given reactive type.

Returns:ReactiveAdapter

the corresponding adapter, or null if none available

Annotations

@Nullable

getAdapter back to summary

getAdapter	back to summary
public ReactiveAdapter getAdapter(Class<?> reactiveType, 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:Class<?> the reactive type (may be `null` if a concrete source object is given) source:Object an instance of the reactive type (i.e. to adapt from; may be `null` if the reactive type is specified) Returns:ReactiveAdapter the corresponding adapter, or `null` if none available Annotations @Nullable

public ReactiveAdapter getAdapter(Class<?> reactiveType, 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:Class<?>: the reactive type (may be null if a concrete source object is given)
source:Object: an instance of the reactive type (i.e. to adapt from; may be null if the reactive type is specified)

Returns:ReactiveAdapter

the corresponding adapter, or null if none available

Annotations

@Nullable

getSharedInstance back to summary

getSharedInstance	back to summary
public static ReactiveAdapterRegistry getSharedInstance() Return a shared default `ReactiveAdapterRegistry` instance, lazily building it once needed. Note We highly recommend passing a long-lived, pre-configured `ReactiveAdapterRegistry` instance for customization purposes. This accessor is only meant as a fallback for code paths that want to fall back on a default instance if one isn't provided. Returns:ReactiveAdapterRegistry the shared `ReactiveAdapterRegistry` instance Since 5.0.2

public static ReactiveAdapterRegistry getSharedInstance()

Return a shared default ReactiveAdapterRegistry instance, lazily building it once needed.

Note

We highly recommend passing a long-lived, pre-configured ReactiveAdapterRegistry instance for customization purposes. This accessor is only meant as a fallback for code paths that want to fall back on a default instance if one isn't provided.

Returns:ReactiveAdapterRegistry: the shared ReactiveAdapterRegistry instance
Since: 5.0.2

hasAdapters	back to summary
public boolean hasAdapters() Return whether the registry has any adapters.

registerReactiveType back to summary

registerReactiveType	back to summary
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 Streams `Publisher`. The function arguments assume that their input is neither `null` nor `Optional`. 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. See Also `registerReactiveTypeOverride`, `getAdapter`

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 Streams Publisher. The function arguments assume that their input is neither null nor Optional.

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.

See Also: registerReactiveTypeOverride, getAdapter

registerReactiveTypeOverride back to summary

registerReactiveTypeOverride	back to summary
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 Streams `Publisher`. The function arguments assume that their input is neither `null` nor `Optional`. 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. Since 5.3.30 See Also `registerReactiveType`, `getAdapter`

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 Streams Publisher. The function arguments assume that their input is neither null nor Optional.

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.

Since: 5.3.30
See Also: registerReactiveType, getAdapter

org.springframework.core back to summary

private Class ReactiveAdapterRegistry.CoroutinesRegistrar

Class Inheritance

extends Object

java.lang.Object
org.springframework.core.ReactiveAdapterRegistry.CoroutinesRegistrar

Constructor Summary

Access	Constructor and Description
private	CoroutinesRegistrar()

Method Summary

Modifier and Type	Method and Description
pack-priv void	registerAdapters(ReactiveAdapterRegistry registry)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

CoroutinesRegistrar	back to summary
private CoroutinesRegistrar()

Method Detail

registerAdapters	back to summary
pack-priv void registerAdapters(ReactiveAdapterRegistry registry) Annotations @SuppressWarnings:KotlinInternalInJava

org.springframework.core back to summary

private Class ReactiveAdapterRegistry.EmptyCompletableFuture<T>

Class Inheritance

extends CompletableFuture<T>

java.lang.Object
java.util.concurrent.CompletableFuture
org.springframework.core.ReactiveAdapterRegistry.EmptyCompletableFuture

Constructor Summary

Access	Constructor and Description
pack-priv	EmptyCompletableFuture()

Method Summary

Inherited from java.util.concurrent.CompletableFuture:: acceptEither acceptEitherAsync acceptEitherAsync allOf anyOf applyToEither applyToEitherAsync applyToEitherAsync cancel complete completeAsync completeAsync completedFuture completedStage completeExceptionally completeOnTimeout copy defaultExecutor delayedExecutor delayedExecutor exceptionally exceptionallyAsync exceptionallyAsync exceptionallyCompose exceptionallyComposeAsync exceptionallyComposeAsync exceptionNow failedFuture failedStage get get getNow getNumberOfDependents handle handleAsync handleAsync isCancelled isCompletedExceptionally isDone join minimalCompletionStage newIncompleteFuture obtrudeException obtrudeValue orTimeout resultNow runAfterBoth runAfterBothAsync runAfterBothAsync runAfterEither runAfterEitherAsync runAfterEitherAsync runAsync runAsync state supplyAsync supplyAsync thenAccept thenAcceptAsync thenAcceptAsync thenAcceptBoth thenAcceptBothAsync thenAcceptBothAsync thenApply thenApplyAsync thenApplyAsync thenCombine thenCombineAsync thenCombineAsync thenCompose thenComposeAsync thenComposeAsync thenRun thenRunAsync thenRunAsync toCompletableFuture toString whenComplete whenCompleteAsync whenCompleteAsync

Constructor Detail

EmptyCompletableFuture	back to summary
pack-priv EmptyCompletableFuture()

org.springframework.core back to summary

private Class ReactiveAdapterRegistry.FlowAdaptersRegistrar

Class Inheritance

extends Object

java.lang.Object
org.springframework.core.ReactiveAdapterRegistry.FlowAdaptersRegistrar

Field Summary

Modifier and Type	Field and Description
private static final Flow.Publisher<Object>	EMPTY_PUBLISHER
private static final Flow.Subscription	EMPTY_SUBSCRIPTION

Constructor Summary

Access	Constructor and Description
private	FlowAdaptersRegistrar()

Method Summary

Modifier and Type	Method and Description
pack-priv void	registerAdapters(ReactiveAdapterRegistry registry)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

EMPTY_PUBLISHER	back to summary
private static final Flow.Publisher<Object> EMPTY_PUBLISHER

EMPTY_SUBSCRIPTION	back to summary
private static final Flow.Subscription EMPTY_SUBSCRIPTION

Constructor Detail

FlowAdaptersRegistrar	back to summary
private FlowAdaptersRegistrar()

Method Detail

registerAdapters	back to summary
pack-priv void registerAdapters(ReactiveAdapterRegistry registry) Annotations @SuppressWarnings:unchecked

org.springframework.core back to summary

private Class ReactiveAdapterRegistry.MutinyRegistrar

Class Inheritance

extends Object

java.lang.Object
org.springframework.core.ReactiveAdapterRegistry.MutinyRegistrar

Field Summary

Modifier and Type	Field and Description
private static final Method	uniToPublisher

Constructor Summary

Access	Constructor and Description
private	MutinyRegistrar()

Method Summary

Modifier and Type	Method and Description
pack-priv void	registerAdapters(ReactiveAdapterRegistry registry)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

uniToPublisher	back to summary
private static final Method uniToPublisher

Constructor Detail

MutinyRegistrar	back to summary
private MutinyRegistrar()

Method Detail

registerAdapters	back to summary
pack-priv void registerAdapters(ReactiveAdapterRegistry registry) Annotations @SuppressWarnings:unchecked

org.springframework.core back to summary

private Class ReactiveAdapterRegistry.ReactorAdapter

Class Inheritance

extends ReactiveAdapter

java.lang.Object
org.springframework.core.ReactiveAdapter
org.springframework.core.ReactiveAdapterRegistry.ReactorAdapter

ReactiveAdapter variant that wraps adapted Publishers as Flux or Mono depending on ReactiveTypeDescriptor#isMultiValue(). This is important in places where only the stream and stream element type information is available like encoders and decoders.

Constructor Summary

Access	Constructor and Description
pack-priv	ReactorAdapter(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toPublisherFunction, Function<Publisher<?>, Object> fromPublisherFunction)

Method Summary

Modifier and Type	Method and Description
public <T> Publisher<T>	toPublisher(Object the source object to adapt from; if the given object is `null`, `ReactiveTypeDescriptor#getEmptyValue()` is used. source) Overrides org.springframework.core.ReactiveAdapter.toPublisher. Adapt the given instance to a Reactive Streams `Publisher`.

Inherited from org.springframework.core.ReactiveAdapter:: fromPublisher getDescriptor getReactiveType isMultiValue isNoValue supportsEmpty

Constructor Detail

ReactorAdapter	back to summary
pack-priv ReactorAdapter(ReactiveTypeDescriptor descriptor, Function<Object, Publisher<?>> toPublisherFunction, Function<Publisher<?>, Object> fromPublisherFunction)

Method Detail

toPublisher back to summary

toPublisher	back to summary
public <T> Publisher<T> toPublisher(Object source) Overrides org.springframework.core.ReactiveAdapter.toPublisher. Doc from org.springframework.core.ReactiveAdapter.toPublisher. Adapt the given instance to a Reactive Streams `Publisher`. Parameters source:Object the source object to adapt from; if the given object is `null`, `ReactiveTypeDescriptor#getEmptyValue()` is used. Returns:Publisher<T> the Publisher representing the adaptation Annotations @Override

public <T> Publisher<T> toPublisher(Object source)

Overrides org.springframework.core.ReactiveAdapter.toPublisher.

Doc from org.springframework.core.ReactiveAdapter.toPublisher.

Adapt the given instance to a Reactive Streams Publisher.

Parameters

source:Object: the source object to adapt from; if the given object is null, ReactiveTypeDescriptor#getEmptyValue() is used.

Returns:Publisher<T>

the Publisher representing the adaptation

Annotations

@Override

org.springframework.core back to summary

private Class ReactiveAdapterRegistry.ReactorRegistrar

Class Inheritance

extends Object

java.lang.Object
org.springframework.core.ReactiveAdapterRegistry.ReactorRegistrar

Field Summary

Modifier and Type	Field and Description
private static final Flow.Publisher<?>	EMPTY_FLOW

Constructor Summary

Access	Constructor and Description
private	ReactorRegistrar()

Method Summary

Modifier and Type	Method and Description
pack-priv void	registerAdapters(ReactiveAdapterRegistry registry)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

EMPTY_FLOW	back to summary
private static final Flow.Publisher<?> EMPTY_FLOW

Constructor Detail

ReactorRegistrar	back to summary
private ReactorRegistrar()

Method Detail

registerAdapters	back to summary
pack-priv void registerAdapters(ReactiveAdapterRegistry registry)

org.springframework.core back to summary

private Class ReactiveAdapterRegistry.RxJava3Registrar

Class Inheritance

extends Object

java.lang.Object
org.springframework.core.ReactiveAdapterRegistry.RxJava3Registrar

Constructor Summary

Access	Constructor and Description
private	RxJava3Registrar()

Method Summary

Modifier and Type	Method and Description
pack-priv void	registerAdapters(ReactiveAdapterRegistry registry)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

RxJava3Registrar	back to summary
private RxJava3Registrar()

Method Detail

registerAdapters	back to summary
pack-priv void registerAdapters(ReactiveAdapterRegistry registry)

org.springframework.core back to summary

public Class ReactiveAdapterRegistry.SpringCoreBlockHoundIntegration

Class Inheritance

extends Object
implements BlockHoundIntegration

java.lang.Object
org.springframework.core.ReactiveAdapterRegistry.SpringCoreBlockHoundIntegration

All Implemented Interfaces

reactor.blockhound.integration.BlockHoundIntegration, java.lang.Comparable

BlockHoundIntegration for spring-core classes. Explicitly allows locking within ConcurrentReferenceHashMap.

Since: 5.2.4

Constructor Summary

Access	Constructor and Description
public	SpringCoreBlockHoundIntegration()

Method Summary

Modifier and Type	Method and Description
public void	applyTo(BlockHound.Builder an instance of `BlockHound.Builder` that is being installed builder) Implements reactor.blockhound.integration.BlockHoundIntegration.applyTo. Lets an integration apply the customizations (see `BlockHound.Builder`) before BlockHound is installed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SpringCoreBlockHoundIntegration	back to summary
public SpringCoreBlockHoundIntegration()

Method Detail

applyTo back to summary

public void applyTo(BlockHound.Builder builder)

Implements reactor.blockhound.integration.BlockHoundIntegration.applyTo.

Doc from reactor.blockhound.integration.BlockHoundIntegration.applyTo.

Lets an integration apply the customizations (see BlockHound.Builder) before BlockHound is installed.

Parameters

builder:BlockHound.Builder: an instance of BlockHound.Builder that is being installed

Annotations

@Override