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

Class OperationMessageProcessor

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.module.extension.internal.runtime.ExtensionComponent<org.mule.runtime.api.meta.model.operation.OperationModel>

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

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, 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.metadata.EntityMetadataProvider, org.mule.runtime.api.metadata.MetadataKeyProvider, org.mule.runtime.api.metadata.MetadataProvider<org.mule.runtime.api.meta.model.operation.OperationModel>, FlowConstructAware, MuleContextAware, ParametersResolverProcessor, Processor, ReactiveProcessor

Direct Known Subclasses:

OAuthOperationMessageProcessor, PagedOperationMessageProcessor

public class OperationMessageProcessor
extends ExtensionComponent<org.mule.runtime.api.meta.model.operation.OperationModel>
implements Processor, ParametersResolverProcessor, org.mule.runtime.api.metadata.EntityMetadataProvider, org.mule.runtime.api.lifecycle.Lifecycle

A Processor capable of executing extension operations.

It obtains a configuration instance, evaluate all the operation parameters and executes a OperationModel by using a operationExecutor. This message processor is capable of serving the execution of any OperationModel of any ExtensionModel.

A operationExecutor is obtained by testing the OperationModel for a OperationExecutorModelProperty through which a OperationExecutorFactory is obtained. Models with no such property cannot be used with this class. The obtained OperationExecutor serve all invocations of process(Event) on this instance but will not be shared with other instances of OperationMessageProcessor. All the Lifecycle events that this instance receives will be propagated to the operationExecutor.

The operationExecutor 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:

3.7.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.core.api.processor.ParametersResolverProcessor

ParametersResolverProcessor.ParametersResolverProcessorResult

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mule.runtime.module.extension.internal.runtime.operation.ReturnDelegate	returnDelegate

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

classLoader, connectionManager, extensionManager, flowConstruct, muleContext, streamingManager

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
OperationMessageProcessor(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, org.mule.runtime.api.meta.model.operation.OperationModel operationModel, org.mule.runtime.extension.api.runtime.ConfigurationProvider configurationProvider, String target, ResolverSet resolverSet, CursorProviderFactory cursorProviderFactory, ExtensionManager extensionManager, PolicyManager policyManager)

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Event>	apply(org.reactivestreams.Publisher<Event> publisher)
protected ExecutionMediator	createExecutionMediator()
void	disposeResolvedParameters(org.mule.runtime.extension.api.runtime.operation.ExecutionContext<org.mule.runtime.api.meta.model.operation.OperationModel> 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
protected reactor.core.publisher.Mono<Event>	doProcess(Event event, ExecutionContextAdapter<org.mule.runtime.api.meta.model.operation.OperationModel> operationContext)
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
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer>	getEntityKeys()
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.TypeMetadataDescriptor>	getEntityMetadata(org.mule.runtime.api.metadata.MetadataKey key)
protected ParameterValueResolver	getParameterValueResolver()
ReactiveProcessor.ProcessingType	getProcessingType()
protected Optional<String>	getTarget()
Event	process(Event event)
ParametersResolverProcessor.ParametersResolverProcessorResult	resolveParameters(Event event)
protected void	validateOperationConfiguration(org.mule.runtime.extension.api.runtime.ConfigurationProvider configurationProvider) Validates that the operationModel is valid for the given configurationProvider

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

dispose, getConfiguration, getCursorProviderFactory, getExtensionModel, getMetadata, getMetadata, getMetadataKeys, initialise, runWithMetadataContext, setFlowConstruct, setMuleContext, start, stop

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

returnDelegate

protected org.mule.runtime.module.extension.internal.runtime.operation.ReturnDelegate returnDelegate

Constructor Detail

OperationMessageProcessor

public OperationMessageProcessor(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                 org.mule.runtime.api.meta.model.operation.OperationModel operationModel,
                                 org.mule.runtime.extension.api.runtime.ConfigurationProvider configurationProvider,
                                 String target,
                                 ResolverSet resolverSet,
                                 CursorProviderFactory cursorProviderFactory,
                                 ExtensionManager extensionManager,
                                 PolicyManager policyManager)

Method Detail

process

public Event process(Event 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<Event> apply(org.reactivestreams.Publisher<Event> publisher)

Specified by:

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

Specified by:

apply in interface Processor

doProcess

protected reactor.core.publisher.Mono<Event> doProcess(Event event,
                                                       ExecutionContextAdapter<org.mule.runtime.api.meta.model.operation.OperationModel> operationContext)

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<org.mule.runtime.api.meta.model.operation.OperationModel>

Throws:

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

getTarget

protected Optional<String> getTarget()

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<org.mule.runtime.api.meta.model.operation.OperationModel>

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<org.mule.runtime.api.meta.model.operation.OperationModel>

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<org.mule.runtime.api.meta.model.operation.OperationModel>

getEntityKeys

public org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getEntityKeys()
                                                                                                                          throws org.mule.runtime.api.metadata.MetadataResolvingException

Specified by:

getEntityKeys in interface org.mule.runtime.api.metadata.EntityMetadataProvider

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getEntityMetadata

public org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.TypeMetadataDescriptor> getEntityMetadata(org.mule.runtime.api.metadata.MetadataKey key)
                                                                                                                                          throws org.mule.runtime.api.metadata.MetadataResolvingException

Specified by:

getEntityMetadata in interface org.mule.runtime.api.metadata.EntityMetadataProvider

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

createExecutionMediator

protected ExecutionMediator createExecutionMediator()

validateOperationConfiguration

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

Validates that the operationModel is valid for the given configurationProvider

Specified by:

validateOperationConfiguration in class ExtensionComponent<org.mule.runtime.api.meta.model.operation.OperationModel>

Throws:

IllegalOperationException - If the validation fails

getParameterValueResolver

protected ParameterValueResolver getParameterValueResolver()

Specified by:

getParameterValueResolver in class ExtensionComponent<org.mule.runtime.api.meta.model.operation.OperationModel>

getProcessingType

public ReactiveProcessor.ProcessingType getProcessingType()

Specified by:

getProcessingType in interface ReactiveProcessor

resolveParameters

public ParametersResolverProcessor.ParametersResolverProcessorResult resolveParameters(Event event)
                                                                                throws org.mule.runtime.api.exception.MuleException

Specified by:

resolveParameters in interface ParametersResolverProcessor

Throws:

org.mule.runtime.api.exception.MuleException

disposeResolvedParameters

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

Specified by:

disposeResolvedParameters in interface ParametersResolverProcessor