org.mule.runtime.core.internal.construct

Class AbstractPipeline

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.core.internal.construct.AbstractFlowConstruct

org.mule.runtime.core.internal.construct.AbstractPipeline

All Implemented Interfaces:

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.AnnotatedObject, org.mule.runtime.api.meta.NamedObject, FlowConstruct, Pipeline, LifecycleStateEnabled, ProcessingDescriptor

Direct Known Subclasses:

DefaultFlowBuilder.DefaultFlow

public abstract class AbstractPipeline
extends AbstractFlowConstruct
implements Pipeline

Abstract implementation of AbstractFlowConstruct that allows a list of Processors that will be used to process messages to be configured. These MessageProcessors are chained together using the DefaultMessageProcessorChainBuilder.

If no message processors are configured then the source message is simply returned.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Processor>	messageProcessors
protected MessageSource	messageSource
protected MessageProcessorChain	pipeline
protected ProcessingStrategy	processingStrategy
protected ProcessingStrategyFactory	processingStrategyFactory
protected SchedulerService	schedulerService
protected Sink	sink
protected StreamingManager	streamingManager

Fields inherited from class org.mule.runtime.core.internal.construct.AbstractFlowConstruct

exceptionListener, initialState, LOGGER, muleContext, name, statistics

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY

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

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractPipeline(String name, MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
Consumer<Event>	assertStarted()
protected void	configureMessageProcessors(MessageProcessorChainBuilder builder)
protected void	configurePostProcessors(MessageProcessorChainBuilder builder)
protected void	configurePreProcessors(MessageProcessorChainBuilder builder)
protected ProcessingStrategyFactory	createDefaultProcessingStrategyFactory() A fallback method for creating a ProcessingStrategyFactory to be used in case the user hasn't specified one through either setProcessingStrategyFactory(ProcessingStrategyFactory), through MuleConfiguration.getDefaultProcessingStrategyFactory() or the MuleProperties.MULE_DEFAULT_PROCESSING_STRATEGY system property
protected MessageProcessorChain	createPipeline() Creates a Processor that will process messages from the configured MessageSource .
protected void	doDispose()
protected void	doInitialise()
protected void	doStart()
protected void	doStop()
List<Processor>	getMessageProcessors()
MessageSource	getMessageSource()
ProcessingStrategy	getProcessingStrategy()
ProcessingStrategyFactory	getProcessingStrategyFactory()
Map<String,EventContext>	getSerializationEventContextCache() Map of current EventContext instances for Event's that have been serialized.
protected boolean	isRedeliveryPolicyConfigured()
boolean	isSynchronous() Whether the processing represented by this instance is synchronous or not
protected ReactiveProcessor	processFlowFunction()
void	setMessageProcessors(List<Processor> messageProcessors)
void	setMessageSource(MessageSource messageSource)
void	setProcessingStrategyFactory(ProcessingStrategyFactory processingStrategyFactory)
protected boolean	useBlockingCodePath() Determines is blocking synchronous code path should be used.

Methods inherited from class org.mule.runtime.core.internal.construct.AbstractFlowConstruct

configureStatistics, dispose, disposeIfDisposable, getConstructType, getExceptionListener, getInitialState, getLifecycleState, getMuleContext, getName, getServerId, getStatistics, getUniqueIdString, initialise, initialiseIfInitialisable, injectExceptionHandler, injectFlowConstructMuleContext, isStarted, isStopped, isStopping, setExceptionListener, setInitialState, start, startIfStartable, stop, stopIfStoppable, toString, validateConstruct

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.core.api.construct.FlowConstruct

getExceptionListener, getMuleContext, getServerId, getStatistics, getUniqueIdString

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

getName

Methods inherited from interface org.mule.runtime.core.api.lifecycle.LifecycleStateEnabled

getLifecycleState

Field Detail

messageSource

protected MessageSource messageSource

pipeline

protected MessageProcessorChain pipeline

schedulerService

protected final SchedulerService schedulerService

streamingManager

protected StreamingManager streamingManager

messageProcessors

protected List<Processor> messageProcessors

processingStrategyFactory

protected ProcessingStrategyFactory processingStrategyFactory

processingStrategy

protected ProcessingStrategy processingStrategy

sink

protected Sink sink

Constructor Detail

AbstractPipeline

public AbstractPipeline(String name,
                        MuleContext muleContext)

Method Detail

createPipeline

protected MessageProcessorChain createPipeline()
                                        throws org.mule.runtime.api.exception.MuleException

Creates a Processor that will process messages from the configured MessageSource .

The default implementation of this methods uses a DefaultMessageProcessorChainBuilder and allows a chain of Processors to be configured using the configureMessageProcessors(org.mule.runtime.core.api.processor.MessageProcessorChainBuilder) method but if you wish to use another MessageProcessorBuilder or just a single Processor then this method can be overridden and return a single Processor instead.

Throws:

org.mule.runtime.api.exception.MuleException

createDefaultProcessingStrategyFactory

protected ProcessingStrategyFactory createDefaultProcessingStrategyFactory()

A fallback method for creating a ProcessingStrategyFactory to be used in case the user hasn't specified one through either setProcessingStrategyFactory(ProcessingStrategyFactory), through MuleConfiguration.getDefaultProcessingStrategyFactory() or the MuleProperties.MULE_DEFAULT_PROCESSING_STRATEGY system property

Returns:

a DirectProcessingStrategyFactory

configurePreProcessors

protected void configurePreProcessors(MessageProcessorChainBuilder builder)
                               throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

configurePostProcessors

protected void configurePostProcessors(MessageProcessorChainBuilder builder)
                                throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

setMessageProcessors

public void setMessageProcessors(List<Processor> messageProcessors)

Specified by:

setMessageProcessors in interface Pipeline

getMessageProcessors

public List<Processor> getMessageProcessors()

Specified by:

getMessageProcessors in interface Pipeline

getMessageSource

public MessageSource getMessageSource()

Specified by:

getMessageSource in interface Pipeline

setMessageSource

public void setMessageSource(MessageSource messageSource)

Specified by:

setMessageSource in interface Pipeline

isSynchronous

public boolean isSynchronous()

Description copied from interface: ProcessingDescriptor

Whether the processing represented by this instance is synchronous or not

Specified by:

isSynchronous in interface ProcessingDescriptor

getProcessingStrategyFactory

public ProcessingStrategyFactory getProcessingStrategyFactory()

Specified by:

getProcessingStrategyFactory in interface Pipeline

Returns:

the factory used to create the ProcessingStrategy used on the pipeline.

setProcessingStrategyFactory

public void setProcessingStrategyFactory(ProcessingStrategyFactory processingStrategyFactory)

Specified by:

setProcessingStrategyFactory in interface Pipeline

getProcessingStrategy

public ProcessingStrategy getProcessingStrategy()

Specified by:

getProcessingStrategy in interface Pipeline

doInitialise

protected void doInitialise()
                     throws org.mule.runtime.api.exception.MuleException

Overrides:

doInitialise in class AbstractFlowConstruct

Throws:

org.mule.runtime.api.exception.MuleException

processFlowFunction

protected ReactiveProcessor processFlowFunction()

configureMessageProcessors

protected void configureMessageProcessors(MessageProcessorChainBuilder builder)
                                   throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

isRedeliveryPolicyConfigured

protected boolean isRedeliveryPolicyConfigured()

doStart

protected void doStart()
                throws org.mule.runtime.api.exception.MuleException

Overrides:

doStart in class AbstractFlowConstruct

Throws:

org.mule.runtime.api.exception.MuleException

assertStarted

public Consumer<Event> assertStarted()

doStop

protected void doStop()
               throws org.mule.runtime.api.exception.MuleException

Overrides:

doStop in class AbstractFlowConstruct

Throws:

org.mule.runtime.api.exception.MuleException

doDispose

protected void doDispose()

Overrides:

doDispose in class AbstractFlowConstruct

useBlockingCodePath

protected boolean useBlockingCodePath()

Determines is blocking synchronous code path should be used. This is used in the following cases:

1. If a transaction is active and a processing strategy supporting transactions is configured. (synchronous or default strategies)

Returns:

true if blocking synchronous code path should be used, false otherwise.

getSerializationEventContextCache

public Map<String,EventContext> getSerializationEventContextCache()

Description copied from interface: Pipeline

Map of current EventContext instances for Event's that have been serialized. Entries will be removed on deserialization or in the last resort purged through garbage collection when there are no longer any hard references to the EventContext left. EventContext's for Event's that are not serialized will never be added to this cache.

Specified by:

getSerializationEventContextCache in interface Pipeline

Returns:

map of event context keyed by their id as obtained from EventContext.getId()