Modifier and Type	Class and Description
pack-priv static class	ScheduledAnnotationReactiveSupport.SubscribingRunnable Utility implementation of `Runnable` that subscribes to a `Publisher` or subscribes-then-blocks if `shouldBlock` is set to `true`.
private static class	ScheduledAnnotationReactiveSupport.TrackingSubscriber A `Subscriber` which keeps track of its `Subscription` and exposes the capacity to cancel the subscription as a `Runnable`.

Modifier and Type	Field and Description
pack-priv static final boolean	coroutinesReactorPresent
private static final Log	logger
pack-priv static final boolean	reactorPresent

Access	Constructor and Description
pack-priv	ScheduledAnnotationReactiveSupport()

Method Summary

Modifier and Type	Method and Description
public static Runnable	createSubscriptionRunnable(Method method, Object targetBean, Scheduled scheduled, Supplier<ObservationRegistry> observationRegistrySupplier, List<Runnable> subscriptionTrackerRegistry) Create a `Runnable` for the Scheduled infrastructure, allowing for scheduled subscription to the publisher produced by a reactive method.
pack-priv static Publisher<?>	getPublisherFor(Method method, Object bean) Turn the invocation of the provided `Method` into a `Publisher`, either by reflectively invoking it and converting the result to a `Publisher` via `ReactiveAdapterRegistry` or by converting a Kotlin suspending function into a `Publisher` via `CoroutinesUtils`.
public static boolean	isReactive(Method method) Checks that if the method is reactive, it can be scheduled.

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

Field Detail

coroutinesReactorPresent	back to summary
pack-priv static final boolean coroutinesReactorPresent

logger	back to summary
private static final Log logger

reactorPresent	back to summary
pack-priv static final boolean reactorPresent

ScheduledAnnotationReactiveSupport	back to summary
pack-priv ScheduledAnnotationReactiveSupport()

Method Detail

createSubscriptionRunnable back to summary

createSubscriptionRunnable	back to summary
public static Runnable createSubscriptionRunnable(Method method, Object targetBean, Scheduled scheduled, Supplier<ObservationRegistry> observationRegistrySupplier, List<Runnable> subscriptionTrackerRegistry) Create a `Runnable` for the Scheduled infrastructure, allowing for scheduled subscription to the publisher produced by a reactive method. Note that the reactive method is invoked once, but the resulting `Publisher` is subscribed to repeatedly, once per each invocation of the `Runnable`. In the case of a fixed-delay configuration, the subscription inside the `Runnable` is turned into a blocking call in order to maintain fixed-delay semantics (i.e. the task blocks until completion of the Publisher, and the delay is applied until the next iteration).

public static Runnable createSubscriptionRunnable(Method method, Object targetBean, Scheduled scheduled, Supplier<ObservationRegistry> observationRegistrySupplier, List<Runnable> subscriptionTrackerRegistry)

Create a Runnable for the Scheduled infrastructure, allowing for scheduled subscription to the publisher produced by a reactive method.

Note that the reactive method is invoked once, but the resulting Publisher is subscribed to repeatedly, once per each invocation of the Runnable.

In the case of a fixed-delay configuration, the subscription inside the Runnable is turned into a blocking call in order to maintain fixed-delay semantics (i.e. the task blocks until completion of the Publisher, and the delay is applied until the next iteration).

getPublisherFor back to summary

getPublisherFor	back to summary
pack-priv static Publisher<?> getPublisherFor(Method method, Object bean) Turn the invocation of the provided `Method` into a `Publisher`, either by reflectively invoking it and converting the result to a `Publisher` via `ReactiveAdapterRegistry` or by converting a Kotlin suspending function into a `Publisher` via `CoroutinesUtils`. The `isReactive(Method)` check is a precondition to calling this method. If Reactor is present at runtime, the `Publisher` is additionally converted to a `Flux` with a checkpoint String, allowing for better debugging.

pack-priv static Publisher<?> getPublisherFor(Method method, Object bean)

Turn the invocation of the provided Method into a Publisher, either by reflectively invoking it and converting the result to a Publisher via ReactiveAdapterRegistry or by converting a Kotlin suspending function into a Publisher via CoroutinesUtils.

The isReactive(Method) check is a precondition to calling this method. If Reactor is present at runtime, the Publisher is additionally converted to a Flux with a checkpoint String, allowing for better debugging.

isReactive back to summary

isReactive	back to summary
public static boolean isReactive(Method method) Checks that if the method is reactive, it can be scheduled. Methods are considered eligible for reactive scheduling if they either return an instance of a type that can be converted to `Publisher` or are a Kotlin suspending function. If the method doesn't match these criteria, this check returns `false`. For scheduling of Kotlin suspending functions, the Coroutine-Reactor bridge `kotlinx.coroutines.reactor` must be present at runtime (in order to invoke suspending functions as a `Publisher`). Provided that is the case, this method returns `true`. Otherwise, it throws an `IllegalStateException`. Exceptions IllegalStateException: if the method is reactive but Reactor and/or the Kotlin coroutines bridge are not present at runtime

public static boolean isReactive(Method method)

