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

Class BatchProcessingTemplate

java.lang.Object

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

public abstract class BatchProcessingTemplate
extends Object

Implementation of the template design pattern to execute a Processor chain in different sections of a BatchJob such as BatchStep, DefaultBatchStepAggregator or the on-complete section implemented through BatchMessageBlock

Since:

3.5.0

Constructor Summary

Constructors

Constructor and Description
BatchProcessingTemplate(org.mule.runtime.core.api.processor.ReactiveProcessor processor, org.mule.runtime.api.component.location.ComponentLocation location, org.mule.runtime.core.api.context.notification.FlowTraceManager flowTraceManager, org.mule.runtime.core.api.util.StreamCloserService streamCloser) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	before(BatchJobInstanceAdapter jobInstance, org.mule.runtime.core.api.event.CoreEvent event) This method is invoked right before each execution of messageProcessor.
protected void	handleException(BatchJobInstanceAdapter jobInstance, Exception e, org.mule.runtime.core.api.event.CoreEvent event)
protected void	handleSuccess(BatchJobInstanceAdapter jobInstance, org.mule.runtime.core.api.event.CoreEvent resultEvent, org.mule.runtime.core.api.event.CoreEvent.Builder builder)
protected abstract void	onException(BatchJobInstanceAdapter jobInstance, Exception e, org.mule.runtime.core.api.event.CoreEvent event) This method is invoked when the execution of messageProcessor throws exception or the result event carries a ExceptionPayload
protected void	onFinally(BatchJobInstanceAdapter jobInstance, org.mule.runtime.core.api.event.CoreEvent originalEvent, org.mule.runtime.core.api.event.CoreEvent resultEvent) This method is invoked when each execution of messageProcessor completes, no matter if was successful or not.
protected abstract void	onSuccess(BatchJobInstanceAdapter jobInstance, org.mule.runtime.core.api.event.CoreEvent responseEvent) This method is invoked when messageProcessor is execute without any exceptions
org.mule.runtime.core.api.event.CoreEvent	process(BatchJobInstanceAdapter jobInstance, org.mule.runtime.core.api.event.CoreEvent event) Executes the messageProcessor provided in the constructor with the given payload.
protected void	resolveOutputHandlerPayload(org.mule.runtime.core.api.event.CoreEvent event, org.mule.runtime.core.api.event.CoreEvent.Builder builder)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchProcessingTemplate

public BatchProcessingTemplate(org.mule.runtime.core.api.processor.ReactiveProcessor processor,
                               org.mule.runtime.api.component.location.ComponentLocation location,
                               org.mule.runtime.core.api.context.notification.FlowTraceManager flowTraceManager,
                               org.mule.runtime.core.api.util.StreamCloserService streamCloser)

Creates a new instance

Parameters:

processor - the Processor to be executed

location - the location of the component that owns this template

muleContext - the current MuleContext

Method Detail

process

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

Executes the messageProcessor provided in the constructor with the given payload. If execution is completed without errors, then onSuccess(BatchJobInstanceAdapter, CoreEvent)} invoked. On the contrary, if an exception is thrown or if the response event carries an ExceptionPayload, onException(BatchJobInstanceAdapter, Exception, CoreEvent) method is invoked instead. In any case, onFinally(BatchJobInstanceAdapter, CoreEvent, CoreEvent) invoked.

Parameters:

jobInstance - the BatchJobInstanceAdapter for which the messageProcessor is being executed

event - the CoreEvent that is triggering this execution

Returns:

a response CoreEvent

Throws:

org.mule.runtime.api.exception.MuleException

handleSuccess

protected void handleSuccess(BatchJobInstanceAdapter jobInstance,
                             org.mule.runtime.core.api.event.CoreEvent resultEvent,
                             org.mule.runtime.core.api.event.CoreEvent.Builder builder)
                      throws Exception

Throws:

Exception

handleException

protected void handleException(BatchJobInstanceAdapter jobInstance,
                               Exception e,
                               org.mule.runtime.core.api.event.CoreEvent event)
                        throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

resolveOutputHandlerPayload

protected void resolveOutputHandlerPayload(org.mule.runtime.core.api.event.CoreEvent event,
                                           org.mule.runtime.core.api.event.CoreEvent.Builder builder)
                                    throws Exception

Throws:

Exception

before

protected void before(BatchJobInstanceAdapter jobInstance,
                      org.mule.runtime.core.api.event.CoreEvent event)
               throws org.mule.runtime.api.exception.MuleException

This method is invoked right before each execution of messageProcessor. This default implementation is a no-op and can be overridden by the template for each phase.

Parameters:

jobInstance - the BatchJobInstanceAdapter for which execution will be done

event - the CoreEvent originally passed to messageProcessor

Throws:

org.mule.runtime.api.exception.MuleException

onFinally

protected void onFinally(BatchJobInstanceAdapter jobInstance,
                         org.mule.runtime.core.api.event.CoreEvent originalEvent,
                         org.mule.runtime.core.api.event.CoreEvent resultEvent)
                  throws org.mule.runtime.api.exception.MuleException

This method is invoked when each execution of messageProcessor completes, no matter if was successful or not. This default implementation uses a StreamCloserService to close any Closeable resources found on the result event's payload

Parameters:

jobInstance - the BatchJobInstanceAdapter for which execution was done

originalEvent - the CoreEvent originally passed to messageProcessor

resultEvent - the result CoreEvent

Throws:

org.mule.runtime.api.exception.MuleException

onException

protected abstract void onException(BatchJobInstanceAdapter jobInstance,
                                    Exception e,
                                    org.mule.runtime.core.api.event.CoreEvent event)
                             throws org.mule.runtime.api.exception.MuleException

This method is invoked when the execution of messageProcessor throws exception or the result event carries a ExceptionPayload

Parameters:

jobInstance - the BatchJobInstance for which execution is being done

e - the Exception thrown or found in the ExceptionPayload

event - the CoreEvent for which the exception occurred

Throws:

org.mule.runtime.api.exception.MuleException

onSuccess

protected abstract void onSuccess(BatchJobInstanceAdapter jobInstance,
                                  org.mule.runtime.core.api.event.CoreEvent responseEvent)
                           throws org.mule.runtime.api.exception.MuleException

This method is invoked when messageProcessor is execute without any exceptions

Parameters:

jobInstance - the BatchJobInstance for which execution is being done

responseEvent - the response CoreEvent

Throws:

org.mule.runtime.api.exception.MuleException