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

Class DefaultBatchManager

java.lang.Object

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

All Implemented Interfaces:

BatchManager

public class DefaultBatchManager
extends Object
implements BatchManager

Default implementation of BatchManager

Constructor Summary

Constructors

Constructor and Description
DefaultBatchManager()

Method Summary

Modifier and Type	Method and Description
void	cancel(String jobName, String jobInstanceId) Same as BatchManager.stop(String, String) but definitive.
void	cancelAllRunningInstances() Invokes BatchManager.cancel(String, String) for every BatchJobInstance in running state.
void	delete(String jobName, String jobInstanceId) Deletes the given BatchJobInstance from persistent store
Collection<BatchJob>	getBatchJobs() Returns all the BatchJob declared in the current mule context
Iterator<com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance>	getExecutingInstances() Returns the instance of BatchJobInstance that are in an executing state
com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance	getJobInstance(String jobName, String jobInstanceId) Finds a BatchJobInstance and returns it
Iterator<com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance>	getJobInstances(String jobName) Returns all the BatchJobInstance available for the given jobName
void	resume(String jobName, String jobInstanceId) Resumes execution of a BatchJobInstance which was stopped through the BatchManager.stop(String, String) method.
void	stop(String jobName, String jobInstanceId) Stops the BatchJobInstance of the given ids.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBatchManager

public DefaultBatchManager()

Method Detail

getBatchJobs

public Collection<BatchJob> getBatchJobs()

Returns all the BatchJob declared in the current mule context

Specified by:

getBatchJobs in interface BatchManager

Returns:

a collection of BatchJob

getJobInstance

public com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance getJobInstance(String jobName,
                                                                                  String jobInstanceId)
                                                                           throws org.mule.runtime.api.exception.MuleException

Finds a BatchJobInstance and returns it

Specified by:

getJobInstance in interface BatchManager

Parameters:

jobName - the name of the BatchJob the BatchJobInstance belongs to

jobInstanceId - the id of the BatchJobInstance

Returns:

a BatchJobInstance or null if not found

Throws:

org.mule.runtime.api.exception.MuleException

getJobInstances

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

Returns all the BatchJobInstance available for the given jobName

Specified by:

getJobInstances in interface BatchManager

Parameters:

jobName - the name of the job which instances you want

Returns:

a Iterator of BatchJobInstance

getExecutingInstances

public Iterator<com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance> getExecutingInstances()
                                                                                            throws Exception

Returns the instance of BatchJobInstance that are in an executing state

Specified by:

getExecutingInstances in interface BatchManager

Returns:

a Iterator of BatchJobInstance

Throws:

Exception

stop

public void stop(String jobName,
                 String jobInstanceId)
          throws org.mule.runtime.api.exception.MuleException

Stops the BatchJobInstance of the given ids. Stopping means that no more records will be taken from the instance's queue for processing, but the ones already in the thread pool will finish to complete their current step

Specified by:

stop in interface BatchManager

Parameters:

jobName - the name of the BatchJob the BatchJobInstance belongs to

jobInstanceId - the id of the BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException

resume

public void resume(String jobName,
                   String jobInstanceId)
            throws org.mule.runtime.api.exception.MuleException

Resumes execution of a BatchJobInstance which was stopped through the BatchManager.stop(String, String) 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.

Specified by:

resume in interface BatchManager

Parameters:

jobName - the name of the BatchJob that owns the BatchJobInstance

jobInstanceId - the id of the BatchJobInstance to be resumed

Throws:

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

cancel

public void cancel(String jobName,
                   String jobInstanceId)
            throws org.mule.runtime.api.exception.MuleException

Same as BatchManager.stop(String, String) but definitive. The instance's queue's and object stores are cleared. All the instances resources are relinquished and cannot be regained

Specified by:

cancel in interface BatchManager

Parameters:

jobName - the name of the BatchJob the BatchJobInstance belongs to

jobInstanceId - the id of the BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException

cancelAllRunningInstances

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

Invokes BatchManager.cancel(String, String) for every BatchJobInstance in running state. All running instances will be considered no matter which BatchJob they're linked to

Specified by:

cancelAllRunningInstances in interface BatchManager

Throws:

org.mule.runtime.api.exception.MuleException

delete

public void delete(String jobName,
                   String jobInstanceId)
            throws org.mule.runtime.api.exception.MuleException

Deletes the given BatchJobInstance from persistent store

Specified by:

delete in interface BatchManager

Parameters:

jobName - the name of the BatchJob the BatchJobInstance belongs to

jobInstanceId - the id of the BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException