org.mule.runtime.core.el.mvel

Class MVELExpressionLanguage

java.lang.Object

org.mule.runtime.core.el.mvel.MVELExpressionLanguage

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, ExpressionLanguageAdaptor, ExtendedExpressionLanguageAdaptor

public class MVELExpressionLanguage
extends Object
implements ExtendedExpressionLanguageAdaptor, org.mule.runtime.api.lifecycle.Initialisable

Expression language that uses MVEL (http://mvel.codehaus.org/).

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	aliases
protected boolean	autoResolveVariables
protected MvelEnricherDataTypePropagator	dataTypePropagator
protected MvelDataTypeResolver	dataTypeResolver
protected MVELExpressionExecutor	expressionExecutor
protected org.mule.mvel2.integration.VariableResolverFactory	globalContext
protected Map<String,org.mule.mvel2.ast.Function>	globalFunctions
protected String	globalFunctionsFile
protected String	globalFunctionsString
protected Map<String,Class<?>>	imports
protected MuleContext	muleContext
static String	OBJECT_FOR_ENRICHMENT
protected org.mule.mvel2.ParserConfiguration	parserConfiguration
protected org.mule.mvel2.integration.VariableResolverFactory	staticContext

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
MVELExpressionLanguage(MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
void	addAlias(String name, String expression)
void	addGlobalBindings(org.mule.runtime.api.el.BindingContext bindingContext) Registers the given BindingContext entries as globals.
void	addGlobalFunction(String name, org.mule.mvel2.ast.Function function)
void	addImport(String name, Class<?> clazz)
protected static void	configureParserConfiguration(org.mule.mvel2.ParserConfiguration parserConfiguration, Map<String,Class<?>> imports)
protected String	createEnrichmentExpression(String expression)
protected MVELExpressionLanguageContext	createExpressionLanguageContext()
static org.mule.mvel2.ParserConfiguration	createParserConfiguration(Map<String,Class<?>> imports)
protected void	createStaticContext()
protected org.mule.mvel2.integration.VariableResolverFactory	createVariableVariableResolverFactory(Event event, Event.Builder eventBuilder)
void	enrich(String expression, Event event, Event.Builder eventBuilder, FlowConstruct flowConstruct, Object object) Enriches an event.
void	enrich(String expression, Event event, Event.Builder eventBuilder, FlowConstruct flowConstruct, org.mule.runtime.api.metadata.TypedValue typedValue) Enriches an event using a typed value.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType expectedOutputType, Event event, org.mule.runtime.api.el.BindingContext context) Evaluates an expression according to a given BindingContext and outputs .
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType expectedOutputType, Event event, FlowConstruct flowConstruct, org.mule.runtime.api.el.BindingContext context, boolean failOnNull) Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, org.mule.runtime.api.el.BindingContext context) Evaluates an expression according to a given BindingContext.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, Event.Builder eventBuilder, FlowConstruct flowConstruct, org.mule.runtime.api.el.BindingContext bindingContext) 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 bindingContext) Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.
protected <T> T	evaluateInternal(String expression, MVELExpressionLanguageContext variableResolverFactory)
<T> T	evaluateUntyped(String expression, Event event, Event.Builder eventBuilder, FlowConstruct flowConstruct, Map<String,Object> vars)
<T> T	evaluateUntyped(String expression, Map<String,Object> vars)
Map<String,String>	getAliases()
Map<String,org.mule.mvel2.ast.Function>	getGlobalFunctions()
org.mule.mvel2.ParserConfiguration	getParserConfiguration()
void	initialise()
protected void	loadGlobalFunctions()
static String	removeExpressionMarker(String expression)
void	setAliases(Map<String,String> aliases)
void	setAutoResolveVariables(boolean autoResolveVariables)
void	setDataTypeResolver(MvelDataTypeResolver dataTypeResolver)
void	setGlobalFunctionsFile(String globalFunctionsFile)
void	setGlobalFunctionsString(String globalFunctionsString)
void	setImports(Map<String,Class<?>> imports)
Iterator<org.mule.runtime.api.metadata.TypedValue<?>>	split(String expression, Event event, org.mule.runtime.api.el.BindingContext bindingContext) Splits using the specified expression and group it with the batch size.
Iterator<org.mule.runtime.api.metadata.TypedValue<?>>	split(String expression, Event event, FlowConstruct flowConstruct, org.mule.runtime.api.el.BindingContext bindingContext) Splits using the specified expression and group it with the batch size.
org.mule.runtime.api.el.ValidationResult	validate(String expression) Verifies whether an expression is valid or not syntactically.

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_FOR_ENRICHMENT

public static final String OBJECT_FOR_ENRICHMENT

See Also:

Constant Field Values

parserConfiguration

protected org.mule.mvel2.ParserConfiguration parserConfiguration

muleContext

protected MuleContext muleContext

expressionExecutor

protected MVELExpressionExecutor expressionExecutor

staticContext

protected org.mule.mvel2.integration.VariableResolverFactory staticContext

globalContext

protected org.mule.mvel2.integration.VariableResolverFactory globalContext

globalFunctionsString

protected String globalFunctionsString

globalFunctionsFile

protected String globalFunctionsFile

globalFunctions

protected Map<String,org.mule.mvel2.ast.Function> globalFunctions

aliases

protected Map<String,String> aliases

imports

protected Map<String,Class<?>> imports

autoResolveVariables

protected boolean autoResolveVariables

dataTypeResolver

protected MvelDataTypeResolver dataTypeResolver

dataTypePropagator

