类 WorkManagerTaskExecutor
- java.lang.Object
- org.springframework.jndi.JndiAccessor
- org.springframework.jndi.JndiLocatorSupport
- org.springframework.scheduling.commonj.WorkManagerTaskExecutor
- 所有已实现的接口:
WorkManager
,Executor
,InitializingBean
,AsyncListenableTaskExecutor
,AsyncTaskExecutor
,TaskExecutor
,SchedulingTaskExecutor
public class WorkManagerTaskExecutor extends JndiLocatorSupport implements AsyncListenableTaskExecutor, SchedulingTaskExecutor, WorkManager, InitializingBean
TaskExecutor implementation that delegates to a CommonJ WorkManager, implementing theWorkManager
interface, which either needs to be specified as reference or through the JNDI name.This is the central convenience class for setting up a CommonJ WorkManager in a Spring context.
Also implements the CommonJ WorkManager interface itself, delegating all calls to the target WorkManager. Hence, a caller can choose whether it wants to talk to this executor through the Spring TaskExecutor interface or the CommonJ WorkManager interface.
The CommonJ WorkManager will usually be retrieved from the application server's JNDI environment, as defined in the server's management console.
Note: On EE 7/8 compliant versions of WebLogic and WebSphere, a
DefaultManagedTaskExecutor
should be preferred, following JSR-236 support in Java EE 7/8.- 从以下版本开始:
- 2.0
- 作者:
- Juergen Hoeller
字段概要
从类继承的字段 org.springframework.jndi.JndiLocatorSupport
CONTAINER_PREFIX
从类继承的字段 org.springframework.jndi.JndiAccessor
logger
从接口继承的字段 org.springframework.core.task.AsyncTaskExecutor
TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE
从接口继承的字段 commonj.work.WorkManager
IMMEDIATE, INDEFINITE
构造器概要
构造器 构造器 说明 WorkManagerTaskExecutor()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.void
execute(Runnable task)
Execute the giventask
.void
execute(Runnable task, long startTimeout)
Execute the giventask
.boolean
prefersShortLivedTasks()
This task executor prefers short-lived work units.WorkItem
schedule(Work work)
WorkItem
schedule(Work work, WorkListener workListener)
void
setTaskDecorator(TaskDecorator taskDecorator)
Specify a customTaskDecorator
to be applied to anyRunnable
about to be executed.void
setWorkListener(WorkListener workListener)
Specify a CommonJ WorkListener to apply, if any.void
setWorkManager(WorkManager workManager)
Specify the CommonJ WorkManager to delegate to.void
setWorkManagerName(String workManagerName)
Set the JNDI name of the CommonJ WorkManager.Future<?>
submit(Runnable task)
Submit a Runnable task for execution, receiving a Future representing that task.<T> Future<T>
submit(Callable<T> task)
Submit a Callable task for execution, receiving a Future representing that task.ListenableFuture<?>
submitListenable(Runnable task)
Submit aRunnable
task for execution, receiving aListenableFuture
representing that task.<T> ListenableFuture<T>
submitListenable(Callable<T> task)
Submit aCallable
task for execution, receiving aListenableFuture
representing that task.boolean
waitForAll(Collection workItems, long timeout)
Collection
waitForAny(Collection workItems, long timeout)
从类继承的方法 org.springframework.jndi.JndiLocatorSupport
convertJndiName, isResourceRef, lookup, lookup, setResourceRef
从类继承的方法 org.springframework.jndi.JndiAccessor
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate
构造器详细资料
WorkManagerTaskExecutor
public WorkManagerTaskExecutor()
方法详细资料
setWorkManager
public void setWorkManager(WorkManager workManager)
Specify the CommonJ WorkManager to delegate to.Alternatively, you can also specify the JNDI name of the target WorkManager.
setWorkManagerName
public void setWorkManagerName(String workManagerName)
Set the JNDI name of the CommonJ WorkManager.This can either be a fully qualified JNDI name, or the JNDI name relative to the current environment naming context if "resourceRef" is set to "true".
setWorkListener
public void setWorkListener(WorkListener workListener)
Specify a CommonJ WorkListener to apply, if any.This shared WorkListener instance will be passed on to the WorkManager by all
execute(java.lang.Runnable)
calls on this TaskExecutor.
setTaskDecorator
public void setTaskDecorator(TaskDecorator taskDecorator)
Specify a customTaskDecorator
to be applied to anyRunnable
about to be executed.Note that such a decorator is not necessarily being applied to the user-supplied
Runnable
/Callable
but rather to the actual execution callback (which may be a wrapper around the user-supplied task).The primary use case is to set some execution context around the task's invocation, or to provide some monitoring/statistics for task execution.
NOTE: Exception handling in
TaskDecorator
implementations is limited to plainRunnable
execution viaexecute
calls. In case of#submit
calls, the exposedRunnable
will be aFutureTask
which does not propagate any exceptions; you might have to cast it and callFuture#get
to evaluate exceptions.- 从以下版本开始:
- 4.3
afterPropertiesSet
public void afterPropertiesSet() throws NamingException
从接口复制的说明:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- 指定者:
afterPropertiesSet
在接口中InitializingBean
- 抛出:
NamingException
execute
public void execute(Runnable task)
从接口复制的说明:TaskExecutor
Execute the giventask
.The call might return immediately if the implementation uses an asynchronous execution strategy, or might block in the case of synchronous execution.
- 指定者:
execute
在接口中Executor
- 指定者:
execute
在接口中TaskExecutor
- 参数:
task
- theRunnable
to execute (nevernull
)
execute
public void execute(Runnable task, long startTimeout)
从接口复制的说明:AsyncTaskExecutor
Execute the giventask
.- 指定者:
execute
在接口中AsyncTaskExecutor
- 参数:
task
- theRunnable
to execute (nevernull
)startTimeout
- the time duration (milliseconds) within which the task is supposed to start. This is intended as a hint to the executor, allowing for preferred handling of immediate tasks. Typical values areAsyncTaskExecutor.TIMEOUT_IMMEDIATE
orAsyncTaskExecutor.TIMEOUT_INDEFINITE
(the default as used byTaskExecutor.execute(Runnable)
).
submit
public Future<?> submit(Runnable task)
从接口复制的说明:AsyncTaskExecutor
Submit a Runnable task for execution, receiving a Future representing that task. The Future will return anull
result upon completion.- 指定者:
submit
在接口中AsyncTaskExecutor
- 参数:
task
- theRunnable
to execute (nevernull
)- 返回:
- a Future representing pending completion of the task
submit
public <T> Future<T> submit(Callable<T> task)
从接口复制的说明:AsyncTaskExecutor
Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion.- 指定者:
submit
在接口中AsyncTaskExecutor
- 参数:
task
- theCallable
to execute (nevernull
)- 返回:
- a Future representing pending completion of the task
submitListenable
public ListenableFuture<?> submitListenable(Runnable task)
从接口复制的说明:AsyncListenableTaskExecutor
Submit aRunnable
task for execution, receiving aListenableFuture
representing that task. The Future will return anull
result upon completion.- 指定者:
submitListenable
在接口中AsyncListenableTaskExecutor
- 参数:
task
- theRunnable
to execute (nevernull
)- 返回:
- a
ListenableFuture
representing pending completion of the task
submitListenable
public <T> ListenableFuture<T> submitListenable(Callable<T> task)
从接口复制的说明:AsyncListenableTaskExecutor
Submit aCallable
task for execution, receiving aListenableFuture
representing that task. The Future will return the Callable's result upon completion.- 指定者:
submitListenable
在接口中AsyncListenableTaskExecutor
- 参数:
task
- theCallable
to execute (nevernull
)- 返回:
- a
ListenableFuture
representing pending completion of the task
prefersShortLivedTasks
public boolean prefersShortLivedTasks()
This task executor prefers short-lived work units.- 指定者:
prefersShortLivedTasks
在接口中SchedulingTaskExecutor
- 返回:
true
if thisTaskExecutor
prefers short-lived tasks
schedule
public WorkItem schedule(Work work) throws WorkException, IllegalArgumentException
schedule
public WorkItem schedule(Work work, WorkListener workListener) throws WorkException
- 指定者:
schedule
在接口中WorkManager
- 抛出:
WorkException
waitForAll
public boolean waitForAll(Collection workItems, long timeout) throws InterruptedException
- 指定者:
waitForAll
在接口中WorkManager
- 抛出:
InterruptedException
waitForAny
public Collection waitForAny(Collection workItems, long timeout) throws InterruptedException
- 指定者:
waitForAny
在接口中WorkManager
- 抛出:
InterruptedException