public class WorkManagerTaskExecutor extends org.springframework.jndi.JndiLocatorSupport implements org.springframework.core.task.AsyncListenableTaskExecutor, org.springframework.scheduling.SchedulingTaskExecutor, WorkManager, BootstrapContextAware, org.springframework.beans.factory.InitializingBean
TaskExecutor
implementation
that delegates to a JCA 1.7 WorkManager, implementing the
WorkManager
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.
setWorkManager(javax.resource.spi.work.WorkManager)
,
WorkManager.scheduleWork(javax.resource.spi.work.Work)
TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE
IMMEDIATE, INDEFINITE, UNKNOWN
Constructor and Description |
---|
WorkManagerTaskExecutor()
Create a new WorkManagerTaskExecutor, expecting bean-style configuration.
|
WorkManagerTaskExecutor(WorkManager workManager)
Create a new WorkManagerTaskExecutor for the given WorkManager.
|
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet() |
void |
doWork(Work work) |
void |
doWork(Work work,
long delay,
ExecutionContext executionContext,
WorkListener workListener) |
void |
execute(Runnable task) |
void |
execute(Runnable task,
long startTimeout) |
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 let
execute(java.lang.Runnable) block until the work
has been completed. |
void |
setBlockUntilStarted(boolean blockUntilStarted)
Set whether to let
execute(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(org.springframework.core.task.TaskDecorator taskDecorator)
Specify a custom
TaskDecorator to be applied to any Runnable
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) |
<T> Future<T> |
submit(Callable<T> task) |
Future<?> |
submit(Runnable task) |
<T> org.springframework.util.concurrent.ListenableFuture<T> |
submitListenable(Callable<T> task) |
org.springframework.util.concurrent.ListenableFuture<?> |
submitListenable(Runnable task) |
convertJndiName, isResourceRef, lookup, lookup, setResourceRef
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate
public WorkManagerTaskExecutor()
public WorkManagerTaskExecutor(WorkManager workManager)
workManager
- the JCA WorkManager to delegate topublic void setWorkManager(WorkManager workManager)
public void setWorkManagerName(String workManagerName)
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".
setWorkManager(javax.resource.spi.work.WorkManager)
,
JndiLocatorSupport.setResourceRef(boolean)
public void setBootstrapContext(BootstrapContext bootstrapContext)
setBootstrapContext
in interface BootstrapContextAware
bootstrapContext
- the BootstrapContext object to be used by this objectInitializingBean.afterPropertiesSet()
,
ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
public void setBlockUntilStarted(boolean blockUntilStarted)
execute(java.lang.Runnable)
block until the work
has been actually started.
Uses the JCA startWork
operation underneath,
instead of the default scheduleWork
.
public void setBlockUntilCompleted(boolean blockUntilCompleted)
execute(java.lang.Runnable)
block until the work
has been completed.
Uses the JCA doWork
operation underneath,
instead of the default scheduleWork
.
public void setWorkListener(@Nullable WorkListener workListener)
This shared WorkListener instance will be passed on to the
WorkManager by all execute(java.lang.Runnable)
calls on this TaskExecutor.
public void setTaskDecorator(org.springframework.core.task.TaskDecorator taskDecorator)
TaskDecorator
to be applied to any Runnable
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.
public void afterPropertiesSet() throws NamingException
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
NamingException
protected WorkManager getDefaultWorkManager()
The default implementation returns a SimpleTaskWorkManager
.
Can be overridden in subclasses.
public void execute(Runnable task)
public void execute(Runnable task, long startTimeout)
execute
in interface org.springframework.core.task.AsyncTaskExecutor
public Future<?> submit(Runnable task)
submit
in interface org.springframework.core.task.AsyncTaskExecutor
public <T> Future<T> submit(Callable<T> task)
submit
in interface org.springframework.core.task.AsyncTaskExecutor
public org.springframework.util.concurrent.ListenableFuture<?> submitListenable(Runnable task)
submitListenable
in interface org.springframework.core.task.AsyncListenableTaskExecutor
public <T> org.springframework.util.concurrent.ListenableFuture<T> submitListenable(Callable<T> task)
submitListenable
in interface org.springframework.core.task.AsyncListenableTaskExecutor
public void doWork(Work work) throws WorkException
doWork
in interface WorkManager
WorkException
public void doWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener) throws WorkException
doWork
in interface WorkManager
WorkException
public long startWork(Work work) throws WorkException
startWork
in interface WorkManager
WorkException
public long startWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener) throws WorkException
startWork
in interface WorkManager
WorkException
public void scheduleWork(Work work) throws WorkException
scheduleWork
in interface WorkManager
WorkException
public void scheduleWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener) throws WorkException
scheduleWork
in interface WorkManager
WorkException