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

Class DefaultBatchJob

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

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

All Implemented Interfaces:

BatchJob, BatchJobAdapter, Function<org.reactivestreams.Publisher<org.mule.runtime.core.api.event.CoreEvent>,org.reactivestreams.Publisher<org.mule.runtime.core.api.event.CoreEvent>>, org.mule.runtime.api.component.Component, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.meta.NamedObject, org.mule.runtime.core.api.processor.Processor, org.mule.runtime.core.api.processor.ReactiveProcessor

public class DefaultBatchJob
extends org.mule.runtime.api.component.AbstractComponent
implements BatchJobAdapter, org.mule.runtime.core.api.processor.Processor, org.mule.runtime.api.lifecycle.Lifecycle

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

org.mule.runtime.api.component.Component.Annotations

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

org.mule.runtime.core.api.processor.ReactiveProcessor.ProcessingType

Field Summary

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface com.mulesoft.mule.runtime.module.batch.engine.BatchJobAdapter

DEFAULT_MAX_CONCURRENCY

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultBatchJob(String name, int blockSize, org.mule.runtime.core.api.MuleContext muleContext) Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	dispose()
com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance	execute(org.mule.runtime.core.api.event.CoreEvent event) Executes the batch and generates a BatchJobInstance in loading state
String	generateJobInstanceId(org.mule.runtime.core.api.event.CoreEvent event) Generates an id by evaluating the jobInstanceIdExpression on the given event.
BatchEngine	getBatchEngine()
BatchJobInstanceSchedulingStrategy	getBatchJobInstanceSchedulingStrategy()
int	getBlockSize() For performance reasons, batch records are queued and scheduled in blocks.
HistoryExpirationPolicy	getHistoryExpirationPolicy()
int	getMaxConcurrency()
int	getMaxFailedRecords() The number of max records allowed to fail before failing the job
org.mule.runtime.core.api.MuleContext	getMuleContext()
String	getName()
Optional<org.mule.runtime.core.api.processor.Processor>	getOnCompleteBlock() The job's on complete block if configured
org.mule.runtime.core.api.processor.ReactiveProcessor.ProcessingType	getProcessingType()
BatchStepAdapter	getStepById(String stepId) Returns the step of the given id
List<BatchStep>	getSteps()
protected void	initExpirationPolicy()
void	initialise()
org.mule.runtime.core.api.event.CoreEvent	process(org.mule.runtime.core.api.event.CoreEvent event)
void	setBatchEngine(BatchEngine batchEngine)
void	setBatchJobInstanceSchedulingStrategy(BatchJobInstanceSchedulingStrategy batchJobInstanceSchedulingStrategy)
void	setHistoryExpirationPolicy(HistoryExpirationPolicy historyExpirationPolicy)
void	setJobInstanceIdExpression(String jobInstanceIdExpression)
void	setMaxConcurrency(int maxConcurrency)
void	setMaxFailedRecords(int maxFailures)
void	setOnCompleteBlock(BatchMessageBlock onCompleteBlock)
void	setRecordProcessors(BatchRecordProcessors recordProcessors)
void	setTarget(String target)
void	setTargetValue(String targetValue)
void	start()
void	stop()
void	submitWork(Runnable before, Runnable work, Runnable after) Schedules the given work to be executed.

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, initRootContainerName, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.component.Component

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, setAnnotations

Methods inherited from interface org.mule.runtime.core.api.processor.Processor

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

DefaultBatchJob

public DefaultBatchJob(String name,
                       int blockSize,
                       org.mule.runtime.core.api.MuleContext muleContext)

Creates a new instance

Parameters:

name - the job's name

blockSize - the size of the block to be used for storing/scheduling records

muleContext - the application's MuleContext

Method Detail

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

stop

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

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

initExpirationPolicy

protected void initExpirationPolicy()
                             throws org.mule.runtime.api.lifecycle.InitialisationException

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.api.meta.NamedObject

submitWork

public void submitWork(Runnable before,
                       Runnable work,
                       Runnable after)

Description copied from interface: BatchJobAdapter

Schedules the given work to be executed. If this method is invoked while the MuleContext is stopped or stopping, or this job adapter is stopped, then the work is silently discarded and the context is rolled back.

Specified by:

submitWork in interface BatchJobAdapter

Parameters:

before - a callback to be run right before work

work - a javax.resource.spi.work.Work

process

