org.mule.runtime.core.policy

Class AbstractCompositePolicy<ParametersTransformer,ParametersProcessor>

java.lang.Object

org.mule.runtime.core.policy.AbstractCompositePolicy<ParametersTransformer,ParametersProcessor>

Type Parameters:

ParametersTransformer - the type of the function parameters transformer.

ParametersProcessor - the type of the parameters processor that provides access to the initial value of the parameters.

Direct Known Subclasses:

CompositeOperationPolicy, CompositeSourcePolicy

public abstract class AbstractCompositePolicy<ParametersTransformer,ParametersProcessor>
extends Object

Abstract implementation that performs the chaining of a set of policies and the Processor being intercepted.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractCompositePolicy.NextOperationCall Inner class that implements the actually chaining of policies.

Constructor Summary

Constructors

Constructor and Description
AbstractCompositePolicy(List<Policy> policies, Optional<ParametersTransformer> parametersTransformer, ParametersProcessor parametersProcessor) Creates a new composite policy.

Method Summary

Modifier and Type	Method and Description
protected ParametersProcessor	getParametersProcessor()
protected Optional<ParametersTransformer>	getParametersTransformer()
protected abstract Event	processNextOperation(Event event) Template method for executing the final processor of the chain.
Event	processPolicies(Event operationEvent) When this policy is processed, it will use the CompositeOperationPolicy.NextOperationCall which will keep track of the different policies to be applied and the current index of the policy under execution.
protected abstract Event	processPolicy(Policy policy, Processor nextProcessor, Event event) Template method for executing a policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCompositePolicy

public AbstractCompositePolicy(List<Policy> policies,
                               Optional<ParametersTransformer> parametersTransformer,
                               ParametersProcessor parametersProcessor)

Creates a new composite policy.

Parameters:

policies - list of Policy to chain together.

parametersTransformer - transformer from the operation parameters to a message and vice versa.

Method Detail

processPolicies

public final Event processPolicies(Event operationEvent)
                            throws Exception

When this policy is processed, it will use the CompositeOperationPolicy.NextOperationCall which will keep track of the different policies to be applied and the current index of the policy under execution.

The first time, the first policy in the parameterizedPolicies will be executed, it will receive as it next operation the same instance of CompositeOperationPolicy.NextOperationCall, and since CompositeOperationPolicy.NextOperationCall keeps track of the policy executed, it will execute the following policy in the chain until the finally policy it's executed in which case then next operation of it, it will be the operation execution.

Throws:

Exception

getParametersTransformer

protected Optional<ParametersTransformer> getParametersTransformer()

Returns:

the parameters transformer that converts the message to function parameters and vice versa.

getParametersProcessor

protected ParametersProcessor getParametersProcessor()

Returns:

the parameters processors that generates the parameters to be sent.

processNextOperation

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

Template method for executing the final processor of the chain.

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 abstract Event processPolicy(Policy policy,
                                       Processor nextProcessor,
                                       Event event)
                                throws Exception

Template method for executing a policy.

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.