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

Interface BatchJobInstanceStore

All Superinterfaces:

BatchProcessingListenersOwner

All Known Implementing Classes:

DefaultBatchJobInstanceStore

public interface BatchJobInstanceStore
extends BatchProcessingListenersOwner

This interface defines the behavior expected from the component that the BatchEngine will use to to handle its persistent data

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
void	clearFailedRecords(BatchJobInstanceAdapter jobInstance) Removes all the failed records records stored for the given BatchJobAdapter
<T extends com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance> List<T>	getExecutingInstances() Retrieves all the BatchJobInstance that are currently elegible for execution.
Iterator<Record>	getFailedRecords(BatchJobInstanceAdapter jobInstance) Retrieves all the records of the given BatchJobInstanceAdapter that failed in at least one step and which execution has finished
BatchJobInstanceAdapter	getJobInstance(String jobName, String jobInstanceId) Returns the BatchJobInstanceAdapter for the given job and id
<T extends com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance> Iterator<T>	getJobInstances(String jobName) Returns all the BatchJobInstance for the given job name
boolean	remove(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance) removes the given BatchJobInstance
void	store(BatchJobInstanceAdapter jobInstance) Stores the given job instance
void	storeFailedRecords(BatchJobInstanceAdapter jobInstance, Collection<Record> record) Adds the given Records to the list of failed records
void	update(BatchJobInstanceAdapter jobInstance) updates the given job instance.

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

addBatchProcessingListener, addBatchProcessingListener, removeBatchProcessingListener, removeBatchProcessingListener

Method Detail

store

void store(BatchJobInstanceAdapter jobInstance)

Stores the given job instance

Parameters:

jobInstance - a BatchJobInstanceAdapter

Throws:

IllegalStateException - if the instance already exists in the store

update

void update(BatchJobInstanceAdapter jobInstance)

updates the given job instance.

Parameters:

jobInstance - a BatchJobInstanceAdapter

remove

boolean remove(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance)

removes the given BatchJobInstance

Parameters:

jobInstance - a BatchJobInstance

Returns:

true if the jobInstance was contained in the store. false otherwise

getFailedRecords

Iterator<Record> getFailedRecords(BatchJobInstanceAdapter jobInstance)

Retrieves all the records of the given BatchJobInstanceAdapter that failed in at least one step and which execution has finished

Parameters:

jobInstance - an instance of BatchJobInstanceAdapter

Returns:

a Iterator

clearFailedRecords

void clearFailedRecords(BatchJobInstanceAdapter jobInstance)

Removes all the failed records records stored for the given BatchJobAdapter

Parameters:

jobInstance - an instance of BatchJobInstanceAdapter

storeFailedRecords

void storeFailedRecords(BatchJobInstanceAdapter jobInstance,
                        Collection<Record> record)

Adds the given Records to the list of failed records

Parameters:

jobInstance - an instance of BatchJobInstanceAdapter

record - a Record which processing has finished

getJobInstance

BatchJobInstanceAdapter getJobInstance(String jobName,
                                       String jobInstanceId)

Returns the BatchJobInstanceAdapter for the given job and id

Parameters:

jobName - the name of the owner BatchJob

jobInstanceId - the id of the job instance

Returns:

a BatchJobInstanceAdapter or null if none exists.

getJobInstances

<T extends com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance> Iterator<T> getJobInstances(String jobName)

Returns all the BatchJobInstance for the given job name

Parameters:

jobName - a non empty String

Returns:

a Iterator of BatchJobInstance

getExecutingInstances

<T extends com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance> List<T> getExecutingInstances()
                                                                                               throws org.mule.runtime.api.exception.MuleException

Retrieves all the BatchJobInstance that are currently elegible for execution. This method has to be thread-safe, meaning that if two threads concurrently invoke this method, the returned list has to be navigable and modifiable by the two threads without causing issues. This can be achieved by either returning a synchronized list, returning different copies of the list or whatever mechanism you see fit in your case.

Returns:

a List of BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException