org.mule.runtime.core.el

Class DefaultExpressionManager

java.lang.Object

org.mule.runtime.core.el.DefaultExpressionManager

All Implemented Interfaces:

org.mule.runtime.api.el.ExpressionLanguage, org.mule.runtime.api.el.MuleExpressionLanguage, org.mule.runtime.api.lifecycle.Initialisable, ExpressionManager, ExtendedExpressionManager

public class DefaultExpressionManager
extends Object
implements ExtendedExpressionManager, org.mule.runtime.api.lifecycle.Initialisable

Field Summary

Fields

Modifier and Type	Field and Description
static String	DW_PREFIX
static String	MEL_PREFIX
static String	PREFIX_EXPR_SEPARATOR

Fields inherited from interface org.mule.runtime.core.api.el.ExpressionManager

DEFAULT_EXPRESSION_POSTFIX, DEFAULT_EXPRESSION_PREFIX

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultExpressionManager(MuleContext muleContext, StreamingManager streamingManager)

Method Summary

Modifier and Type	Method and Description
void	addGlobalBindings(org.mule.runtime.api.el.BindingContext bindingContext)
void	enrich(String expression, Event event, Event.Builder eventBuilder, FlowConstruct flowConstruct, org.mule.runtime.api.metadata.TypedValue value) Enriches an event using a typed value.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.el.BindingContext context)
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType outputType) Evaluates an expression according to the global BindingContext and the DataType of the expected result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType outputType, org.mule.runtime.api.el.BindingContext context)
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType outputType, org.mule.runtime.api.el.BindingContext context, Event event) Evaluates an expression according to a given BindingContext, the global one, the DataType of the expected result and an Event.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType outputType, org.mule.runtime.api.el.BindingContext context, Event event, FlowConstruct flowConstruct, boolean failOnNull) Evaluates an expression according to a given BindingContext, the global one, the DataType of the expected result and an Event.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, org.mule.runtime.api.el.BindingContext context) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, Event.Builder eventBuilder, FlowConstruct flowConstruct) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, FlowConstruct flowConstruct) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, FlowConstruct flowConstruct, org.mule.runtime.api.el.BindingContext context) Execute the expression returning the result.
boolean	evaluateBoolean(String expression, Event event, FlowConstruct flowConstruct) Evaluates an expression considering a boolean as output.
boolean	evaluateBoolean(String expression, Event event, FlowConstruct flowConstruct, boolean nullReturnsTrue, boolean nonBooleanReturnsTrue) Evaluates an expression considering a boolean as output.
static boolean	hasMelExpression(String expression) Checks if an expression has MEL prefix.
void	initialise()
boolean	isExpression(String expression)
boolean	isValid(String expression)
String	parse(String expression, Event event, FlowConstruct flowConstruct) Evaluates expressions in a given string.
protected boolean	resolveBoolean(Object result, boolean nullReturnsTrue, boolean nonBooleanReturnsTrue, String expression)
Iterator<org.mule.runtime.api.metadata.TypedValue<?>>	split(String expression, org.mule.runtime.api.el.BindingContext context)
Iterator<org.mule.runtime.api.metadata.TypedValue<?>>	split(String expression, Event event, org.mule.runtime.api.el.BindingContext bindingContext) Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.
Iterator<org.mule.runtime.api.metadata.TypedValue<?>>	split(String expression, Event event, FlowConstruct flowConstruct, org.mule.runtime.api.el.BindingContext bindingContext) Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.
org.mule.runtime.api.el.ValidationResult	validate(String expression)

Methods inherited from class java.lang.Object

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

Field Detail

DW_PREFIX

public static final String DW_PREFIX

See Also:

Constant Field Values

MEL_PREFIX

public static final String MEL_PREFIX

See Also:

Constant Field Values

PREFIX_EXPR_SEPARATOR

public static final String PREFIX_EXPR_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

DefaultExpressionManager

@Inject
public DefaultExpressionManager(MuleContext muleContext,
                                        StreamingManager streamingManager)

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

addGlobalBindings

public void addGlobalBindings(org.mule.runtime.api.el.BindingContext bindingContext)

Specified by:

addGlobalBindings in interface org.mule.runtime.api.el.ExpressionLanguage

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression)

Description copied from interface: ExpressionManager

Execute the expression returning the result. The expression will be executed by the expression language implementation without making any event or message context available.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the expression to be executed

Returns:

the result of execution of the expression.

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         Event event)

Description copied from interface: ExpressionManager

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the expression to be executed

event - the current event being processed

Returns:

the result of execution of the expression.

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         org.mule.runtime.api.el.BindingContext context)

Specified by:

evaluate in interface org.mule.runtime.api.el.ExpressionLanguage

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         Event event,
                                                         org.mule.runtime.api.el.BindingContext context)

Description copied from interface: ExpressionManager

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the expression to be executed

event - the current event being processed

context - the bindings to be considered

Returns:

the result of execution of the expression.

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         Event event,
                                                         FlowConstruct flowConstruct)

Description copied from interface: ExpressionManager

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the expression to be executed

event - the current event being processed

flowConstruct - the flow where the event is being processed

Returns:

the result of execution of the expression.

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         Event event,
                                                         Event.Builder eventBuilder,
                                                         FlowConstruct flowConstruct)

Description copied from interface: ExtendedExpressionManager

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message.

This version of evaluate allows Event or InternalMessage mutation performed within the expression to be maintained post-evaluation via the use of a result Event.Builder which should be created from the original event before being passed and then used to construct the post-evaluation event.

Specified by:

evaluate in interface ExtendedExpressionManager

Parameters:

expression - the expression to be executed

event - the current event being processed

eventBuilder - event builder instance used to mutate the current message or event.

flowConstruct - the flow where the event is being processed

Returns:

the result of execution of the expression.

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         Event event,
                                                         FlowConstruct flowConstruct,
                                                         org.mule.runtime.api.el.BindingContext context)

Description copied from interface: ExpressionManager

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message. A Map of variables can be provided that will be able to the expression when executed. Variable provided in the map will only be available if there are no conflict with context variables provided by the expression language implementation.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the expression to be executed

event - the current event being processed

flowConstruct - the flow where the event is being processed

context - the bindings to be considered

Returns:

the result of execution of the expression.

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         org.mule.runtime.api.metadata.DataType outputType)

Description copied from interface: ExpressionManager

Evaluates an expression according to the global BindingContext and the DataType of the expected result.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the EL expression

outputType - the expected output type so that automatic conversion can be performed for the resulting value type.

Returns:

the result of the expression plus its type

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         org.mule.runtime.api.metadata.DataType outputType,
                                                         org.mule.runtime.api.el.BindingContext context)

Specified by:

evaluate in interface org.mule.runtime.api.el.ExpressionLanguage

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         org.mule.runtime.api.metadata.DataType outputType,
                                                         org.mule.runtime.api.el.BindingContext context,
                                                         Event event)

Description copied from interface: ExpressionManager

Evaluates an expression according to a given BindingContext, the global one, the DataType of the expected result and an Event.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the EL expression

outputType - the expected output type so that automatic conversion can be performed for the resulting value type.

context - an expression binding context to consider

event - the current event to consider

Returns:

the result of the expression plus its type

evaluate

public org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                         org.mule.runtime.api.metadata.DataType outputType,
                                                         org.mule.runtime.api.el.BindingContext context,
                                                         Event event,
                                                         FlowConstruct flowConstruct,
                                                         boolean failOnNull)
                                                  throws ExpressionRuntimeException

Description copied from interface: ExpressionManager

Evaluates an expression according to a given BindingContext, the global one, the DataType of the expected result and an Event.

Specified by:

evaluate in interface ExpressionManager

Parameters:

expression - the EL expression

outputType - the expected output type so that automatic conversion can be performed for the resulting value type.

context - an expression binding context to consider

event - the current event to consider

flowConstruct - the flow where the event is being processed

failOnNull - indicates if should fail if the evaluation result is null

Returns:

the result of the expression plus its type

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression or during transformation

enrich

public void enrich(String expression,
                   Event event,
                   Event.Builder eventBuilder,
                   FlowConstruct flowConstruct,
                   org.mule.runtime.api.metadata.TypedValue value)

Description copied from interface: ExtendedExpressionManager

Enriches an event using a typed value.

This version of enrich allows Event or InternalMessage mutation performed within the expression to be maintained post-evaluation via the use of a result Event.Builder which should be created from the original event before being passed and then used to construct the post-evaluation event.

Specified by:

enrich in interface ExtendedExpressionManager

Parameters:

expression - a single expression i.e. header://foo that defines how the message should be enriched

event - The event to be enriched

