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

Class DefaultBatchJobInstanceStore

java.lang.Object

com.mulesoft.mule.runtime.module.batch.internal.BaseBatchProcessingListenerOwner

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

All Implemented Interfaces:

BatchProcessingListenersOwner, BatchJobInstanceStore, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.core.api.context.MuleContextAware

public class DefaultBatchJobInstanceStore
extends BaseBatchProcessingListenerOwner
implements BatchJobInstanceStore, org.mule.runtime.core.api.context.MuleContextAware, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable

Implementation of BatchJobInstanceStore that uses ObjectStore for a persistence mechanism

Since:

3.5.0

Field Summary

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultBatchJobInstanceStore()

Method Summary

Modifier and Type	Method and Description
void	clearFailedRecords(BatchJobInstanceAdapter jobInstance) Removes all the failed records records stored for the given BatchJobAdapter
List<BatchJobInstanceAdapter>	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
void	initialise()
boolean	remove(com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance jobInstance) removes the given BatchJobInstance
void	setMuleContext(org.mule.runtime.core.api.MuleContext muleContext)
void	start()
void	store(BatchJobInstanceAdapter jobInstance) Stores the given job instance
void	storeFailedRecords(BatchJobInstanceAdapter jobInstance, Collection<Record> records) Adds the given Records to the list of failed records
void	update(BatchJobInstanceAdapter jobInstance) updates the given job instance.

Methods inherited from class com.mulesoft.mule.runtime.module.batch.internal.BaseBatchProcessingListenerOwner

addBatchProcessingListener, addBatchProcessingListener, getListeners, removeBatchProcessingListener, removeBatchProcessingListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addBatchProcessingListener, addBatchProcessingListener, removeBatchProcessingListener, removeBatchProcessingListener

Constructor Detail

DefaultBatchJobInstanceStore

public DefaultBatchJobInstanceStore()

Method Detail

store

public void store(BatchJobInstanceAdapter jobInstance)

Stores the given job instance

Specified by:

store in interface BatchJobInstanceStore

Parameters:

jobInstance - a BatchJobInstanceAdapter

update

public void update(BatchJobInstanceAdapter jobInstance)

updates the given job instance.

Specified by:

update in interface BatchJobInstanceStore

Parameters:

jobInstance - a BatchJobInstanceAdapter

remove

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

removes the given BatchJobInstance

Specified by:

remove in interface BatchJobInstanceStore

Parameters:

jobInstance - a BatchJobInstance

Returns:

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

getFailedRecords

public Iterator<Record> getFailedRecords(BatchJobInstanceAdapter jobInstance)

Description copied from interface: BatchJobInstanceStore

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

Specified by:

getFailedRecords in interface BatchJobInstanceStore

Parameters:

jobInstance - an instance of BatchJobInstanceAdapter

Returns:

a Iterator

clearFailedRecords

public void clearFailedRecords(BatchJobInstanceAdapter jobInstance)

Removes all the failed records records stored for the given BatchJobAdapter

Specified by:

clearFailedRecords in interface BatchJobInstanceStore

Parameters:

jobInstance - an instance of BatchJobInstanceAdapter

storeFailedRecords

public void storeFailedRecords(BatchJobInstanceAdapter jobInstance,
                               Collection<Record> records)

Adds the given Records to the list of failed records This implementation splits the passed records into separate object stores depending on whether they're failed or no using buffers to save IO

Specified by:

storeFailedRecords in interface BatchJobInstanceStore

Parameters:

jobInstance - an instance of BatchJobInstanceAdapter

records - a Record which processing has finished

getJobInstance

public BatchJobInstanceAdapter getJobInstance(String jobName,
                                              String jobInstanceId)

Returns the BatchJobInstanceAdapter for the given job and id

Specified by:

getJobInstance in interface BatchJobInstanceStore

Parameters:

jobName - the name of the owner BatchJob

jobInstanceId - the id of the job instance

Returns:

a BatchJobInstanceAdapter or null if none exists.

getJobInstances

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

Returns all the BatchJobInstance for the given job name

Specified by:

getJobInstances in interface BatchJobInstanceStore

Parameters:

jobName - a non empty String

Returns:

a Iterator of BatchJobInstance

getExecutingInstances

public List<BatchJobInstanceAdapter> 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.

Specified by:

getExecutingInstances in interface BatchJobInstanceStore

Returns:

a List of BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

setMuleContext

public void setMuleContext(org.mule.runtime.core.api.MuleContext muleContext)

Specified by:

setMuleContext in interface org.mule.runtime.core.api.context.MuleContextAware