Checks that if the method is reactive, it can be scheduled. Methods are considered eligible for reactive scheduling if they either return an instance of a type that can be converted to Publisher or are a Kotlin suspending function. If the method doesn't match these criteria, this check returns false.

For scheduling of Kotlin suspending functions, the Coroutine-Reactor bridge kotlinx.coroutines.reactor must be present at runtime (in order to invoke suspending functions as a Publisher). Provided that is the case, this method returns true. Otherwise, it throws an IllegalStateException.

Exceptions

IllegalStateException:: if the method is reactive but Reactor and/or the Kotlin coroutines bridge are not present at runtime

org.springframework.scheduling.annotation back to summary

pack-priv final Class ScheduledAnnotationReactiveSupport.SubscribingRunnable

Class Inheritance

extends Object
implements SchedulingAwareRunnable

java.lang.Object
org.springframework.scheduling.annotation.ScheduledAnnotationReactiveSupport.SubscribingRunnable

All Implemented Interfaces

org.springframework.scheduling.SchedulingAwareRunnable, java.lang.Runnable

Utility implementation of Runnable that subscribes to a Publisher or subscribes-then-blocks if shouldBlock is set to true.

Field Summary

Modifier and Type	Field and Description
pack-priv final Supplier<ScheduledTaskObservationContext>	contextSupplier
private static final ScheduledTaskObservationConvention	DEFAULT_CONVENTION
pack-priv final Supplier<ObservationRegistry>	observationRegistrySupplier
private final Publisher<?>	publisher
private final String	qualifier
pack-priv final boolean	shouldBlock
private final List<Runnable>	subscriptionTrackerRegistry

Constructor Summary

Access	Constructor and Description
pack-priv	SubscribingRunnable(Publisher<?> publisher, boolean shouldBlock, String qualifier, List<Runnable> subscriptionTrackerRegistry, Supplier<ObservationRegistry> observationRegistrySupplier, Supplier<ScheduledTaskObservationContext> contextSupplier)

Method Summary

Modifier and Type	Method and Description
public String	getQualifier() Overrides default org.springframework.scheduling.SchedulingAwareRunnable.getQualifier. Return a qualifier associated with this Runnable.
public void	run() Implements java.lang.Runnable.run. Runs this operation.
private void	subscribe(ScheduledAnnotationReactiveSupport.TrackingSubscriber subscriber, Observation observation)

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

Field Detail

contextSupplier	back to summary
pack-priv final Supplier<ScheduledTaskObservationContext> contextSupplier

DEFAULT_CONVENTION	back to summary
private static final ScheduledTaskObservationConvention DEFAULT_CONVENTION

observationRegistrySupplier	back to summary
pack-priv final Supplier<ObservationRegistry> observationRegistrySupplier

publisher	back to summary
private final Publisher<?> publisher

qualifier	back to summary
private final String qualifier Annotations @Nullable

shouldBlock	back to summary
pack-priv final boolean shouldBlock

subscriptionTrackerRegistry	back to summary
private final List<Runnable> subscriptionTrackerRegistry

Constructor Detail

SubscribingRunnable	back to summary
pack-priv SubscribingRunnable(Publisher<?> publisher, boolean shouldBlock, String qualifier, List<Runnable> subscriptionTrackerRegistry, Supplier<ObservationRegistry> observationRegistrySupplier, Supplier<ScheduledTaskObservationContext> contextSupplier)

Method Detail

getQualifier back to summary

getQualifier	back to summary
public String getQualifier() Overrides default org.springframework.scheduling.SchedulingAwareRunnable.getQualifier. Doc from org.springframework.scheduling.SchedulingAwareRunnable.getQualifier. Return a qualifier associated with this Runnable. The default implementation returns `null`. May be used for custom purposes depending on the scheduler implementation. `org.springframework.scheduling.config.TaskSchedulerRouter` introspects this qualifier in order to determine the target scheduler to be used for a given Runnable, matching the qualifier value (or the bean name) of a specific `org.springframework.scheduling.TaskScheduler` or `java.util.concurrent.ScheduledExecutorService` bean definition. Annotations @Override @Nullable

public String getQualifier()

Overrides default org.springframework.scheduling.SchedulingAwareRunnable.getQualifier.

Doc from org.springframework.scheduling.SchedulingAwareRunnable.getQualifier.

Return a qualifier associated with this Runnable.

The default implementation returns null.

May be used for custom purposes depending on the scheduler implementation. org.springframework.scheduling.config.TaskSchedulerRouter introspects this qualifier in order to determine the target scheduler to be used for a given Runnable, matching the qualifier value (or the bean name) of a specific org.springframework.scheduling.TaskScheduler or java.util.concurrent.ScheduledExecutorService bean definition.

Annotations

@Override
@Nullable

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

subscribe	back to summary
private void subscribe(ScheduledAnnotationReactiveSupport.TrackingSubscriber subscriber, Observation observation)

org.springframework.scheduling.annotation back to summary

private final Class ScheduledAnnotationReactiveSupport.TrackingSubscriber

Class Inheritance

extends Object
implements Subscriber<Object>, Runnable

