org.mule.runtime.module.extension.internal.runtime.operation

Class ComponentMessageProcessor<T extends org.mule.runtime.api.meta.model.ComponentModel>

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.module.extension.internal.runtime.ExtensionComponent<T>

org.mule.runtime.module.extension.internal.runtime.operation.ComponentMessageProcessor<T>

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<CoreEvent>,org.reactivestreams.Publisher<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.metadata.MetadataKeyProvider, org.mule.runtime.api.metadata.MetadataProvider<T>, MuleContextAware, Processor, ReactiveProcessor, ParametersResolverProcessor<T>, org.mule.runtime.extension.api.data.sample.ComponentSampleDataProvider, org.mule.runtime.extension.api.values.ComponentValueProvider

Direct Known Subclasses:

ConstructMessageProcessor, OperationMessageProcessor

public abstract class ComponentMessageProcessor<T extends org.mule.runtime.api.meta.model.ComponentModel>
extends ExtensionComponent<T>
implements Processor, ParametersResolverProcessor<T>, org.mule.runtime.api.lifecycle.Lifecycle

A Processor capable of executing extension components.

If required, it obtains a configuration instance, evaluate all the operation parameters and executes it by using a componentExecutor. This message processor is capable of serving the execution of any of any ExtensionModel.

A componentExecutor is obtained by testing the T for a CompletableComponentExecutorModelProperty through which a CompletableComponentExecutorFactory is obtained. Models with no such property cannot be used with this class. The obtained CompletableComponentExecutor serve all invocations of process(CoreEvent) on this instance but will not be shared with other instances of ComponentMessageProcessor. All the Lifecycle events that this instance receives will be propagated to the componentExecutor.

The componentExecutor is executed directly but by the means of a DefaultExecutionMediator

Before executing the operation will use the PolicyManager to lookup for a OperationPolicy that must be applied to the operation. If there's a policy to be applied then it will interleave the operation execution with the policy logic allowing the policy to execute logic over the operation parameters, change those parameters and then execute logic with the operation response.

Since:

4.0

Nested Class Summary

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

ReactiveProcessor.ProcessingType

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
protected org.mule.runtime.extension.api.runtime.operation.CompletableComponentExecutor	componentExecutor
protected ExecutionMediator	executionMediator
protected org.mule.runtime.api.meta.model.ExtensionModel	extensionModel
protected MessageProcessorChain	nestedChain
protected ClassLoader	nestedChainClassLoader
protected PolicyManager	policyManager
static String	PROCESSOR_PATH_MDC_KEY
protected ResolverSet	resolverSet
protected RetryPolicyTemplate	retryPolicyTemplate
protected ReturnDelegate	returnDelegate
protected String	target
protected String	targetValue

Fields inherited from class org.mule.runtime.module.extension.internal.runtime.ExtensionComponent

cacheIdGenerator, classLoader, componentLocator, componentModel, connectionManager, cursorProviderFactory, errorTypeRepository, expressionManager, extensionManager, metadataService, muleContext, streamingManager, transactionFactoryLocator

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

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_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.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Constructor Summary

Constructors

Constructor and Description

ComponentMessageProcessor(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, T componentModel, org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider, String target, String targetValue, ResolverSet resolverSet, CursorProviderFactory cursorProviderFactory, RetryPolicyTemplate retryPolicyTemplate, MessageProcessorChain nestedChain, ClassLoader classLoader, ExtensionManager extensionManager, PolicyManager policyManager, ReflectionCache reflectionCache, DefaultExecutionMediator.ResultTransformer resultTransformer, long terminationTimeout)

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<CoreEvent>	apply(org.reactivestreams.Publisher<CoreEvent> publisher)
protected ExecutionMediator	createExecutionMediator()
protected InterceptorChain	createInterceptorChain()
protected ReturnDelegate	createReturnDelegate()
void	disposeResolvedParameters(org.mule.runtime.extension.api.runtime.operation.ExecutionContext<T> executionContext)
void	doDispose() Implementors will use this method to perform their own disposing logic
protected void	doInitialise() Implementors will use this method to perform their own initialisation logic
void	doStart() Implementors will use this method to perform their own starting logic
void	doStop() Implementors will use this method to perform their own stopping logic
protected void	executeOperation(ExecutionContextAdapter<T> operationContext, org.mule.runtime.extension.api.runtime.operation.CompletableComponentExecutor.ExecutorCallback callback)
ReactiveProcessor.ProcessingType	getInnerProcessingType() This is the processing type that is actually taken into account when the processing strategy is applied.
protected SdkInternalContext.OperationExecutionParams	getOperationExecutionParams(CoreEvent event)
protected ParameterValueResolver	getParameterValueResolver()
ReactiveProcessor.ProcessingType	getProcessingType()
protected RetryPolicyTemplateResolver	getRetryPolicyTemplateResolver()
protected ReturnDelegate	getTargetReturnDelegate()
protected ValueReturnDelegate	getValueReturnDelegate()
protected boolean	isAsyncExecutableBasedOn(Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance> staticConfig)
protected boolean	isBlocking()
protected boolean	isTargetPresent()
protected boolean	mayCompleteInDifferentThread() This indicates that the component message processor may jump threads under certain conditions (not necessarily always).
CoreEvent	process(CoreEvent event)
void	resolveParameters(CoreEvent.Builder eventBuilder, BiConsumer<Map<String,Supplier<Object>>,org.mule.runtime.extension.api.runtime.operation.ExecutionContext> afterConfigurer)
protected void	startIfNeededNestedChain() If the nestedChain is not null, it changes the current ClassLoader for the Application's ClassLoader nestedChainClassLoader to start the processors, and then it goes back to the previous ClassLoader.
String	toString()
protected abstract void	validateOperationConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider) Validates that the ExtensionComponent.componentModel is valid for the given configurationProvider

Methods inherited from class org.mule.runtime.module.extension.internal.runtime.ExtensionComponent

dispose, getConfiguration, getConfigurationProvider, getCursorProviderFactory, getExtensionModel, getInputMetadata, getMetadata, getMetadata, getMetadataKeys, getMetadataKeys, getModels, getOutputMetadata, getSampleData, getStaticConfiguration, getValues, getValues, initialise, requiresConfig, runWithMetadataContext, setCacheIdGeneratorFactory, setComponentLocator, setMuleContext, start, stop, usesDynamicConfiguration

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, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose, identity

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

initialise

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

start

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

stop

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

dispose

Field Detail

PROCESSOR_PATH_MDC_KEY

public static final String PROCESSOR_PATH_MDC_KEY

See Also:

Constant Field Values

extensionModel

protected final org.mule.runtime.api.meta.model.ExtensionModel extensionModel

resolverSet

protected final ResolverSet resolverSet

target

protected final String target

targetValue

protected final String targetValue

retryPolicyTemplate

protected final RetryPolicyTemplate retryPolicyTemplate

nestedChain

protected final MessageProcessorChain nestedChain

executionMediator

protected ExecutionMediator executionMediator

componentExecutor

protected org.mule.runtime.extension.api.runtime.operation.CompletableComponentExecutor componentExecutor

returnDelegate

protected ReturnDelegate returnDelegate

policyManager

protected PolicyManager policyManager

nestedChainClassLoader

protected ClassLoader nestedChainClassLoader

Constructor Detail

ComponentMessageProcessor

public ComponentMessageProcessor(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                 T componentModel,
                                 org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider,
                                 String target,
                                 String targetValue,
                                 ResolverSet resolverSet,
                                 CursorProviderFactory cursorProviderFactory,
                                 RetryPolicyTemplate retryPolicyTemplate,
                                 MessageProcessorChain nestedChain,
                                 ClassLoader classLoader,
                                 ExtensionManager extensionManager,
                                 PolicyManager policyManager,
                                 ReflectionCache reflectionCache,
                                 DefaultExecutionMediator.ResultTransformer resultTransformer,
                                 long terminationTimeout)

Method Detail

process

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

Specified by:

process in interface Processor

Throws:

org.mule.runtime.api.exception.MuleException

apply

