tree: 7cd3cbbb31ae0c16e92a653e3bbc227948d96886 [path history] [tgz]
  1. README.md
  2. pom.xml
  3. src/
components/camel-chunk/README.md

Chunk Component

Introduction

This component use the Java Chunk library: http://www.x5software.com/chunk/examples/ChunkExample?loc=en_US

Chunk is a Template Engine for Java similar to Apache Velocity, Mustache Java and Freemarker

The chunk: component allows for processing a message using a Chunk template. This can be useful when using Templating to build 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-chunk</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency>

URI format


chunk:templateName[?options]

Options

By default the chunk library will scan a default folder “themes” for a specific template, however is possible to define a differente folder to scan using the specific option. Default extension of template file are .chtml and .cxml, however is possible to define different extension using the specific option.

OptionDefaultDescription
encodingnullCharacter encoding of the resource content.
themesFoldernullAlternative folder to scan for a template name.
themeSubfoldernullAlternative subfolder to scan for a template name if themeFolder parameter is set.
themeLayernullA specific layer of a template file to use as template.
extensionnullAlternative extension to scan for a template name if themeFolder and themeSubfolder are set

Dynamic Templates

Camel-chunk component 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-chunk component uses this over the endpoint configured resource. This allows you to provide a dynamic template at runtime.

HeaderTypeDescriptionSupport Version
ChunkConstants.CHUNK_RESOURCE_URIStringA URI for the template resource to use instead of the endpoint configured.
ChunkConstants.CHUNK_TEMPLATEStringThe template to use instead of the endpoint configured.

Examples

Example 1

	from("direct:in")
            .to("chunk://file")
            .to("direct:out");

In this example the chunk component will look for file.chtml template in themes folder and it will use it as template.

Example 2

	from("direct:in")
            .to("chunk:example?themeLayer=example_1")

In this example the chunk component will look for example.chtml in themes folder and will use the #example_1 layer

Example 3

	from("direct:in")
            .to("chunk://hello")
            .to("chunk://subfolder/theme1")

In this example the chunk component will look for hello.chtml template in themes folder and for theme1.chtml in themes/subfolder/

Example 4

	from("direct:in")
            .to("chunk:subfile_example?themeFolder=folderexample&themeSubfolder=subfolderexample")

In this example the chunk component will look for subfile_example.chtml in folderexample/subfolderexample/ folder and not in the default themes folder.

Example 5

	from("direct:in")
             .to("chunk:subfile_example?themeFolder=folderexample&themeSubfolder=subfolderexample&extension=file")

In this example the chunk component will look for subfile_example.file (not .chtml or .cxml) in folderexample/subfolderexample/ folder and not in the default themes folder.