eventBuilder - event builder instance used to mutate the current message or event.

flowConstruct - the flow where the event is being processed

value - The typed value used for enrichment

evaluateBoolean

public boolean evaluateBoolean(String expression,
                               Event event,
                               FlowConstruct flowConstruct)
                        throws ExpressionRuntimeException

Description copied from interface: ExpressionManager

Evaluates an expression considering a boolean as output. If the result cannot be clearly transformed or is null, false will be returned.

Specified by:

evaluateBoolean in interface ExpressionManager

Parameters:

expression - a single expression to be evaluated and transformed

event - the Event to consider

flowConstruct - the FlowConstruct to consider

Returns:

true if the expression evaluated to that or "true", false otherwise

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluateBoolean

public boolean evaluateBoolean(String expression,
                               Event event,
                               FlowConstruct flowConstruct,
                               boolean nullReturnsTrue,
                               boolean nonBooleanReturnsTrue)
                        throws ExpressionRuntimeException

Description copied from interface: ExpressionManager

Evaluates an expression considering a boolean as output.

Specified by:

evaluateBoolean in interface ExpressionManager

Parameters:

expression - a single expression to be evaluated and transformed

event - the Event to consider

flowConstruct - the FlowConstruct to consider

nullReturnsTrue - whether or not a null outcome should be considered a true

nonBooleanReturnsTrue - whether or not a non boolean outcome should be considered a true

Returns:

true if the expression evaluated to that, "true" or the above flags where considered, false otherwise

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

resolveBoolean

protected boolean resolveBoolean(Object result,
                                 boolean nullReturnsTrue,
                                 boolean nonBooleanReturnsTrue,
                                 String expression)

parse

public String parse(String expression,
                    Event event,
                    FlowConstruct flowConstruct)
             throws ExpressionRuntimeException

Description copied from interface: ExtendedExpressionManager

Evaluates expressions in a given string. This method will iterate through each expression and evaluate it. If a user needs to evaluate a single expression they can use ExpressionManager.evaluate(String, Event, FlowConstruct, BindingContext).

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Specified by:

parse in interface ExtendedExpressionManager

Parameters:

expression - one or more expressions ebedded in a literal string i.e. "Value is #[mel:xpath://foo] other value is #[mel:header:foo]."

event - The current event being processed

flowConstruct - the flow where the event is being processed

Returns:

the result of the evaluation

Throws:

ExpressionRuntimeException - if the expression is invalid, or a null is found for the expression and 'failIfNull is set to true.

split

public Iterator<org.mule.runtime.api.metadata.TypedValue<?>> split(String expression,
                                                                   Event event,
                                                                   FlowConstruct flowConstruct,
                                                                   org.mule.runtime.api.el.BindingContext bindingContext)
                                                            throws ExpressionRuntimeException

Description copied from interface: ExpressionManager

Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.

Specified by:

split in interface ExpressionManager

Parameters:

expression - the expression to be executed

event - the current event being processed

flowConstruct - the flow where the event is being processed

bindingContext - the bindings to consider

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

split

public Iterator<org.mule.runtime.api.metadata.TypedValue<?>> split(String expression,
                                                                   Event event,
                                                                   org.mule.runtime.api.el.BindingContext bindingContext)
                                                            throws ExpressionRuntimeException

Description copied from interface: ExpressionManager

Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.

Specified by:

split in interface ExpressionManager

Parameters:

expression - the expression to be executed

event - the current event being processed

bindingContext - the bindings to consider

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

isExpression

public boolean isExpression(String expression)

Specified by:

isExpression in interface org.mule.runtime.api.el.MuleExpressionLanguage

isValid

public boolean isValid(String expression)

Specified by:

isValid in interface org.mule.runtime.api.el.MuleExpressionLanguage

validate

public org.mule.runtime.api.el.ValidationResult validate(String expression)

Specified by:

validate in interface org.mule.runtime.api.el.ExpressionLanguage

split

public Iterator<org.mule.runtime.api.metadata.TypedValue<?>> split(String expression,
                                                                   org.mule.runtime.api.el.BindingContext context)

Specified by:

split in interface org.mule.runtime.api.el.ExpressionLanguage

hasMelExpression

public static boolean hasMelExpression(String expression)

Checks if an expression has MEL prefix.

Parameters:

expression - the expression to check to see if is a MEL expression.

Returns:

true if the expression is a MEL expression