|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.jca.work.WorkManagerTaskExecutor
public class WorkManagerTaskExecutor
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.
setWorkManager(javax.resource.spi.work.WorkManager)
,
WorkManager.scheduleWork(javax.resource.spi.work.Work)
Field Summary |
---|
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 | |
---|---|
WorkManagerTaskExecutor()
Create a new WorkManagerTaskExecutor, expecting bean-style configuration. |
|
WorkManagerTaskExecutor(WorkManager workManager)
Create a new WorkManagerTaskExecutor for the given WorkManager. |
Method Summary | |
---|---|
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 . |
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 |
setWorkListener(WorkListener workListener)
Specify a JCA 1.5 WorkListener to apply, if any. |
void |
setWorkManager(WorkManager workManager)
Specify the JCA WorkManager to delegate to. |
long |
startWork(Work work)
|
long |
startWork(Work work,
long delay,
ExecutionContext executionContext,
WorkListener workListener)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WorkManagerTaskExecutor()
public WorkManagerTaskExecutor(WorkManager workManager)
workManager
- the JCA WorkManager to delegate toMethod Detail |
---|
public void setWorkManager(WorkManager workManager)
public void setBootstrapContext(BootstrapContext bootstrapContext)
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(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 execute(Runnable task)
TaskExecutor
task
.
The call might return immediately if the implementation uses an asynchronous execution strategy, or might block in the case of synchronous execution.
execute
in interface TaskExecutor
task
- the Runnable
to execute (never null
)public void execute(Runnable task, long startTimeout)
AsyncTaskExecutor
task
.
execute
in interface AsyncTaskExecutor
task
- the Runnable
to execute (never null
)startTimeout
- the time duration 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)
).public boolean prefersShortLivedTasks()
prefersShortLivedTasks
in interface SchedulingTaskExecutor
true
if this TaskExecutor
prefers
short-lived taskspublic 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
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |