java.lang.Object
- org.springframework.jndi.JndiAccessor
- - org.springframework.jndi.JndiLocatorSupport
  - - org.springframework.jca.work.WorkManagerTaskExecutor

All Implemented Interfaces:
Executor, WorkManager, Aware, InitializingBean, AsyncListenableTaskExecutor, AsyncTaskExecutor, TaskExecutor, BootstrapContextAware, SchedulingTaskExecutor
Direct Known Subclasses:
GlassFishWorkManagerTaskExecutor, JBossWorkManagerTaskExecutor
```
public class WorkManagerTaskExecutor
extends JndiLocatorSupport
implements AsyncListenableTaskExecutor, SchedulingTaskExecutor, WorkManager, BootstrapContextAware, InitializingBean
```
TaskExecutor implementation that delegates to a JCA 1.5 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.5 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 JCA 1.5 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 J2EE environment through "gbean-ref" entries in the geronimo-web.xml deployment descriptor.
On JBoss and GlassFish, obtaining the default JCA WorkManager requires special lookup steps. See the JBossWorkManagerTaskExecutorGlassFishWorkManagerTaskExecutor classes which are the direct equivalent of this generic JCA adapter class.
Since:
2.0.3
Author:
Juergen Hoeller
See Also:
setWorkManager(javax.resource.spi.work.WorkManager), WorkManager.scheduleWork(javax.resource.spi.work.Work)

Field Summary
- Fields inherited from class org.springframework.jndi.JndiLocatorSupport
  CONTAINER_PREFIX
- Fields inherited from class org.springframework.jndi.JndiAccessor
  logger
- Fields inherited from interface org.springframework.core.task.AsyncTaskExecutor
  TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE
- Fields inherited from interface javax.resource.spi.work.WorkManager
  IMMEDIATE, INDEFINITE, UNKNOWN

Constructor Summary

Constructors
Constructor	Description
`WorkManagerTaskExecutor()`	Create a new WorkManagerTaskExecutor, expecting bean-style configuration.
`WorkManagerTaskExecutor(WorkManager workManager)`	Create a new WorkManagerTaskExecutor for the given WorkManager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`afterPropertiesSet()`	Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc.
`void`	`doWork(Work work)`
`void`	`doWork(Work work, long delay, ExecutionContext executionContext, WorkListener workListener)`
`void`	`execute(Runnable task)`	Execute the given `task`.
`void`	`execute(Runnable task, long startTimeout)`	Execute the given `task`.
`protected WorkManager`	`getDefaultWorkManager()`	Obtain a default WorkManager to delegate to.
`boolean`	`prefersShortLivedTasks()`	This task executor prefers short-lived work units.
`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(TaskDecorator taskDecorator)`	Specify a custom `TaskDecorator` to be applied to any `Runnable` about to be executed.
`void`	`setWorkListener(WorkListener workListener)`	Specify a JCA 1.5 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 a `Runnable` task for execution, receiving a `ListenableFuture` representing that task.
`<T> ListenableFuture<T>`	`submitListenable(Callable<T> task)`	Submit a `Callable` task for execution, receiving a `ListenableFuture` representing that task.

Methods inherited from class org.springframework.jndi.JndiLocatorSupport
convertJndiName, isResourceRef, lookup, lookup, setResourceRef

Methods inherited from class org.springframework.jndi.JndiAccessor
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WorkManagerTaskExecutor
```
public WorkManagerTaskExecutor()
```
    Create a new WorkManagerTaskExecutor, expecting bean-style configuration.
    See Also:
    setWorkManager(javax.resource.spi.work.WorkManager)
  - WorkManagerTaskExecutor
```
public WorkManagerTaskExecutor(WorkManager workManager)
```
    Create a new WorkManagerTaskExecutor for the given WorkManager.
    Parameters:
    workManager - the JCA WorkManager to delegate to
- Method Detail
  - 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".
    See Also:
    setWorkManager(javax.resource.spi.work.WorkManager), JndiLocatorSupport.setResourceRef(boolean)
  - setBootstrapContext
```
public void setBootstrapContext(BootstrapContext bootstrapContext)
```
    Specify the JCA BootstrapContext that contains the WorkManager to delegate to.
    Specified by:
    setBootstrapContext in interface BootstrapContextAware
    Parameters:
    bootstrapContext - BootstrapContext object to be used by this object
    See Also:
    InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
  - setBlockUntilStarted
```
public void setBlockUntilStarted(boolean blockUntilStarted)
```
    Set whether to let execute(java.lang.Runnable) block until the work has been actually started.
    Uses the JCA startWork operation underneath, instead of the default scheduleWork.
    See Also:
    WorkManager.startWork(javax.resource.spi.work.Work), WorkManager.scheduleWork(javax.resource.spi.work.Work)
  - setBlockUntilCompleted
```
public void setBlockUntilCompleted(boolean blockUntilCompleted)
```
    Set whether to let execute(java.lang.Runnable) block until the work has been completed.
    Uses the JCA doWork operation underneath, instead of the default scheduleWork.
    See Also:
    WorkManager.doWork(javax.resource.spi.work.Work), WorkManager.scheduleWork(javax.resource.spi.work.Work)
  - setWorkListener
