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

Interface BatchJobAdapter

All Superinterfaces:

BatchJob, org.mule.runtime.api.component.Component, org.mule.runtime.api.meta.NamedObject

All Known Implementing Classes:

DefaultBatchJob

@NoImplement
public interface BatchJobAdapter
extends BatchJob, org.mule.runtime.api.component.Component

Adapter interface to access BatchJob related functionality that we don't want exposed as part of the public API

Since:

3.5.0

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CONCURRENCY

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

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Method Summary

Modifier and Type	Method and Description
com.mulesoft.mule.runtime.module.batch.api.BatchJobInstance	execute(org.mule.runtime.core.api.event.CoreEvent muleEvent) Executes the batch and generates a BatchJobInstance in loading state
String	generateJobInstanceId(org.mule.runtime.core.api.event.CoreEvent event) Generates an id for a BatchJobInstance to be created per the given event
BatchEngine	getBatchEngine()
BatchJobInstanceSchedulingStrategy	getBatchJobInstanceSchedulingStrategy()
int	getBlockSize() For performance reasons, batch records are queued and scheduled in blocks.
HistoryExpirationPolicy	getHistoryExpirationPolicy()
default int	getMaxConcurrency()
org.mule.runtime.core.api.MuleContext	getMuleContext()
Optional<org.mule.runtime.core.api.processor.Processor>	getOnCompleteBlock() The job's on complete block if configured
BatchStepAdapter	getStepById(String stepId) Returns the step of the given id
void	submitWork(Runnable before, Runnable work, Runnable after) Schedules the given work to be executed.

Methods inherited from interface com.mulesoft.mule.runtime.module.batch.api.BatchJob

getMaxFailedRecords, getSteps

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

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

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

Field Detail

DEFAULT_MAX_CONCURRENCY

static final int DEFAULT_MAX_CONCURRENCY

Method Detail

submitWork

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

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.

Parameters:

before - a callback to be run right before work

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

before - a callback to be run right after work, in both success and failure cases/

execute

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

Executes the batch and generates a BatchJobInstance in loading state

Parameters:

muleEvent - an instance of CoreEvent

Returns:

a BatchJobInstance

Throws:

org.mule.runtime.api.exception.MuleException

getOnCompleteBlock

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

The job's on complete block if configured

Returns:

a Processor or null

getStepById

BatchStepAdapter getStepById(String stepId)

Returns the step of the given id

Parameters:

stepId - the id of a step

Returns:

a BatchStepAdapter

Throws:

{@link - IllegalArgumentException} if no step for the given id exists for this job

getBatchJobInstanceSchedulingStrategy

BatchJobInstanceSchedulingStrategy getBatchJobInstanceSchedulingStrategy()

getBatchEngine

BatchEngine getBatchEngine()

getBlockSize

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.

Returns:

a positive int greater than zero

generateJobInstanceId

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

Generates an id for a BatchJobInstance to be created per the given event

Parameters:

event - a CoreEvent

Returns:

a non-blank String

getHistoryExpirationPolicy

HistoryExpirationPolicy getHistoryExpirationPolicy()

getMaxConcurrency

default int getMaxConcurrency()

Returns:

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

getMuleContext

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