org.mule.runtime.core.policy

Class CompositeSourcePolicy

java.lang.Object

org.mule.runtime.core.policy.AbstractCompositePolicy<SourcePolicyParametersTransformer,MessageSourceResponseParametersProcessor>

org.mule.runtime.core.policy.CompositeSourcePolicy

All Implemented Interfaces:

SourcePolicy

public class CompositeSourcePolicy
extends AbstractCompositePolicy<SourcePolicyParametersTransformer,MessageSourceResponseParametersProcessor>
implements SourcePolicy

SourcePolicy created from a list of Policy.

Implements the template methods from AbstractCompositePolicy required to work with source policies.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from class org.mule.runtime.core.policy.AbstractCompositePolicy

AbstractCompositePolicy.NextOperationCall

Constructor Summary

Constructors

Constructor and Description
CompositeSourcePolicy(List<Policy> parameterizedPolicies, Optional<SourcePolicyParametersTransformer> sourcePolicyParametersTransformer, SourcePolicyProcessorFactory sourcePolicyProcessorFactory, Processor flowExecutionProcessor, MessageSourceResponseParametersProcessor messageSourceResponseParametersProcessor) Creates a new source policies composed by several Policy that will be chain together.

Method Summary

Modifier and Type	Method and Description
Either<FailureSourcePolicyResult,SuccessSourcePolicyResult>	process(Event sourceEvent) Process the set of policies.
protected Event	processNextOperation(Event event) Executes the flow.
protected Event	processPolicy(Policy policy, Processor nextProcessor, Event event) Always return the policy execution / flow execution result so the next policy executes with the modified version of the wrapped policy / flow.

Methods inherited from class org.mule.runtime.core.policy.AbstractCompositePolicy

getParametersProcessor, getParametersTransformer, processPolicies

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeSourcePolicy

public CompositeSourcePolicy(List<Policy> parameterizedPolicies,
                             Optional<SourcePolicyParametersTransformer> sourcePolicyParametersTransformer,
                             SourcePolicyProcessorFactory sourcePolicyProcessorFactory,
                             Processor flowExecutionProcessor,
                             MessageSourceResponseParametersProcessor messageSourceResponseParametersProcessor)

Creates a new source policies composed by several Policy that will be chain together.

Parameters:

parameterizedPolicies - the list of policies to use in this composite policy.

sourcePolicyParametersTransformer - a transformer from a source response parameters to a message and vice versa

sourcePolicyProcessorFactory - factory to create a Processor from each Policy

flowExecutionProcessor - the operation that executes the flow

messageSourceResponseParametersProcessor - processor that gives access to the set of parameters to be sent originally by the source

Method Detail

processNextOperation

protected Event processNextOperation(Event event)
                              throws org.mule.runtime.api.exception.MuleException

Executes the flow. If there's a SourcePolicyParametersTransformer provided then it will use it to convert the source response or source failure response from the parameters back to a Message that can be routed through the policy chain which later will be convert back to response or failure response parameters thus allowing the policy chain to modify the response.. That message will be the result of the next-operation of the policy. If no SourcePolicyParametersTransformer is provided, then the same response from the flow is going to be routed as response of the next-operation of the policy chain. In this case, the same response from the flow is going to be used to generate the response or failure response for the source so the policy chain is not going to be able to modify the response sent by the source. When the flow execution fails, it will create a FlowExecutionException instead of a regular MessagingException to signal that the failure was through the the flow exception and not the policy logic.

Specified by:

processNextOperation in class AbstractCompositePolicy<SourcePolicyParametersTransformer,MessageSourceResponseParametersProcessor>

Parameters:

event - the event to use for executing the next operation.

Returns:

the event to use for processing the after phase of the policy

Throws:

org.mule.runtime.api.exception.MuleException - if there's an error executing processing the next operation.

processPolicy

protected Event processPolicy(Policy policy,
                              Processor nextProcessor,
                              Event event)
                       throws Exception

Always return the policy execution / flow execution result so the next policy executes with the modified version of the wrapped policy / flow.

Specified by:

processPolicy in class AbstractCompositePolicy<SourcePolicyParametersTransformer,MessageSourceResponseParametersProcessor>

Parameters:

policy - the policy to execute

nextProcessor - the next processor to use as the PolicyNextActionMessageProcessor. It will invoke the next policy in the chain.

event - the event to use for processing the policy.

Returns:

the result to use for the next policy in the chain.

Throws:

Exception - if the execution of the policy fails.

process

public Either<FailureSourcePolicyResult,SuccessSourcePolicyResult> process(Event sourceEvent)
                                                                    throws Exception

Process the set of policies. When there's a SourcePolicyParametersTransformer then the final set of parameters to be sent by the response function and the error response function will be calculated based on the output of the policy chain. If there's no SourcePolicyParametersTransformer then those parameters will be exactly the one defined by the message source.

Specified by:

process in interface SourcePolicy

Parameters:

sourceEvent - the event generated from the source.

Returns:

a SuccessSourcePolicyResult which contains the response parameters and the result event of the execution or a FailureSourcePolicyResult which contains the failure response parameters and the MessagingException thrown by the policy chain execution.

Throws:

Exception - if there was an unexpected failure thrown by executing the chain.