com.mulesoft.mule.runtime.module.batch.api

Interface BatchManager

All Known Implementing Classes:

DefaultBatchManager

@NoImplement
public interface BatchManager

public API for external components to access functionality and state of the Batch Module

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
void	cancel(String jobName, String jobInstanceId) Same as stop(String, String) but definitive.
void	cancelAllRunningInstances() Invokes 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 stop(String, String) method.
void	stop(String jobName, String jobInstanceId) Stops the BatchJobInstance of the given ids.

Method Detail

getBatchJobs

Collection<BatchJob> getBatchJobs()

Returns all the BatchJob declared in the current mule context

Returns:

a collection of BatchJob

getJobInstance

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

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

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

Returns all the BatchJobInstance available for the given jobName

Parameters:

jobName - the name of the job which instances you want

Returns:

a Iterator of BatchJobInstance

getExecutingInstances

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

Returns the instance of BatchJobInstance that are in an executing state

Returns:

a Iterator of BatchJobInstance

Throws:

Exception

stop

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

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

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

Resumes execution of a BatchJobInstance which was stopped through the 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.

Parameters:

jobName - the name of the BatchJob that owns the BatchJobInstance

jobInstanceId - the id of the BatchJobInstance to be resumed

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(String jobName,
            String jobInstanceId)
     throws org.mule.runtime.api.exception.MuleException

Same as 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

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

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

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

Throws:

org.mule.runtime.api.exception.MuleException

delete

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

Deletes the given BatchJobInstance from persistent store

Parameters:

jobName - the name of the BatchJob the BatchJobInstance belongs to

jobInstanceId - the id of the BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException