...
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.vm).
...
Option | Default | Description |
|---|---|---|
|
| Velocity based file loader cache. |
|
| Cache for the resource content when it is loaded. |
|
| Character encoding of the resource content. |
|
| New option in Camel 2.1: The URI of the properties file which is used for VelocityEngine initialization. |
...
...
Header | Description |
|---|---|
| The templateName as a |
| Camel 2.16: To add additional information to the used VelocityContext. The value of this header should be a |
...
...
For example, to set the header value of fruit in the Velocity template .tm:
...
...
The fruit header is now accessible from the message.out.headers.
...
Camel will provide exchange information in the Velocity context (just a Map). The Exchange is transfered as:
...
key | value |
|---|---|
| The |
| The |
| The headers of the In message. |
| The Camel Context instance. |
| The In message. |
| The In message. |
| The In message body. |
| The Out message (only for InOut message exchange pattern). |
| The Out message (only for InOut message exchange pattern). |
Since Camel-2.14, you can setup a custom Velocity Context yourself by setting the message header CamelVelocityContext just like this
...
...
Hot reloading
The Velocity template resource is, by default, hot reloadable for both file and classpath resources (expanded jar). If you set contentCache=true, Camel will only load the resource once, and thus hot reloading is not possible. This scenario can be used in production, when the resource never changes.
...
Header | Type | Description |
|---|---|---|
CamelVelocityResourceUri | String | Camel |
...
2.1: |
...
A |
...
URI |
...
for |
...
the |
...
template |
...
resource |
...
to |
...
use |
...
instead |
...
of |
...
the |
...
endpoint |
...
configured. |
...
CamelVelocityTemplate | String | Camel 2.1: |
...
The |
...
template |
...
to |
...
use |
...
instead |
...
of |
...
the |
...
endpoint |
...
configured. |
...
...
For example you could use something like
...
To use a Velocity template to formulate a response to 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 the following route:
...
And to use the content cache, e.g. for use in production, where the .vm template never changes:
...
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:
...
...
In Camel 2.1 it's possible to specify a template directly as a header the component should use dynamically via a header, so for example:
...
...
The Email Sample
In this sample we want to use Velocity templating for an order confirmation email. The email template is laid out in Velocity as:
...
...
And the java code:
...
...