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

Interface BatchEngine

All Superinterfaces:

BatchProcessingListenersOwner

All Known Implementing Classes:

DefaultBatchEngine

@NoImplement
public interface BatchEngine
extends BatchProcessingListenersOwner

Contains the main logic to execute and orchestrate a BatchJobInstance

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
void	cancel(BatchJobInstanceAdapter jobInstance) Stops the jobInstance if it's executing (by delegating into stopExecution(BatchJobInstanceAdapter, boolean).
void	cancelAllRunningInstance() Invokes cancel(BatchJobInstanceAdapter) on every running instance of any job
org.mule.runtime.core.api.event.CoreEvent.Builder	createEventBuilder(Record record, BatchJobInstanceAdapter jobInstance) Creates a new CoreEvent.Builder with the base attributes set for a CoreEvent to process the given record for the given jobInstance.
org.mule.runtime.core.api.event.CoreEvent.Builder	createEventBuilder(Record record, BatchJobInstanceAdapter jobInstance, CompletableFuture<Void> externalCompletion) Creates a new CoreEvent.Builder with the base attributes set for a CoreEvent to process the given record for the given jobInstance.
BatchJobInstanceAdapter	createNewJobInstance(BatchJobAdapter job, org.mule.runtime.core.api.event.CoreEvent event) Creates and initialises a new BatchJobInstanceAdapter related to the given job.
BatchTransactionContext	createTransactionContext(BatchJobInstanceAdapter jobInstance) Creates a new BatchTransactionContext referencing the given {@link BatchJobInstanceAdapter}
BatchJobInstanceAdapter	finishExecution(BatchJobInstanceAdapter jobInstance, boolean shouldRefresh) Ends the execution of the given jobInstance
Collection<BatchJob>	getBatchJobs() Returns all defined BatchJobs
BatchQueueManager	getBatchQueueManager() Returns the BatchQueueManager in which queueing operations are delegated
BatchTransactionContextFactory	getBatchTransactionContextFactory() For monitoring and testing purposes only
List<Record>	getBlockFrom(BatchTransactionContext context) Returns the records in the stepping queue which corresponds to the BatchJobInstance referenced by the given context
int	getBlockSize(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance) Returns the BatchJobAdapter.getBlockSize() for the BatchJob that owns the given jobInstance
Optional<BatchJob>	getJob(String jobName)
BatchJobAdapter	getJobFor(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance) Returns the owning BatchJobAdapter for the given BatchJobInstance
BatchJobInstanceStore	getJobInstanceStore() Returns the BatchJobInstanceStore in which persistence operations are delegated on
Lock	getLock(BatchJobInstanceAdapter jobInstance) Obtains a Lock for the given jobInstance.
long	getSteppingQueueSize(BatchTransactionContext context) Deprecated. on 4.3.0, use getBlockFrom(BatchTransactionContext)
BatchJobInstanceAdapter	load(BatchJobInstanceAdapter jobInstance, org.mule.runtime.core.api.event.CoreEvent muleEvent) Splits the CoreEvent payload and loads it into the BatchJobInstanceAdapter queue.
void	registerBatchJob(BatchJobAdapter batchJob)
void	releaseResources(BatchJobInstanceAdapter jobInstance, boolean includeFailedRecords) Releases the resources still allocated to the given BatchJobInstanceAdapter, including queues and storage
void	resumeExecution(BatchJobInstanceAdapter jobInstance) Resumes execution of a BatchJobInstance which was stopped through the stopExecution(BatchJobInstanceAdapter, boolean) method.
void	startExecution(BatchJobInstanceAdapter jobInstance) Starts asynchronous execution of the given BatchJobInstanceAdapter.
void	stopExecution(BatchJobInstanceAdapter jobInstance, boolean markAsFailed) Stops the execution of the given BatchJobInstanceAdapter.
BatchJobInstanceAdapter	updateStatisticsAndRoute(BatchTransactionContext ctx, List<Record> records)

Methods inherited from interface com.mulesoft.mule.runtime.module.batch.BatchProcessingListenersOwner

addBatchProcessingListener, addBatchProcessingListener, removeBatchProcessingListener, removeBatchProcessingListener

Method Detail

registerBatchJob

void registerBatchJob(BatchJobAdapter batchJob)

createNewJobInstance

BatchJobInstanceAdapter createNewJobInstance(BatchJobAdapter job,
                                             org.mule.runtime.core.api.event.CoreEvent event)
                                      throws org.mule.runtime.api.exception.MuleException

Creates and initialises a new BatchJobInstanceAdapter related to the given job. The returned instance will be already persisted

Parameters:

job - the BatchJobAdapter being executed

event - the CoreEvent that triggered the job's execution

Returns:

a new persistent instance of BatchJobInstanceAdapter

Throws:

org.mule.runtime.api.exception.MuleException

createTransactionContext

BatchTransactionContext createTransactionContext(BatchJobInstanceAdapter jobInstance)

Creates a new BatchTransactionContext referencing the given {@link BatchJobInstanceAdapter}

Parameters:

jobInstance - a not null BatchJobInstanceAdapter

Returns:

a new BatchTransactionContext

startExecution

void startExecution(BatchJobInstanceAdapter jobInstance)
             throws org.mule.runtime.api.exception.MuleException

Starts asynchronous execution of the given BatchJobInstanceAdapter. The instance will be persisted at this point and will become elegible for execution by the steps. It also fires a BatchNotification.JOB_PROCESS_RECORDS_BEGIN notification

Parameters:

jobInstance - the BatchJobInstanceAdapter to be executed

Throws:

org.mule.runtime.api.exception.MuleException

stopExecution

void stopExecution(BatchJobInstanceAdapter jobInstance,
                   boolean markAsFailed)
            throws org.mule.runtime.api.exception.MuleException

Stops the execution of the given BatchJobInstanceAdapter. This doesn't mean that all threads processing records will immediately stop. It means that no more records will be taken out of the queue and start processing. All records currently being processed will complete their normal execution. if markAsFailed is true the jobInstance status will be set to BatchJobInstanceStatus.FAILED_PROCESS_RECORDS and a BatchNotification.JOB_PROCESS_RECORDS_FAILED notification will be fired. Otherwise, the status will be set to BatchJobInstanceStatus.STOPPED and a BatchNotification.JOB_STOPPED notification is fired instead.

Parameters:

jobInstance - a BatchJobInstanceAdapter

markAsFailed - if true the jobInstance status will be set to BatchJobInstanceStatus.FAILED_PROCESS_RECORDS. Otherwise it will be set to BatchNotification.JOB_STOPPED

Throws:

org.mule.runtime.api.exception.MuleException

resumeExecution

void resumeExecution(BatchJobInstanceAdapter jobInstance)
              throws org.mule.runtime.api.exception.MuleException

Resumes execution of a BatchJobInstance which was stopped through the stopExecution(BatchJobInstanceAdapter, boolean) method.

Execution is resumed by setting the job instance status back to BatchJobInstanceStatus.EXECUTING. The BatchNotification.JOB_PROCESS_RECORDS_BEGIN notification will be fired again.

Parameters:

jobInstance - the BatchJobInstanceAdapter to be resmed

Throws:

IllegalStateException - if the BatchJobInstance is in a state other than BatchJobInstanceStatus.STOPPED

org.mule.runtime.api.exception.MuleException - in case of unhandled error

cancel

void cancel(BatchJobInstanceAdapter jobInstance)
     throws org.mule.runtime.api.exception.MuleException

Stops the jobInstance if it's executing (by delegating into stopExecution(BatchJobInstanceAdapter, boolean). Finally, the instance's resources are released (by delegating into releaseResources(BatchJobInstanceAdapter, boolean) and a BatchNotification.JOB_CANCELLED notification is fired

Parameters:

jobInstance - a BatchJobInstanceAdapter

Throws:

org.mule.runtime.api.exception.MuleException

cancelAllRunningInstance

void cancelAllRunningInstance()
                       throws org.mule.runtime.api.exception.MuleException

Invokes cancel(BatchJobInstanceAdapter) on every running instance of any job

Throws:

org.mule.runtime.api.exception.MuleException

createEventBuilder

org.mule.runtime.core.api.event.CoreEvent.Builder createEventBuilder(Record record,
                                                                     BatchJobInstanceAdapter jobInstance)

Creates a new CoreEvent.Builder with the base attributes set for a CoreEvent to process the given record for the given jobInstance. This method will create a copy of the original event that generated the jobInstance, will set the record's payload as the message payload and will put the record in an invocation property under the key in BatchProperties.RECORD_VARIABLE_NAME

Parameters:

record - an instance of Record

jobInstance - an instance of BatchJobInstanceAdapter

Returns:

a new instance of CoreEvent.Builder

createEventBuilder

org.mule.runtime.core.api.event.CoreEvent.Builder createEventBuilder(Record record,
                                                                     BatchJobInstanceAdapter jobInstance,
                                                                     CompletableFuture<Void> externalCompletion)

Creates a new CoreEvent.Builder with the base attributes set for a CoreEvent to process the given record for the given jobInstance. This method will create a copy of the original event that generated the jobInstance, will set the record's payload as the message payload and will put the record in an invocation property under the key in BatchProperties.RECORD_VARIABLE_NAME

Parameters:

record - an instance of Record

jobInstance - an instance of BatchJobInstanceAdapter

externalCompletion - A custom completion callback for the event context. If null, then default completion will be used

Returns:

a new instance of CoreEvent.Builder

load

BatchJobInstanceAdapter load(BatchJobInstanceAdapter jobInstance,
                             org.mule.runtime.core.api.event.CoreEvent muleEvent)
                      throws org.mule.runtime.api.exception.MuleException

Splits the CoreEvent payload and loads it into the BatchJobInstanceAdapter queue. If this process fails, the job instance's resources are released.

Parameters:

jobInstance - a BatchJobInstanceAdapter

muleEvent - a CoreEvent which payload is splittable

Returns:

a BatchJobInstanceAdapter which state has been updated to reflect this operation's result

Throws:

org.mule.runtime.api.exception.MuleException

getJobInstanceStore

BatchJobInstanceStore getJobInstanceStore()

Returns the BatchJobInstanceStore in which persistence operations are delegated on

Returns:

a BatchJobInstance

getBatchQueueManager

BatchQueueManager getBatchQueueManager()

Returns the BatchQueueManager in which queueing operations are delegated

Returns:

a BatchQueueManager

updateStatisticsAndRoute

BatchJobInstanceAdapter updateStatisticsAndRoute(BatchTransactionContext ctx,
                                                 List<Record> records)
                                          throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

getSteppingQueueSize

@Deprecated
long getSteppingQueueSize(BatchTransactionContext context)

Deprecated. on 4.3.0, use getBlockFrom(BatchTransactionContext)

Returns the amount of records in the stepping queue which corresponds to the BatchJobInstance referenced by the given context

Parameters:

context - the context for a current transaction

Returns:

the number of queued records. Will be greater or equal to zero

releaseResources

void releaseResources(BatchJobInstanceAdapter jobInstance,
                      boolean includeFailedRecords)

Releases the resources still allocated to the given BatchJobInstanceAdapter, including queues and storage

Parameters:

jobInstance - a BatchJobInstanceAdapter

includeFailedRecords - if true, the stored failed records will also be wiped out.

getJobFor

BatchJobAdapter getJobFor(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance)

Returns the owning BatchJobAdapter for the given BatchJobInstance

Parameters:

jobInstance - a BatchJobInstance

Returns:

a BatchJobAdapter

getBatchJobs

Collection<BatchJob> getBatchJobs()

Returns all defined BatchJobs

Returns:

a Collection of BatchJob. The collection might be empty but will never be null

getJob

Optional<BatchJob> getJob(String jobName)

getBlockSize

int getBlockSize(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance)

Returns the BatchJobAdapter.getBlockSize() for the BatchJob that owns the given jobInstance

Parameters:

jobInstance - a BatchJobInstance

Returns:

the owner job's block size

Since:

3.8.0

getLock

Lock getLock(BatchJobInstanceAdapter jobInstance)

Obtains a Lock for the given jobInstance. Invoking this method with difference instances which share the same id, will always return the same lock

Parameters:

jobInstance - a BatchJobInstanceAdapter

Returns:

a Lock

finishExecution

BatchJobInstanceAdapter finishExecution(BatchJobInstanceAdapter jobInstance,
                                        boolean shouldRefresh)
                                 throws org.mule.runtime.api.exception.MuleException

Ends the execution of the given jobInstance

Parameters:

jobInstance - a BatchJobInstanceAdapter

shouldRefresh - whether the instance should be reloaded from the store to update its state

Returns:

an updated BatchJobInstanceAdapter

Throws:

org.mule.runtime.api.exception.MuleException

getBatchTransactionContextFactory

BatchTransactionContextFactory getBatchTransactionContextFactory()

For monitoring and testing purposes only

Returns:

the current BatchTransactionContextFactory

getBlockFrom

List<Record> getBlockFrom(BatchTransactionContext context)

Returns the records in the stepping queue which corresponds to the BatchJobInstance referenced by the given context

Parameters:

context - the context for a current transaction

Returns:

the queued records.