java.lang.Object
org.springframework.scheduling.annotation.ScheduledAnnotationReactiveSupport.TrackingSubscriber

All Implemented Interfaces

java.lang.Runnable, org.reactivestreams.Subscriber

A Subscriber which keeps track of its Subscription and exposes the capacity to cancel the subscription as a Runnable. Can optionally support blocking if a CountDownLatch is supplied during construction.

Field Summary

Modifier and Type	Field and Description
private final CountDownLatch	blockingLatch
private final Observation	observation
private Subscription	subscription
private final List<Runnable>	subscriptionTrackerRegistry

Constructor Summary

Access	Constructor and Description
pack-priv	TrackingSubscriber(List<Runnable> subscriptionTrackerRegistry, Observation observation)
pack-priv	TrackingSubscriber(List<Runnable> subscriptionTrackerRegistry, Observation observation, CountDownLatch latch)

Method Summary

Modifier and Type	Method and Description
public void	onComplete() Implements org.reactivestreams.Subscriber.onComplete. Successful terminal state.
public void	onError(Throwable the throwable signaled ex) Implements org.reactivestreams.Subscriber.onError. Failed terminal state.
public void	onNext(Object the element signaled obj) Implements org.reactivestreams.Subscriber.onNext. Data notification sent by the `Publisher` in response to requests to `Subscription#request(long)`.
public void	onSubscribe(Subscription the `Subscription` that allows requesting data via `Subscription#request(long)` subscription) Implements org.reactivestreams.Subscriber.onSubscribe. Invoked after calling `Publisher#subscribe(Subscriber)`.
public void	run() Implements java.lang.Runnable.run. Runs this operation.

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

Field Detail

blockingLatch	back to summary
private final CountDownLatch blockingLatch Annotations @Nullable

observation	back to summary
private final Observation observation

subscription	back to summary
private Subscription subscription Annotations @Nullable

subscriptionTrackerRegistry	back to summary
private final List<Runnable> subscriptionTrackerRegistry

Constructor Detail

TrackingSubscriber	back to summary
pack-priv TrackingSubscriber(List<Runnable> subscriptionTrackerRegistry, Observation observation)

TrackingSubscriber	back to summary
pack-priv TrackingSubscriber(List<Runnable> subscriptionTrackerRegistry, Observation observation, CountDownLatch latch)

Method Detail

onComplete back to summary

onComplete	back to summary
public void onComplete() Implements org.reactivestreams.Subscriber.onComplete. Doc from org.reactivestreams.Subscriber.onComplete. Successful terminal state. No further events will be sent even if `Subscription#request(long)` is invoked again. Annotations @Override

public void onComplete()

Implements org.reactivestreams.Subscriber.onComplete.

Doc from org.reactivestreams.Subscriber.onComplete.

Successful terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Annotations

@Override

onError back to summary

onError	back to summary
public void onError(Throwable ex) Implements org.reactivestreams.Subscriber.onError. Doc from org.reactivestreams.Subscriber.onError. Failed terminal state. No further events will be sent even if `Subscription#request(long)` is invoked again. Parameters ex:Throwable the throwable signaled Annotations @Override

public void onError(Throwable ex)

Implements org.reactivestreams.Subscriber.onError.

Doc from org.reactivestreams.Subscriber.onError.

Failed terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Parameters

ex:Throwable: the throwable signaled

Annotations

@Override

onNext back to summary

onNext	back to summary
public void onNext(Object obj) Implements org.reactivestreams.Subscriber.onNext. Doc from org.reactivestreams.Subscriber.onNext. Data notification sent by the `Publisher` in response to requests to `Subscription#request(long)`. Parameters obj:Object the element signaled Annotations @Override

public void onNext(Object obj)

Implements org.reactivestreams.Subscriber.onNext.

Doc from org.reactivestreams.Subscriber.onNext.

Data notification sent by the Publisher in response to requests to Subscription#request(long).

Parameters

obj:Object: the element signaled

Annotations

@Override

onSubscribe back to summary

onSubscribe	back to summary
public void onSubscribe(Subscription subscription) Implements org.reactivestreams.Subscriber.onSubscribe. Doc from org.reactivestreams.Subscriber.onSubscribe. Invoked after calling `Publisher#subscribe(Subscriber)`. No data will start flowing until `Subscription#request(long)` is invoked. It is the responsibility of this `Subscriber` instance to call `Subscription#request(long)` whenever more data is wanted. The `Publisher` will send notifications only in response to `Subscription#request(long)`. Parameters subscription:Subscription the `Subscription` that allows requesting data via `Subscription#request(long)` Annotations @Override

public void onSubscribe(Subscription subscription)

Implements org.reactivestreams.Subscriber.onSubscribe.

Doc from org.reactivestreams.Subscriber.onSubscribe.

Invoked after calling Publisher#subscribe(Subscriber).

No data will start flowing until Subscription#request(long) is invoked.

It is the responsibility of this Subscriber instance to call Subscription#request(long) whenever more data is wanted.

The Publisher will send notifications only in response to Subscription#request(long).

Parameters