Spring Framework 6.1.4 · org.springframework.web.context.request.async.WebAsyncTask

Modifier and Type	Field and Description
private BeanFactory	beanFactory
private final Callable<V>	callable
private Runnable	completionCallback
private Callable<V>	errorCallback
private final AsyncTaskExecutor	executor
private final String	executorName
private final Long	timeout
private Callable<V>	timeoutCallback

Constructor Summary

Access	Constructor and Description
public	WebAsyncTask(Callable<V> the callable for concurrent handling callable) Create a `WebAsyncTask` wrapping the given `Callable`.
public	WebAsyncTask(long a timeout value in milliseconds timeout, Callable<V> the callable for concurrent handling callable) Create a `WebAsyncTask` with a timeout value and a `Callable`.
public	WebAsyncTask(Long the timeout value in milliseconds; ignored if `null` timeout, String the name of an executor bean to use executorName, Callable<V> the callable for concurrent handling callable) Create a `WebAsyncTask` with a timeout value, an executor name, and a `Callable`.
public	WebAsyncTask(Long the timeout value in milliseconds; ignored if `null` timeout, AsyncTaskExecutor the executor to use executor, Callable<V> the callable for concurrent handling callable) Create a `WebAsyncTask` with a timeout value, an executor instance, and a Callable.

Method Summary