public org.reactivestreams.Publisher<CoreEvent> apply(org.reactivestreams.Publisher<CoreEvent> publisher)

Specified by:

apply in interface Function<org.reactivestreams.Publisher<CoreEvent>,org.reactivestreams.Publisher<CoreEvent>>

Specified by:

apply in interface Processor

getProcessingType

public ReactiveProcessor.ProcessingType getProcessingType()

Specified by:

getProcessingType in interface ReactiveProcessor

executeOperation

protected void executeOperation(ExecutionContextAdapter<T> operationContext,
                                org.mule.runtime.extension.api.runtime.operation.CompletableComponentExecutor.ExecutorCallback callback)

doInitialise

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

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own initialisation logic

Specified by:

doInitialise in class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>

Throws:

org.mule.runtime.api.lifecycle.InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

getOperationExecutionParams

protected SdkInternalContext.OperationExecutionParams getOperationExecutionParams(CoreEvent event)

getRetryPolicyTemplateResolver

protected RetryPolicyTemplateResolver getRetryPolicyTemplateResolver()

createReturnDelegate

protected ReturnDelegate createReturnDelegate()

getTargetReturnDelegate

protected ReturnDelegate getTargetReturnDelegate()

getValueReturnDelegate

protected ValueReturnDelegate getValueReturnDelegate()

isTargetPresent

protected boolean isTargetPresent()

isBlocking

protected boolean isBlocking()

mayCompleteInDifferentThread

protected boolean mayCompleteInDifferentThread()

This indicates that the component message processor may jump threads under certain conditions (not necessarily always). For example, it may jump threads only when a connection problem happens and the retry strategy is triggered.

Returns:

whether it may jump threads.

isAsyncExecutableBasedOn

protected boolean isAsyncExecutableBasedOn(Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance> staticConfig)

startIfNeededNestedChain

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

If the nestedChain is not null, it changes the current ClassLoader for the Application's ClassLoader nestedChainClassLoader to start the processors, and then it goes back to the previous ClassLoader.

Throws:

org.mule.runtime.api.exception.MuleException - if the LifecycleUtils.startIfNeeded(java.lang.Object) fails.

doStart

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

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own starting logic

Specified by:

doStart in class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>

Throws:

org.mule.runtime.api.exception.MuleException - if the component could not start

doStop

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

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own stopping logic

Specified by:

doStop in class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>

Throws:

org.mule.runtime.api.exception.MuleException - if the component could not stop

doDispose

public void doDispose()

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own disposing logic

Specified by:

doDispose in class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>

createExecutionMediator

protected ExecutionMediator createExecutionMediator()

createInterceptorChain

protected InterceptorChain createInterceptorChain()

validateOperationConfiguration

protected abstract void validateOperationConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider)

Validates that the ExtensionComponent.componentModel is valid for the given configurationProvider

Specified by:

validateOperationConfiguration in class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>

Throws:

IllegalOperationException - If the validation fails

getParameterValueResolver

protected ParameterValueResolver getParameterValueResolver()

Specified by:

getParameterValueResolver in class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>

getInnerProcessingType

public ReactiveProcessor.ProcessingType getInnerProcessingType()

This is the processing type that is actually taken into account when the processing strategy is applied. This is used by the flux created in startInnerFlux().

resolveParameters

public void resolveParameters(CoreEvent.Builder eventBuilder,
                              BiConsumer<Map<String,Supplier<Object>>,org.mule.runtime.extension.api.runtime.operation.ExecutionContext> afterConfigurer)
                       throws org.mule.runtime.api.exception.MuleException

Specified by:

resolveParameters in interface ParametersResolverProcessor<T extends org.mule.runtime.api.meta.model.ComponentModel>

Throws:

org.mule.runtime.api.exception.MuleException

disposeResolvedParameters

public void disposeResolvedParameters(org.mule.runtime.extension.api.runtime.operation.ExecutionContext<T> executionContext)

Specified by:

disposeResolvedParameters in interface ParametersResolverProcessor<T extends org.mule.runtime.api.meta.model.ComponentModel>

toString

public String toString()

Overrides:

toString in class Object