Chapter 180. JOLT Component
Available as of Camel version 2.16
The jolt: component allows you to process a JSON messages using an JOLT specification. This can be ideal when doing JSON to JSON transformation.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-jolt</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
180.1. URI format
jolt:specName[?options]
Where specName is the classpath-local URI of the specification to invoke; or the complete URL of the remote specification (eg: file://folder/myfile.json).
You can append query options to the URI in the following format, ?option=value&option=value&…
180.2. Options
The JOLT component supports 4 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| allowContextMapAll (producer) | Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so imposes a potential security risk as this opens access to the full power of CamelContext API. | false | boolean |
| allowTemplateFromHeader (producer) | Whether to allow to use resource template from header or not (default false). Enabling this option has security ramifications. For example, if the header contains untrusted or user derived content, this can ultimately impact on the confidentility and integrity of your end application, so use this option with caution. | false | boolean |
| transform (advanced) | Explicitly sets the Transform to use. If not set a Transform specified by the transformDsl will be created | Transform | |
| resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The JOLT endpoint is configured using URI syntax:
jolt:resourceUri
with the following path and query parameters:
180.2.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| resourceUri | Required Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod. | String |
180.2.2. Query Parameters (7 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| allowContextMapAll (producer) | Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so imposes a potential security risk as this opens access to the full power of CamelContext API. | false | boolean |
| allowTemplateFromHeader (producer) | Whether to allow to use resource template from header or not (default false). Enabling this option has security ramifications. For example, if the header contains untrusted or user derived content, this can ultimately impact on the confidentility and integrity of your end application, so use this option with caution. | false | boolean |
| contentCache (producer) | Sets whether to use resource content cache or not | false | boolean |
| inputType (producer) | Specifies if the input is hydrated JSON or a JSON String. | Hydrated | JoltInputOutputType |
| outputType (producer) | Specifies if the output should be hydrated JSON or a JSON String. | Hydrated | JoltInputOutputType |
| transformDsl (producer) | Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used. | Chainr | JoltTransformType |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
180.3. Spring Boot Auto-Configuration
The component supports 3 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.jolt.enabled | Enable jolt component | true | Boolean |
| camel.component.jolt.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
| camel.component.jolt.transform | Explicitly sets the Transform to use. If not set a Transform specified by the transformDsl will be created. The option is a com.bazaarvoice.jolt.Transform type. | String |
180.4. Samples
For example you could use something like
from("activemq:My.Queue").
to("jolt:com/acme/MyResponse.json");And a file based resource:
from("activemq:My.Queue").
to("jolt:file://myfolder/MyResponse.json?contentCache=true").
to("activemq:Another.Queue");You can also specify what specification the component should use dynamically via a header, so for example:
from("direct:in").
setHeader("CamelJoltResourceUri").constant("path/to/my/spec.json").
to("jolt:dummy?allowTemplateFromHeader=true");
Enabling the allowTemplateFromHeader option has security ramifications. For example, if the header contains untrusted or user derived content, this can ultimately impact on the confidentility and integrity of your end application, so use this option with caution.
180.5. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