Modifier and Type	Method and Description
public Callable<?>	getCallable() Return the `Callable` to use for concurrent handling (never `null`).
public AsyncTaskExecutor	getExecutor() Return the AsyncTaskExecutor to use for concurrent handling, or `null` if none specified.
pack-priv CallableProcessingInterceptor	getInterceptor()
public Long	getTimeout() Return the timeout value in milliseconds, or `null` if no timeout is set.
public void	onCompletion(Runnable callback) Register code to invoke when the async request completes.
public void	onError(Callable<V> callback) Register code to invoke for an error during async request processing.
public void	onTimeout(Callable<V> callback) Register code to invoke when the async request times out.
public void	setBeanFactory(BeanFactory owning BeanFactory (never `null`). The bean can immediately call methods on the factory. beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. A `BeanFactory` to use for resolving an executor name.

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

Field Detail

beanFactory	back to summary
private BeanFactory beanFactory

callable	back to summary
private final Callable<V> callable

completionCallback	back to summary
private Runnable completionCallback

errorCallback	back to summary
private Callable<V> errorCallback

executor	back to summary
private final AsyncTaskExecutor executor Annotations @Nullable

executorName	back to summary
private final String executorName Annotations @Nullable

timeout	back to summary
private final Long timeout Annotations @Nullable

timeoutCallback	back to summary
private Callable<V> timeoutCallback

Constructor Detail

WebAsyncTask back to summary

WebAsyncTask	back to summary
public WebAsyncTask(Callable<V> callable) Create a `WebAsyncTask` wrapping the given `Callable`. Parameters callable:Callable<V> the callable for concurrent handling

public WebAsyncTask(Callable<V> callable)

Create a WebAsyncTask wrapping the given Callable.

Parameters

callable:Callable<V>: the callable for concurrent handling

WebAsyncTask back to summary

WebAsyncTask	back to summary
public WebAsyncTask(long timeout, Callable<V> callable) Create a `WebAsyncTask` with a timeout value and a `Callable`. Parameters timeout:long a timeout value in milliseconds callable:Callable<V> the callable for concurrent handling

public WebAsyncTask(long timeout, Callable<V> callable)

Create a WebAsyncTask with a timeout value and a Callable.

Parameters

timeout:long: a timeout value in milliseconds
callable:Callable<V>: the callable for concurrent handling

WebAsyncTask back to summary

WebAsyncTask	back to summary
public WebAsyncTask(Long timeout, String executorName, Callable<V> callable) Create a `WebAsyncTask` with a timeout value, an executor name, and a `Callable`. Parameters timeout:Long the timeout value in milliseconds; ignored if `null` executorName:String the name of an executor bean to use callable:Callable<V> the callable for concurrent handling

public WebAsyncTask(Long timeout, String executorName, Callable<V> callable)

Create a WebAsyncTask with a timeout value, an executor name, and a Callable.

Parameters

timeout:Long: the timeout value in milliseconds; ignored if null
executorName:String: the name of an executor bean to use
callable:Callable<V>: the callable for concurrent handling

WebAsyncTask back to summary

WebAsyncTask	back to summary
public WebAsyncTask(Long timeout, AsyncTaskExecutor executor, Callable<V> callable) Create a `WebAsyncTask` with a timeout value, an executor instance, and a Callable. Parameters timeout:Long the timeout value in milliseconds; ignored if `null` executor:AsyncTaskExecutor the executor to use callable:Callable<V> the callable for concurrent handling

public WebAsyncTask(Long timeout, AsyncTaskExecutor executor, Callable<V> callable)

Create a WebAsyncTask with a timeout value, an executor instance, and a Callable.

Parameters

timeout:Long: the timeout value in milliseconds; ignored if null
executor:AsyncTaskExecutor: the executor to use
callable:Callable<V>: the callable for concurrent handling

Method Detail

getCallable	back to summary
public Callable<?> getCallable() Return the `Callable` to use for concurrent handling (never `null`).

getExecutor back to summary

getExecutor	back to summary
public AsyncTaskExecutor getExecutor() Return the AsyncTaskExecutor to use for concurrent handling, or `null` if none specified. Annotations @Nullable

public AsyncTaskExecutor getExecutor()

Return the AsyncTaskExecutor to use for concurrent handling, or null if none specified.

Annotations

@Nullable

getInterceptor	back to summary
pack-priv CallableProcessingInterceptor getInterceptor()

getTimeout back to summary

getTimeout	back to summary
public Long getTimeout() Return the timeout value in milliseconds, or `null` if no timeout is set. Annotations @Nullable

public Long getTimeout()

Return the timeout value in milliseconds, or null if no timeout is set.

Annotations

@Nullable

onCompletion	back to summary
public void onCompletion(Runnable callback) Register code to invoke when the async request completes. This method is called from a container thread when an async request completed for any reason, including timeout and network error.

onCompletion

back to summary

public void onCompletion(Runnable callback)

This method is called from a container thread when an async request completed for any reason, including timeout and network error.

onError back to summary

onError	back to summary
public void onError(Callable<V> callback) Register code to invoke for an error during async request processing. This method is called from a container thread when an error occurred while processing an async request before the `Callable` has completed. The callback is executed in the same thread and therefore should return without blocking. It may return an alternative value to use, including an `Exception` or return `RESULT_NONE`. Since 5.0

public void onError(Callable<V> callback)

This method is called from a container thread when an error occurred while processing an async request before the Callable has completed. The callback is executed in the same thread and therefore should return without blocking. It may return an alternative value to use, including an Exception or return RESULT_NONE.

Since: 5.0

onTimeout back to summary

onTimeout	back to summary
public void onTimeout(Callable<V> callback) Register code to invoke when the async request times out. This method is called from a container thread when an async request times out before the `Callable` has completed. The callback is executed in the same thread and therefore should return without blocking. It may return an alternative value to use, including an `Exception` or return `RESULT_NONE`.

public void onTimeout(Callable<V> callback)

This method is called from a container thread when an async request times out before the Callable has completed. The callback is executed in the same thread and therefore should return without blocking. It may return an alternative value to use, including an Exception or return RESULT_NONE.

setBeanFactory back to summary

setBeanFactory	back to summary
public void setBeanFactory(BeanFactory beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. A `BeanFactory` to use for resolving an executor name. This factory reference will automatically be set when `WebAsyncTask` is used within a Spring MVC controller. Parameters beanFactory:BeanFactory Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. owning BeanFactory (never `null`). The bean can immediately call methods on the factory. Annotations @Override

public void setBeanFactory(BeanFactory beanFactory)

Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

A BeanFactory to use for resolving an executor name.

This factory reference will automatically be set when WebAsyncTask is used within a Spring MVC controller.

Parameters

beanFactory:BeanFactory

Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

owning BeanFactory (never null). The bean can immediately call methods on the factory.

Annotations

@Override

public Class WebAsyncTask<V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail