Chapter 39. FreeMarker

FreeMarker
复制链接

The freemarker: component allows you to process 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:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-freemarker</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-freemarker</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

Copy to Clipboard

Toggle word wrap

URI format
复制链接

freemarker:templateName[?options]

freemarker:templateName[?options]

Copy to Clipboard

Toggle word wrap

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

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

Options
复制链接

Expand

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.

FreeMarker Context
复制链接

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

Expand

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).

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

Dynamic templates
复制链接

Available as of Camel 2.1 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.

Expand

Header	Type	Description	Support Version
FreemarkerConstants.FREEMARKER_RESOURCE	org.springframework.core.io.Resource	The template resource	<= 1.6.2, <= 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 can define a route like the following:

from("activemq:My.Queue").
  to("freemarker:com/acme/MyResponse.ftl");

from("activemq:My.Queue").
  to("freemarker:com/acme/MyResponse.ftl");

Copy to Clipboard

Toggle word wrap

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

If you want to process InOnly exchanges, you could use a FreeMarker template to transform the message before sending it on to another endpoint:

from("activemq:My.Queue").
  to(ExchangePattern.InOut,"freemarker:com/acme/MyResponse.ftl").
  to("activemq:Another.Queue");

from("activemq:My.Queue").
  to(ExchangePattern.InOut,"freemarker:com/acme/MyResponse.ftl").
  to("activemq:Another.Queue");

Copy to Clipboard

Toggle word wrap

And to disable the content cache (for example, for development usage where the .ftl template should be hot reloaded):

from("activemq:My.Queue").
  to(ExchangePattern.InOut,"freemarker:com/acme/MyResponse.ftl?contentCache=false").
  to("activemq:Another.Queue");

from("activemq:My.Queue").
  to(ExchangePattern.InOut,"freemarker:com/acme/MyResponse.ftl?contentCache=false").
  to("activemq:Another.Queue");

Copy to Clipboard

Toggle word wrap

And for a file-based resource:

from("activemq:My.Queue").
  to(ExchangePattern.InOut,"freemarker:file://myfolder/MyResponse.ftl?contentCache=false").
  to("activemq:Another.Queue");

from("activemq:My.Queue").
  to(ExchangePattern.InOut,"freemarker:file://myfolder/MyResponse.ftl?contentCache=false").
  to("activemq:Another.Queue");

Copy to Clipboard

Toggle word wrap

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

from("direct:in").
  setHeader(FreemarkerConstants.FREEMARKER_RESOURCE_URI).constant("path/to/my/template.ftl").
  to("freemarker:dummy");

from("direct:in").
  setHeader(FreemarkerConstants.FREEMARKER_RESOURCE_URI).constant("path/to/my/template.ftl").
  to("freemarker:dummy");

Copy to Clipboard

Toggle word wrap

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:

Dear ${headers.lastName}, ${headers.firstName}

Thanks for the order of ${headers.item}.

Regards Camel Riders Bookstore
${body}

Dear ${headers.lastName}, ${headers.firstName}

Thanks for the order of ${headers.item}.

Regards Camel Riders Bookstore
${body}

Copy to Clipboard

Toggle word wrap

And the java code:

private Exchange createLetter() {
    Exchange exchange = context.getEndpoint("direct:a").createExchange();
    Message msg = exchange.getIn();
    msg.setHeader("firstName", "Claus");
    msg.setHeader("lastName", "Ibsen");
    msg.setHeader("item", "Camel in Action");
    msg.setBody("PS: Next beer is on me, James");
    return exchange;
}

@Test
public void testFreemarkerLetter() throws Exception {
    MockEndpoint mock = getMockEndpoint("mock:result");
    mock.expectedMessageCount(1);
    mock.expectedBodiesReceived("Dear Ibsen, Claus\n\nThanks for the order of Camel in Action."
      + "\n\nRegards Camel Riders Bookstore\nPS: Next beer is on me, James");

    template.send("direct:a", createLetter());

    mock.assertIsSatisfied();
}

protected RouteBuilder createRouteBuilder() throws Exception {
    return new RouteBuilder() {
        public void configure() throws Exception {
            from("direct:a")
                .to("freemarker:org/apache/camel/component/freemarker/letter.ftl")
                .to("mock:result");
        }
    };
}

private Exchange createLetter() {
    Exchange exchange = context.getEndpoint("direct:a").createExchange();
    Message msg = exchange.getIn();
    msg.setHeader("firstName", "Claus");
    msg.setHeader("lastName", "Ibsen");
    msg.setHeader("item", "Camel in Action");
    msg.setBody("PS: Next beer is on me, James");
    return exchange;
}

@Test
public void testFreemarkerLetter() throws Exception {
    MockEndpoint mock = getMockEndpoint("mock:result");
    mock.expectedMessageCount(1);
    mock.expectedBodiesReceived("Dear Ibsen, Claus\n\nThanks for the order of Camel in Action."
      + "\n\nRegards Camel Riders Bookstore\nPS: Next beer is on me, James");

    template.send("direct:a", createLetter());

    mock.assertIsSatisfied();
}

protected RouteBuilder createRouteBuilder() throws Exception {
    return new RouteBuilder() {
        public void configure() throws Exception {
            from("direct:a")
                .to("freemarker:org/apache/camel/component/freemarker/letter.ftl")
                .to("mock:result");
        }
    };
}

Copy to Clipboard

Toggle word wrap

此内容没有您所选择的语言版本。

FreeMarker
复制链接

URI format
复制链接

Options
复制链接

FreeMarker Context
复制链接

Hot reloading
复制链接

Dynamic templates
复制链接

Samples
复制链接

The Email Sample
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

此内容没有您所选择的语言版本。

Chapter 39. FreeMarker

FreeMarker复制链接链接已复制到粘贴板!

URI format复制链接链接已复制到粘贴板!

Options复制链接链接已复制到粘贴板!

FreeMarker Context复制链接链接已复制到粘贴板!

Hot reloading复制链接链接已复制到粘贴板!

Dynamic templates复制链接链接已复制到粘贴板!

Samples复制链接链接已复制到粘贴板!

The Email Sample复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

FreeMarker
复制链接

URI format
复制链接

Options
复制链接

FreeMarker Context
复制链接

Hot reloading
复制链接

Dynamic templates
复制链接

Samples
复制链接

The Email Sample
复制链接