类 WorkManagerTaskExecutor
- java.lang.Object
- org.springframework.jndi.JndiAccessor
- org.springframework.jndi.JndiLocatorSupport
- org.springframework.jca.work.WorkManagerTaskExecutor
- 所有已实现的接口:
Executor
,WorkManager
,Aware
,InitializingBean
,AsyncListenableTaskExecutor
,AsyncTaskExecutor
,TaskExecutor
,BootstrapContextAware
,SchedulingTaskExecutor
public class WorkManagerTaskExecutor extends JndiLocatorSupport implements AsyncListenableTaskExecutor, SchedulingTaskExecutor, WorkManager, BootstrapContextAware, InitializingBean
TaskExecutor
implementation that delegates to a JCA 1.7 WorkManager, implementing theWorkManager
interface.This is mainly intended for use within a JCA ResourceAdapter implementation, but may also be used in a standalone environment, delegating to a locally embedded WorkManager implementation (such as Geronimo's).
Also implements the JCA 1.7 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 WorkManager interface.
This adapter is also capable of obtaining a JCA WorkManager from JNDI. This is for example appropriate on the Geronimo application server, where WorkManager GBeans (e.g. Geronimo's default "DefaultWorkManager" GBean) can be linked into the Java EE environment through "gbean-ref" entries in the
geronimo-web.xml
deployment descriptor.- 从以下版本开始:
- 2.0.3
- 作者:
- Juergen Hoeller
- 另请参阅:
setWorkManager(javax.resource.spi.work.WorkManager)
,WorkManager.scheduleWork(javax.resource.spi.work.Work)
字段概要
从类继承的字段 org.springframework.jndi.JndiLocatorSupport
CONTAINER_PREFIX
从类继承的字段 org.springframework.jndi.JndiAccessor
logger
从接口继承的字段 org.springframework.core.task.AsyncTaskExecutor
TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE
从接口继承的字段 javax.resource.spi.work.WorkManager
IMMEDIATE, INDEFINITE, UNKNOWN
构造器概要
构造器 构造器 说明 WorkManagerTaskExecutor()
Create a new WorkManagerTaskExecutor, expecting bean-style configuration.WorkManagerTaskExecutor(WorkManager workManager)
Create a new WorkManagerTaskExecutor for the given WorkManager.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.void
doWork(Work work)
void
doWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener)
void
execute(Runnable task)
Execute the giventask
.void
execute(Runnable task, long startTimeout)
Execute the giventask
.protected WorkManager
getDefaultWorkManager()
Obtain a default WorkManager to delegate to.void
scheduleWork(Work work)
void
scheduleWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener)
void
setBlockUntilCompleted(boolean blockUntilCompleted)
Set whether to letexecute(java.lang.Runnable)
block until the work has been completed.void
setBlockUntilStarted(boolean blockUntilStarted)
Set whether to letexecute(java.lang.Runnable)
block until the work has been actually started.void
setBootstrapContext(BootstrapContext bootstrapContext)
Specify the JCA BootstrapContext that contains the WorkManager to delegate to.void
setTaskDecorator(TaskDecorator taskDecorator)
Specify a customTaskDecorator
to be applied to anyRunnable
about to be executed.void
setWorkListener(WorkListener workListener)
Specify a JCA WorkListener to apply, if any.void
setWorkManager(WorkManager workManager)
Specify the JCA WorkManager instance to delegate to.void
setWorkManagerName(String workManagerName)
Set the JNDI name of the JCA WorkManager.long
startWork(Work work)
long
startWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener)
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.从类继承的方法 org.springframework.jndi.JndiLocatorSupport
convertJndiName, isResourceRef, lookup, lookup, setResourceRef
从类继承的方法 org.springframework.jndi.JndiAccessor
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.scheduling.SchedulingTaskExecutor
prefersShortLivedTasks
构造器详细资料
WorkManagerTaskExecutor
public WorkManagerTaskExecutor()
Create a new WorkManagerTaskExecutor, expecting bean-style configuration.
WorkManagerTaskExecutor
public WorkManagerTaskExecutor(WorkManager workManager)
Create a new WorkManagerTaskExecutor for the given WorkManager.- 参数:
workManager
- the JCA WorkManager to delegate to
方法详细资料
setWorkManager
public void setWorkManager(WorkManager workManager)
Specify the JCA WorkManager instance to delegate to.
setWorkManagerName
public void setWorkManagerName(String workManagerName)
Set the JNDI name of the JCA 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".
setBootstrapContext
public void setBootstrapContext(BootstrapContext bootstrapContext)
Specify the JCA BootstrapContext that contains the WorkManager to delegate to.- 指定者:
setBootstrapContext
在接口中BootstrapContextAware
- 参数:
bootstrapContext
- the BootstrapContext object to be used by this object- 另请参阅:
InitializingBean.afterPropertiesSet()
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
setBlockUntilStarted
public void setBlockUntilStarted(boolean blockUntilStarted)
Set whether to letexecute(java.lang.Runnable)
block until the work has been actually started.Uses the JCA
startWork
operation underneath, instead of the defaultscheduleWork
.
setBlockUntilCompleted
public void setBlockUntilCompleted(boolean blockUntilCompleted)
Set whether to letexecute(java.lang.Runnable)
block until the work has been completed.Uses the JCA
doWork
operation underneath, instead of the defaultscheduleWork
.
setWorkListener
public void setWorkListener(@Nullable WorkListener workListener)
Specify a JCA 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
getDefaultWorkManager
protected WorkManager getDefaultWorkManager()
Obtain a default WorkManager to delegate to. Called if no explicit WorkManager or WorkManager JNDI name has been specified.The default implementation returns a
SimpleTaskWorkManager
. Can be overridden in subclasses.
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
doWork
public void doWork(Work work) throws WorkException
- 指定者:
doWork
在接口中WorkManager
- 抛出:
WorkException
doWork
public void doWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener) throws WorkException
- 指定者:
doWork
在接口中WorkManager
- 抛出:
WorkException
startWork
public long startWork(Work work) throws WorkException
- 指定者:
startWork
在接口中WorkManager
- 抛出:
WorkException
startWork
public long startWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener) throws WorkException
- 指定者:
startWork
在接口中WorkManager
- 抛出:
WorkException
scheduleWork
public void scheduleWork(Work work) throws WorkException
- 指定者:
scheduleWork
在接口中WorkManager
- 抛出:
WorkException
scheduleWork
public void scheduleWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener) throws WorkException
- 指定者:
scheduleWork
在接口中WorkManager
- 抛出:
WorkException