protected MvelEnricherDataTypePropagator dataTypePropagator

Constructor Detail

MVELExpressionLanguage

@Inject
public MVELExpressionLanguage(MuleContext muleContext)

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

createStaticContext

protected void createStaticContext()

loadGlobalFunctions

protected void loadGlobalFunctions()
                            throws org.mule.runtime.api.lifecycle.InitialisationException

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

evaluateUntyped

public <T> T evaluateUntyped(String expression,
                             Map<String,Object> vars)

evaluateUntyped

public <T> T evaluateUntyped(String expression,
                             Event event,
                             Event.Builder eventBuilder,
                             FlowConstruct flowConstruct,
                             Map<String,Object> vars)

enrich

public void enrich(String expression,
                   Event event,
                   Event.Builder eventBuilder,
                   FlowConstruct flowConstruct,
                   Object object)

Description copied from interface: ExtendedExpressionLanguageAdaptor

Enriches an event. 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 ExtendedExpressionLanguageAdaptor

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

object - The object used for enrichment

enrich

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

Description copied from interface: ExtendedExpressionLanguageAdaptor

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 ExtendedExpressionLanguageAdaptor

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

typedValue - The typed value used for enrichment

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: ExpressionLanguageAdaptor

Splits using the specified expression and group it with the batch size. If batch size is less or equals to zero then no batching is done. The expression should return a collection of elements.

Specified by:

split in interface ExpressionLanguageAdaptor

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: ExpressionLanguageAdaptor

Splits using the specified expression and group it with the batch size. If batch size is less or equals to zero then no batching is done. The expression should return a collection of elements.

Specified by:

split in interface ExpressionLanguageAdaptor

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

addGlobalBindings

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

Description copied from interface: ExpressionLanguageAdaptor

Registers the given BindingContext entries as globals. Notice globals cannot be removed once registered, only overwritten by the registration of a binding with the same identifier. Implementations should be thread safe to avoid race conditions between registration and expression evaluation.

Specified by:

addGlobalBindings in interface ExpressionLanguageAdaptor

Parameters:

bindingContext - the context to register

evaluate

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

Description copied from interface: ExpressionLanguageAdaptor

Evaluates an expression according to a given BindingContext.

Specified by:

evaluate in interface ExpressionLanguageAdaptor

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.metadata.DataType expectedOutputType,
                                                         Event event,
                                                         org.mule.runtime.api.el.BindingContext context)
                                                  throws ExpressionRuntimeException

Description copied from interface: ExpressionLanguageAdaptor

Evaluates an expression according to a given BindingContext and outputs .

Specified by:

evaluate in interface ExpressionLanguageAdaptor

Parameters:

expression - the expression to be executed

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

event - the current event being processed

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluate

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

Description copied from interface: ExpressionLanguageAdaptor

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

Specified by:

evaluate in interface ExpressionLanguageAdaptor

Parameters:

expression - the expression to be executed

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

event - the current event being processed

flowConstruct - the flow where the event is being processed

context - the bindings to consider

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

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluate

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

Description copied from interface: ExpressionLanguageAdaptor

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

Specified by:

evaluate in interface ExpressionLanguageAdaptor

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.

evaluate

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

Description copied from interface: ExtendedExpressionLanguageAdaptor

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 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 ExtendedExpressionLanguageAdaptor

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

bindingContext - the bindings to consider

Returns:

the result of execution of the expression.

evaluateInternal

protected <T> T evaluateInternal(String expression,
                                 MVELExpressionLanguageContext variableResolverFactory)

validate

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

Description copied from interface: ExpressionLanguageAdaptor

Verifies whether an expression is valid or not syntactically.

Specified by:

validate in interface ExpressionLanguageAdaptor

Parameters:

expression - to be validated

Returns:

a ValidationResult indicating whether the validation was successful or not

createExpressionLanguageContext

protected MVELExpressionLanguageContext createExpressionLanguageContext()

createParserConfiguration

public static org.mule.mvel2.ParserConfiguration createParserConfiguration(Map<String,Class<?>> imports)

configureParserConfiguration

protected static void configureParserConfiguration(org.mule.mvel2.ParserConfiguration parserConfiguration,
                                                   Map<String,Class<?>> imports)

setGlobalFunctionsString

public void setGlobalFunctionsString(String globalFunctionsString)

setAliases

public void setAliases(Map<String,String> aliases)

setImports

public void setImports(Map<String,Class<?>> imports)

setAutoResolveVariables

public void setAutoResolveVariables(boolean autoResolveVariables)

setDataTypeResolver

public void setDataTypeResolver(MvelDataTypeResolver dataTypeResolver)

addGlobalFunction

public void addGlobalFunction(String name,
                              org.mule.mvel2.ast.Function function)

addImport

public void addImport(String name,
                      Class<?> clazz)

addAlias

public void addAlias(String name,
                     String expression)

setGlobalFunctionsFile

public void setGlobalFunctionsFile(String globalFunctionsFile)

createVariableVariableResolverFactory

protected org.mule.mvel2.integration.VariableResolverFactory createVariableVariableResolverFactory(Event event,
                                                                                                   Event.Builder eventBuilder)

getAliases

public Map<String,String> getAliases()

getGlobalFunctions

public Map<String,org.mule.mvel2.ast.Function> getGlobalFunctions()

getParserConfiguration

public org.mule.mvel2.ParserConfiguration getParserConfiguration()

removeExpressionMarker

public static String removeExpressionMarker(String expression)

createEnrichmentExpression

protected String createEnrichmentExpression(String expression)