org.apache.camel.language.simple

Class SimpleLanguage

java.lang.Object

org.apache.camel.support.LanguageSupport

org.apache.camel.language.simple.SimpleLanguage

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.spi.Language, org.apache.camel.StaticService

Direct Known Subclasses:

FileLanguage

@Language(value="simple")
public class SimpleLanguage
extends org.apache.camel.support.LanguageSupport
implements org.apache.camel.StaticService

A simple language which maps simple property style notations to access headers and bodies. Examples of supported expressions are:

• exchangeId to access the exchange id
• id to access the inbound message id
• in.body or body to access the inbound body
• in.body.OGNL or body.OGNL to access the inbound body using an OGNL expression
• mandatoryBodyAs(<classname>) to convert the in body to the given type, will throw exception if not possible to convert
• bodyAs(<classname>) to convert the in body to the given type, will return null if not possible to convert
• headerAs(<key>, <classname>) to convert the in header to the given type, will return null if not possible to convert
• out.body to access the inbound body
• in.header.foo or header.foo to access an inbound header called 'foo'
• in.header.foo[bar] or header.foo[bar] to access an inbound header called 'foo' as a Map and lookup the map with 'bar' as key
• in.header.foo.OGNL or header.OGNL to access an inbound header called 'foo' using an OGNL expression
• out.header.foo to access an outbound header called 'foo'
• property.foo to access the exchange property called 'foo'
• property.foo.OGNL to access the exchange property called 'foo' using an OGNL expression
• sys.foo to access the system property called 'foo'
• sysenv.foo to access the system environment called 'foo'
• exception.messsage to access the exception message
• threadName to access the current thread name
• date:<command> evaluates to a Date object Supported commands are: now for current timestamp, in.header.xxx or header.xxx to use the Date object in the in header. out.header.xxx to use the Date object in the out header. property.xxx to use the Date object in the exchange property. file for the last modified timestamp of the file (available with a File consumer). Command accepts offsets such as: now-24h or in.header.xxx+1h or even now+1h30m-100.
• date:<command>:<pattern> for date formatting using SimpleDateFormat patterns
• date-with-timezone:<command>:<timezone>:<pattern> for date formatting using SimpleDateFormat timezones and patterns
• bean:<bean expression> to invoke a bean using the BeanLanguage
• properties:<[locations]>:<key> for using property placeholders using the org.apache.camel.component.properties.PropertiesComponent. The locations parameter is optional and you can enter multiple locations separated with comma.

The simple language supports OGNL notation when accessing either body or header.

The simple language now also includes file language out of the box which means the following expression is also supported:

• file:name to access the file name (is relative, see note below))
• file:name.noext to access the file name with no extension
• file:name.ext to access the file extension
• file:ext to access the file extension
• file:onlyname to access the file name (no paths)
• file:onlyname.noext to access the file name (no paths) with no extension
• file:parent to access the parent file name
• file:path to access the file path name
• file:absolute is the file regarded as absolute or relative
• file:absolute.path to access the absolute file path name
• file:length to access the file length as a Long type
• file:size to access the file length as a Long type
• file:modified to access the file last modified as a Date type

The relative file is the filename with the starting directory clipped, as opposed to path that will return the full path including the starting directory.
The only file is the filename only with all paths clipped.

Field Summary

Fields inherited from class org.apache.camel.support.LanguageSupport

RESOURCE

Constructor Summary

Constructors

Constructor and Description
SimpleLanguage() Default constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Expression	createExpression(String expression)
org.apache.camel.Expression	createExpression(String expression, Class<?> resultType)
org.apache.camel.Predicate	createPredicate(String expression)
static org.apache.camel.Expression	expression(String expression) Creates a new Expression.
static boolean	hasSimpleFunction(String expression) Does the expression include a simple function.
void	init()
static org.apache.camel.Predicate	predicate(String predicate) Creates a new Predicate.
static org.apache.camel.Expression	simple(String expression) Creates a new Expression.
static org.apache.camel.Expression	simple(String expression, Class<?> resultType) Creates a new Expression (or Predicate if the resultType is a Boolean, or boolean type).
void	start()
void	stop()

Methods inherited from class org.apache.camel.support.LanguageSupport

getCamelContext, isSingleton, loadResource, setCamelContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Constructor Detail

SimpleLanguage

public SimpleLanguage()

Default constructor.

Method Detail

init

public void init()

Specified by:

init in interface org.apache.camel.Service

start

public void start()

Specified by:

start in interface org.apache.camel.Service

stop

public void stop()

Specified by:

stop in interface org.apache.camel.Service

createPredicate

public org.apache.camel.Predicate createPredicate(String expression)

Specified by:

createPredicate in interface org.apache.camel.spi.Language

createExpression

public org.apache.camel.Expression createExpression(String expression)

Specified by:

createExpression in interface org.apache.camel.spi.Language

simple

public static org.apache.camel.Expression simple(String expression)

Creates a new Expression.

Important: If you need to use a predicate (function to return true|false) then use predicate(String) instead.

simple

public static org.apache.camel.Expression simple(String expression,
                                                 Class<?> resultType)

Creates a new Expression (or Predicate if the resultType is a Boolean, or boolean type).

createExpression

public org.apache.camel.Expression createExpression(String expression,
                                                    Class<?> resultType)

expression

public static org.apache.camel.Expression expression(String expression)

Creates a new Expression.

Important: If you need to use a predicate (function to return true|false) then use predicate(String) instead.

predicate

public static org.apache.camel.Predicate predicate(String predicate)

Creates a new Predicate.

hasSimpleFunction

public static boolean hasSimpleFunction(String expression)

Does the expression include a simple function.

Parameters:

expression - the expression

Returns:

true if one or more simple function is included in the expression