WorkManagerTaskExecutor

Class Overview

TaskExecutor implementation that delegates to a CommonJ WorkManager, implementing the commonj.work.WorkManager 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: At the time of this writing, the CommonJ WorkManager facility is only supported on IBM WebSphere 6.0+ and BEA WebLogic 9.0+, despite being such a crucial API for an application server. (There is a similar facility available on WebSphere 5.1 Enterprise, though, which we will discuss below.)

On JBoss and GlassFish, a similar facility is available through the JCA WorkManager. See the JBossWorkManagerTaskExecutor GlassFishWorkManagerTaskExecutor classes which are the direct equivalent of this CommonJ adapter class.

A similar facility is available on WebSphere 5.1, under the name "Asynch Beans". Its central interface is called WorkManager too and is also obtained from JNDI, just like a standard CommonJ WorkManager. However, this WorkManager variant is notably different: The central execution method is called "startWork" instead of "schedule", and takes a slightly different Work interface as parameter.

Support for this WebSphere 5.1 variant can be built with this class and its helper DelegatingWork as template: Call the WorkManager's startWork(Work) instead of schedule(Work) in the execute(Runnable) implementation. Furthermore, for simplicity's sake, drop the entire "Implementation of the CommonJ WorkManager interface" section (and the corresponding implements WorkManager clause at the class level). Of course, you also need to change all commonj.work imports in your WorkManagerTaskExecutor and DelegatingWork variants to the corresponding WebSphere API imports (com.ibm.websphere.asynchbeans.WorkManager and com.ibm.websphere.asynchbeans.Work, respectively). This should be sufficient to get a TaskExecutor adapter for WebSphere 5.

Summary

[Expand] Inherited Constants
From class org.springframework.jndi.JndiLocatorSupport String CONTAINER_PREFIX JNDI prefix used in a J2EE container
From interface org.springframework.core.task.AsyncTaskExecutor long TIMEOUT_IMMEDIATE Constant that indicates immediate execution long TIMEOUT_INDEFINITE Constant that indicates no time limit

[Expand] Inherited Fields
From class org.springframework.jndi.JndiAccessor protected final Log logger Logger, available to subclasses.

[Expand] Inherited Methods
From class org.springframework.jndi.JndiLocatorSupport String convertJndiName(String jndiName) Convert the given JNDI name into the actual JNDI name to use. boolean isResourceRef() Return whether the lookup occurs in a J2EE container. <T> T lookup(String jndiName, Class<T> requiredType) Perform an actual JNDI lookup for the given name via the JndiTemplate. Object lookup(String jndiName) Perform an actual JNDI lookup for the given name via the JndiTemplate. void setResourceRef(boolean resourceRef) Set whether the lookup occurs in a J2EE container, i.e.
From class org.springframework.jndi.JndiAccessor Properties getJndiEnvironment() Return the JNDI environment to use for JNDI lookups. JndiTemplate getJndiTemplate() Return the JNDI template to use for JNDI lookups. void setJndiEnvironment(Properties jndiEnvironment) Set the JNDI environment to use for JNDI lookups. void setJndiTemplate(JndiTemplate jndiTemplate) Set the JNDI template to use for JNDI lookups.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface java.util.concurrent.Executor abstract void execute(Runnable arg0)
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.core.task.AsyncTaskExecutor abstract void execute(Runnable task, long startTimeout) Execute the given task. abstract <T> Future<T> submit(Callable<T> task) Submit a Callable task for execution, receiving a Future representing that task. abstract Future<?> submit(Runnable task) Submit a Runnable task for execution, receiving a Future representing that task.
From interface org.springframework.core.task.TaskExecutor abstract void execute(Runnable task) Execute the given task.
From interface org.springframework.scheduling.SchedulingTaskExecutor abstract boolean prefersShortLivedTasks() Does this TaskExecutor prefer short-lived tasks over long-lived tasks? A SchedulingTaskExecutor implementation can indicate whether it prefers submitted tasks to perform as little work as they can within a single task execution.