Package org.springframework.scheduling.support

Class TaskUtils

java.lang.Object

org.springframework.scheduling.support.TaskUtils

public abstract class TaskUtils
extends Object

Utility methods for decorating tasks with error handling.

NOTE: This class is intended for internal use by Spring's scheduler implementations. It is only public so that it may be accessed from impl classes within other packages. It is not intended for general use.

Since:

3.0

Author:

Mark Fisher, Juergen Hoeller

Field Summary

Fields

Modifier and Type	Field	Description
static final ErrorHandler	LOG_AND_PROPAGATE_ERROR_HANDLER	An ErrorHandler strategy that will log at error level and then re-throw the Exception.
static final ErrorHandler	LOG_AND_SUPPRESS_ERROR_HANDLER	An ErrorHandler strategy that will log the Exception but perform no further handling.

Constructor Summary

Constructors

Constructor	Description
TaskUtils()

Method Summary

Modifier and Type	Method	Description
static DelegatingErrorHandlingRunnable	decorateTaskWithErrorHandler(Runnable task, @Nullable ErrorHandler errorHandler, boolean isRepeatingTask)	Decorate the task for error handling.
static ErrorHandler	getDefaultErrorHandler(boolean isRepeatingTask)	Return the default ErrorHandler implementation based on the boolean value indicating whether the task will be repeating or not.

Methods inherited from class java.lang.Object

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

Field Details

LOG_AND_SUPPRESS_ERROR_HANDLER

public static final ErrorHandler LOG_AND_SUPPRESS_ERROR_HANDLER

An ErrorHandler strategy that will log the Exception but perform no further handling. This will suppress the error so that subsequent executions of the task will not be prevented.

LOG_AND_PROPAGATE_ERROR_HANDLER

public static final ErrorHandler LOG_AND_PROPAGATE_ERROR_HANDLER

An ErrorHandler strategy that will log at error level and then re-throw the Exception. Note: this will typically prevent subsequent execution of a scheduled task.

Constructor Details

TaskUtils

public TaskUtils()

Method Details

decorateTaskWithErrorHandler

public static DelegatingErrorHandlingRunnable decorateTaskWithErrorHandler(Runnable task,
 @Nullable ErrorHandler errorHandler,
 boolean isRepeatingTask)

Decorate the task for error handling. If the provided ErrorHandler is not null, it will be used. Otherwise, repeating tasks will have errors suppressed by default whereas one-shot tasks will have errors propagated by default since those errors may be expected through the returned Future. In both cases, the errors will be logged.

getDefaultErrorHandler

public static ErrorHandler getDefaultErrorHandler(boolean isRepeatingTask)

Return the default ErrorHandler implementation based on the boolean value indicating whether the task will be repeating or not. For repeating tasks it will suppress errors, but for one-time tasks it will propagate. In both cases, the error will be logged.