```
public void setWorkListener(WorkListener workListener)
```
    Specify a JCA 1.5 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 custom 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.
    NOTE: Exception handling in TaskDecorator implementations is limited to plain Runnable execution via execute calls. In case of #submit calls, the exposed Runnable will be a FutureTask which does not propagate any exceptions; you might have to cast it and call Future#get to evaluate exceptions.
    Since:
    4.3
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws NamingException
```
    Description copied from interface: InitializingBean
    Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, 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.
    Specified by:
    afterPropertiesSet in interface InitializingBean
    Throws:
    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)
```
    Description copied from interface: TaskExecutor
    Execute the given task.
    The call might return immediately if the implementation uses an asynchronous execution strategy, or might block in the case of synchronous execution.
    Specified by:
    execute in interface Executor
    Specified by:
    execute in interface TaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
  - execute
```
public void execute(Runnable task,
                    long startTimeout)
```
    Description copied from interface: AsyncTaskExecutor
    Execute the given task.
    Specified by:
    execute in interface AsyncTaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
    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 are AsyncTaskExecutor.TIMEOUT_IMMEDIATE or AsyncTaskExecutor.TIMEOUT_INDEFINITE (the default as used by TaskExecutor.execute(Runnable)).
  - submit
```
public Future<?> submit(Runnable task)
```
    Description copied from interface: AsyncTaskExecutor
    Submit a Runnable task for execution, receiving a Future representing that task. The Future will return a null result upon completion.
    Specified by:
    submit in interface AsyncTaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
    Returns:
    a Future representing pending completion of the task
  - submit
```
public <T> Future<T> submit(Callable<T> task)
```
    Description copied from interface: AsyncTaskExecutor
    Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion.
    Specified by:
    submit in interface AsyncTaskExecutor
    Parameters:
    task - the Callable to execute (never null)
    Returns:
    a Future representing pending completion of the task
  - submitListenable
```
public ListenableFuture<?> submitListenable(Runnable task)
```
    Description copied from interface: AsyncListenableTaskExecutor
    Submit a Runnable task for execution, receiving a ListenableFuture representing that task. The Future will return a null result upon completion.
    Specified by:
    submitListenable in interface AsyncListenableTaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
    Returns:
    a ListenableFuture representing pending completion of the task
  - submitListenable
```
public <T> ListenableFuture<T> submitListenable(Callable<T> task)
```
    Description copied from interface: AsyncListenableTaskExecutor
    Submit a Callable task for execution, receiving a ListenableFuture representing that task. The Future will return the Callable's result upon completion.
    Specified by:
    submitListenable in interface AsyncListenableTaskExecutor
    Parameters:
    task - the Callable to execute (never null)
    Returns:
    a ListenableFuture representing pending completion of the task
  - prefersShortLivedTasks
```
public boolean prefersShortLivedTasks()
```
    This task executor prefers short-lived work units.
    Specified by:
    prefersShortLivedTasks in interface SchedulingTaskExecutor
    Returns:
    true if this TaskExecutor prefers short-lived tasks
  - doWork
```
public void doWork(Work work)
            throws WorkException
```
    Specified by:
    doWork in interface WorkManager
    Throws:
    WorkException
  - doWork
```
public void doWork(Work work,
                   long delay,
                   ExecutionContext executionContext,
                   WorkListener workListener)
            throws WorkException
```
    Specified by:
    doWork in interface WorkManager
    Throws:
    WorkException
  - startWork
```
public long startWork(Work work)
               throws WorkException
```
    Specified by:
    startWork in interface WorkManager
    Throws:
    WorkException
  - startWork
```
public long startWork(Work work,
                      long delay,
                      ExecutionContext executionContext,
                      WorkListener workListener)
               throws WorkException
```
    Specified by:
    startWork in interface WorkManager
    Throws:
    WorkException
  - scheduleWork
```
public void scheduleWork(Work work)
                  throws WorkException
```
    Specified by:
    scheduleWork in interface WorkManager
    Throws:
    WorkException
  - scheduleWork
```
public void scheduleWork(Work work,
                         long delay,
                         ExecutionContext executionContext,
                         WorkListener workListener)
                  throws WorkException
```
    Specified by:
    scheduleWork in interface WorkManager
    Throws:
    WorkException

Class WorkManagerTaskExecutor

Field Summary

Fields inherited from class org.springframework.jndi.JndiLocatorSupport

Fields inherited from class org.springframework.jndi.JndiAccessor

Fields inherited from interface org.springframework.core.task.AsyncTaskExecutor

Fields inherited from interface javax.resource.spi.work.WorkManager

Constructor Summary

Method Summary

Methods inherited from class org.springframework.jndi.JndiLocatorSupport

Methods inherited from class org.springframework.jndi.JndiAccessor

Methods inherited from class java.lang.Object

Constructor Detail

WorkManagerTaskExecutor

WorkManagerTaskExecutor

Method Detail

setWorkManager

setWorkManagerName

setBootstrapContext

setBlockUntilStarted

setBlockUntilCompleted

setWorkListener

setTaskDecorator

afterPropertiesSet

getDefaultWorkManager

execute

execute

submit

submit

submitListenable

submitListenable

prefersShortLivedTasks

doWork

doWork

startWork

startWork

scheduleWork

scheduleWork