FreeMarker

The freemarker: component allows for processing a message using a FreeMarker template. This can be ideal when using Templating to generate responses for requests.

Maven users will need to add the following dependency to their pom.xml for this component:

URI format

Where templateName is the classpath-local URI of the template to invoke; or the complete URL of the remote template (eg: file://folder/myfile.ftl).

You can append query options to the URI in the following format, ?option=value&option=value&...

Options

Option

Default

Description

contentCache

true

Cache for the resource content when it's loaded.
Note: as of Camel 2.9 cached resource content can be cleared via JMX using the endpoint's clearContentCache operation.

encoding

null

Character encoding of the resource content.

templateUpdateDelay

5

Camel 2.9: Number of seconds the loaded template resource will remain in the cache.

Headers

Headers set during the FreeMarker evaluation are returned to the message and added as headers. This provides a mechanism for the FreeMarker component to return values to the Message.

An example: Set the header value of fruit in the FreeMarker template:

The header, fruit, is now accessible from the message.out.headers.

FreeMarker Context

Camel will provide exchange information in the FreeMarker context (just a Map). The Exchange is transferred as:

key

value

exchange

The Exchange itself.

exchange.properties

The Exchange properties.

headers

The headers of the In message.

camelContext

The Camel Context.

request

The In message.

body

The In message body.

response

The Out message (only for InOut message exchange pattern).

Hot reloading

The FreeMarker template resource is by default not hot reloadable for both file and classpath resources (expanded jar). If you set contentCache=false, then Camel will not cache the resource and hot reloading is thus enabled. This scenario can be used in development.

Dynamic templates

Camel provides two headers by which you can define a different resource location for a template or the template content itself. If any of these headers is set then Camel uses this over the endpoint configured resource. This allows you to provide a dynamic template at runtime.

Header

Type

Description

Support Version

FreemarkerConstants.FREEMARKER_RESOURCE

org.springframework.core.io.Resource

The template resource

<= 2.1

FreemarkerConstants.FREEMARKER_RESOURCE_URI

String

A URI for the template resource to use instead of the endpoint configured.

>= 2.1

FreemarkerConstants.FREEMARKER_TEMPLATE

String

The template to use instead of the endpoint configured.

>= 2.1

Samples

For example you could use something like:

To use a FreeMarker template to formulate a response for a message for InOut message exchanges (where there is a JMSReplyTo header).

If you want to use InOnly and consume the message and send it to another destination you could use:

And to disable the content cache, e.g. for development usage where the .ftl template should be hot reloaded:

And a file-based resource:

In Camel 2.1 it's possible to specify what template the component should use dynamically via a header, so for example:

The Email Sample

In this sample we want to use FreeMarker templating for an order confirmation email. The email template is laid out in FreeMarker as:

And the java code:

See Also

© 2004-2014 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram