Top Description Methods
org.springframework.scheduling

public Interface SchedulingAwareRunnable

extends Runnable
Known Direct Implementers
org.springframework.scheduling.annotation.ScheduledAnnotationReactiveSupport.SubscribingRunnable, org.springframework.scheduling.support.ScheduledMethodRunnable
Imports
org.springframework.lang.Nullable

Extension of the Runnable interface, adding special callbacks for long-running operations.

Scheduling-capable TaskExecutors are encouraged to check a submitted Runnable, detecting whether this interface is implemented and reacting as appropriately as they are able to.

Author
Juergen Hoeller
Since
2.0
See Also
org.springframework.core.task.TaskExecutor, SchedulingTaskExecutor

Method Summary

Modifier and TypeMethod and Description
public default String
getQualifier()

Return a qualifier associated with this Runnable.

public default boolean
isLongLived()

Return whether the Runnable's operation is long-lived (true) versus short-lived (false).

Inherited from java.lang.Runnable:
run

Method Detail

getQualifierback to summary
public default String 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
@Nullable
Since
6.1
See Also
org.springframework.scheduling.annotation.Scheduled#scheduler()
isLongLivedback to summary
public default boolean isLongLived()

Return whether the Runnable's operation is long-lived (true) versus short-lived (false).

In the former case, the task will not allocate a thread from the thread pool (if any) but rather be considered as long-running background thread.

This should be considered a hint. Of course TaskExecutor implementations are free to ignore this flag and the SchedulingAwareRunnable interface overall.

The default implementation returns false, as of 6.1.