public org.mule.runtime.core.api.event.CoreEvent process(org.mule.runtime.core.api.event.CoreEvent event)
                                                  throws org.mule.runtime.api.exception.MuleException

Specified by:

process in interface org.mule.runtime.core.api.processor.Processor

Throws:

org.mule.runtime.api.exception.MuleException

execute

public com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance execute(org.mule.runtime.core.api.event.CoreEvent event)
                                                                    throws org.mule.runtime.api.exception.MuleException

Description copied from interface: BatchJobAdapter

Executes the batch and generates a BatchJobInstance in loading state

Specified by:

execute in interface BatchJobAdapter

Parameters:

event - an instance of CoreEvent

Returns:

a BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException

getOnCompleteBlock

public Optional<org.mule.runtime.core.api.processor.Processor> getOnCompleteBlock()

The job's on complete block if configured

Specified by:

getOnCompleteBlock in interface BatchJobAdapter

Returns:

a Processor or null

setOnCompleteBlock

public void setOnCompleteBlock(BatchMessageBlock onCompleteBlock)

getStepById

public BatchStepAdapter getStepById(String stepId)

Returns the step of the given id

Specified by:

getStepById in interface BatchJobAdapter

Parameters:

stepId - the id of a step

Returns:

a BatchStepAdapter

getSteps

public List<BatchStep> getSteps()

Specified by:

getSteps in interface BatchJob

Returns:

a list with the job's BatchStep

getBatchEngine

public BatchEngine getBatchEngine()

Specified by:

getBatchEngine in interface BatchJobAdapter

generateJobInstanceId

public String generateJobInstanceId(org.mule.runtime.core.api.event.CoreEvent event)

Generates an id by evaluating the jobInstanceIdExpression on the given event. The jobInstanceIdExpression is expected to return a non blank String

Specified by:

generateJobInstanceId in interface BatchJobAdapter

Parameters:

event - a CoreEvent

Returns:

a non-blank String

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - if the expression returned null, a blank String or something of another type

setBatchEngine

public void setBatchEngine(BatchEngine batchEngine)

setRecordProcessors

public void setRecordProcessors(BatchRecordProcessors recordProcessors)

getMaxFailedRecords

public int getMaxFailedRecords()

The number of max records allowed to fail before failing the job

Specified by:

getMaxFailedRecords in interface BatchJob

Returns:

an int between -1 and MAX_VALUE. -1 means that any amount of records are allowed to fail. Zero means that no record is allowed to fail. Any greater value means an exact number of failures

getBlockSize

public int getBlockSize()

For performance reasons, batch records are queued and scheduled in blocks. This method returns the size of the block that should be used for instances of this job.

Specified by:

getBlockSize in interface BatchJobAdapter

Returns:

a positive int greater than zero

setMaxFailedRecords

public void setMaxFailedRecords(int maxFailures)

getProcessingType

public org.mule.runtime.core.api.processor.ReactiveProcessor.ProcessingType getProcessingType()

Specified by:

getProcessingType in interface org.mule.runtime.core.api.processor.ReactiveProcessor

getBatchJobInstanceSchedulingStrategy

public BatchJobInstanceSchedulingStrategy getBatchJobInstanceSchedulingStrategy()

Specified by:

getBatchJobInstanceSchedulingStrategy in interface BatchJobAdapter

setBatchJobInstanceSchedulingStrategy

public void setBatchJobInstanceSchedulingStrategy(BatchJobInstanceSchedulingStrategy batchJobInstanceSchedulingStrategy)

setJobInstanceIdExpression

public void setJobInstanceIdExpression(String jobInstanceIdExpression)

getHistoryExpirationPolicy

public HistoryExpirationPolicy getHistoryExpirationPolicy()

Specified by:

getHistoryExpirationPolicy in interface BatchJobAdapter

getMaxConcurrency

public int getMaxConcurrency()

Specified by:

getMaxConcurrency in interface BatchJobAdapter

Returns:

the maximum number of blocks that will be processed concurrently for this job.

getMuleContext

public org.mule.runtime.core.api.MuleContext getMuleContext()

Specified by:

getMuleContext in interface BatchJobAdapter

setHistoryExpirationPolicy

public void setHistoryExpirationPolicy(HistoryExpirationPolicy historyExpirationPolicy)

setMaxConcurrency

public void setMaxConcurrency(int maxConcurrency)

setTarget

public void setTarget(String target)

setTargetValue

public void setTargetValue(String targetValue)