org.mule.runtime.api.interception

Interface FlowInterceptorFactory

All Superinterfaces:

Supplier<FlowInterceptor>

public interface FlowInterceptorFactory
extends Supplier<FlowInterceptor>

Abstract Factory for creating FlowInterceptor instances.

Implementations may have fields annotated with @Inject, which will be resolved before attempting to call Supplier.get().

Since:

1.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FlowInterceptorFactory.FlowInterceptorOrder

Field Summary

Fields

Modifier and Type	Field and Description
static String	FLOW_INTERCEPTORS_ORDER_REGISTRY_KEY By making a FlowInterceptorFactory.FlowInterceptorOrder available in the Registry with this key, the order in which the FlowInterceptorFactories products will be applied to the applicable components. can be customized.

Method Summary

Modifier and Type	Method and Description
default boolean	intercept(String flowName) Determines if a FlowInterceptor shall be created by this factory to be applied to a flow based on its name.

Methods inherited from interface java.util.function.Supplier

get

Field Detail

FLOW_INTERCEPTORS_ORDER_REGISTRY_KEY

static final String FLOW_INTERCEPTORS_ORDER_REGISTRY_KEY

By making a FlowInterceptorFactory.FlowInterceptorOrder available in the Registry with this key, the order in which the FlowInterceptorFactories products will be applied to the applicable components. can be customized.

For each factory, its fully qualified class name will be obtained and matched against the passed packagesOrder to sort the factories. In the case there is more than one factory with a package name prefix, the order in which they were added will be kept.

Assuming this is called with parameters ("org.package", "com.plugin"), and the following factories have been added through #addInterceptorFactory(FlowInterceptorFactory) (in this order):

1. com.plugin.SomeInterceptor
2. org.mule.MuleInterceptor
3. org.package.logging.LoggerInterceptor
4. com.plugin.SomeOtherInterceptor
5. org.mule.OtherMuleInterceptor

Those factories will be sorted, when obtained through #getInterceptorFactories() like this:

1. org.package.logging.LoggerInterceptor
2. com.plugin.SomeInterceptor
3. com.plugin.SomeOtherInterceptor
4. org.mule.MuleInterceptor
5. org.mule.OtherMuleInterceptor

See Also:

Constant Field Values

Method Detail

intercept

default boolean intercept(String flowName)

Determines if a FlowInterceptor shall be created by this factory to be applied to a flow based on its name.

Parameters:

flowName - the name of the to-be intercepted flow.

Returns:

true if this handler must be applied to the flow with the provided name, false otherwise.