com.mulesoft.mule.runtime.module.batch.internal.engine.threading

Interface BatchWorkManager

All Superinterfaces:

org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

All Known Implementing Classes:

DefaultBatchWorkManager

public interface BatchWorkManager
extends org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Manages and schedules all the concurrent BatchRecordWork needed to process one or many BatchJobInstanceAdapter in parallel.

It not only manages the execution of such tasks but also the underlying Scheduler instances

Since:

3.5.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
void	awaitStop(BatchJobInstanceAdapter jobInstance) Makes the given jobInstance no longer executable (further invocations to scheduleRecordWork(BatchTransactionContext, Runnable) will fail, and also waits for the currently scheduled tasks to complete before returning
void	executable(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance) Tracks the given jobInstance as an executable one.
void	scheduleManagementWork(Runnable work) Schedules the asynchronous execution of a job management task.
void	scheduleRecordWork(BatchTransactionContext ctx, Runnable work) Schedules the given work to be executed.

Methods inherited from interface org.mule.runtime.api.lifecycle.Startable

start

Methods inherited from interface org.mule.runtime.api.lifecycle.Stoppable

stop

Method Detail

executable

void executable(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance)

Tracks the given jobInstance as an executable one. Invoking scheduleRecordWork(BatchTransactionContext, Runnable) before registering the corresponding job instance with this method, will result in an IllegalStateException.

Furthermore, it's the invoker's responsibility to eventually call the awaitStop(BatchJobInstanceAdapter) to un-track the job instance and properly release resources

Parameters:

jobInstance - an executable jobInstance

scheduleRecordWork

void scheduleRecordWork(BatchTransactionContext ctx,
                        Runnable work)
                 throws RejectedExecutionException

Schedules the given work to be executed. If this method is invoked while the MuleContext is stopped or stopping, then the work is silently discarded and the context is rolled back.

Parameters:

ctx - the BatchTransactionContext referencing the transaction of which work is a part of

work - a javax.resource.spi.work.Work

Throws:

RejectedExecutionException - if the underlying Executor cannot execute the given work.

IllegalStateException - if the job instance pointed by the ctx was not previously registered through executable(BatchJobInstance)

scheduleManagementWork

void scheduleManagementWork(Runnable work)

Schedules the asynchronous execution of a job management task. These tasks should not involve record processing

Parameters:

work - the task to execute

awaitStop

void awaitStop(BatchJobInstanceAdapter jobInstance)

Makes the given jobInstance no longer executable (further invocations to scheduleRecordWork(BatchTransactionContext, Runnable) will fail, and also waits for the currently scheduled tasks to complete before returning

Parameters:

jobInstance - an executable jobInstance