This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit 73139018d0ea84b4c186f7961d57db3fe3ce4b0d Author: Nicolas Filotto <[email protected]> AuthorDate: Wed Mar 30 18:08:48 2022 +0200 CAMEL-17792: Add doc about the message headers of camel-jslt --- .../src/generated/resources/org/apache/camel/component/jslt/jslt.json | 4 ++++ components/camel-jslt/src/main/docs/jslt-component.adoc | 4 +++- .../src/main/java/org/apache/camel/component/jslt/JsltConstants.java | 4 ++++ .../src/main/java/org/apache/camel/component/jslt/JsltEndpoint.java | 2 +- 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/components/camel-jslt/src/generated/resources/org/apache/camel/component/jslt/jslt.json b/components/camel-jslt/src/generated/resources/org/apache/camel/component/jslt/jslt.json index 79dd14c..8c3feb8 100644 --- a/components/camel-jslt/src/generated/resources/org/apache/camel/component/jslt/jslt.json +++ b/components/camel-jslt/src/generated/resources/org/apache/camel/component/jslt/jslt.json @@ -28,6 +28,10 @@ "functions": { "kind": "property", "displayName": "Functions", "group": "advanced", "label": "advanced", "required": false, "type": "array", "javaType": "java.util.Collection<com.schibsted.spt.data.jslt.Function>", "deprecated": false, "autowired": false, "secret": false, "description": "JSLT can be extended by plugging in functions written in Java." }, "objectFilter": { "kind": "property", "displayName": "Object Filter", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "com.schibsted.spt.data.jslt.filters.JsonFilter", "deprecated": false, "autowired": false, "secret": false, "description": "JSLT can be extended by plugging in a custom jslt object filter" } }, + "headers": { + "CamelJsltString": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The JSLT Template as String" }, + "CamelJsltResourceUri": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The resource URI" } + }, "properties": { "resourceUri": { "kind": "path", "displayName": "Resource Uri", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "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 [...] "allowContextMapAll": { "kind": "parameter", "displayName": "Allow Context Map All", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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. [...] diff --git a/components/camel-jslt/src/main/docs/jslt-component.adoc b/components/camel-jslt/src/main/docs/jslt-component.adoc index 62f14a4..e5b1836 100644 --- a/components/camel-jslt/src/main/docs/jslt-component.adoc +++ b/components/camel-jslt/src/main/docs/jslt-component.adoc @@ -54,7 +54,9 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: START // endpoint options: END - +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END == Passing values to JSLT diff --git a/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltConstants.java b/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltConstants.java index 2cb1c78..9d11f18 100644 --- a/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltConstants.java +++ b/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltConstants.java @@ -16,9 +16,13 @@ */ package org.apache.camel.component.jslt; +import org.apache.camel.spi.Metadata; + public final class JsltConstants { + @Metadata(description = "The JSLT Template as String", javaType = "String") public static final String HEADER_JSLT_STRING = "CamelJsltString"; + @Metadata(description = "The resource URI", javaType = "String") public static final String HEADER_JSLT_RESOURCE_URI = "CamelJsltResourceUri"; private JsltConstants() { diff --git a/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltEndpoint.java b/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltEndpoint.java index 1c16e01..2031fcb 100644 --- a/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltEndpoint.java +++ b/components/camel-jslt/src/main/java/org/apache/camel/component/jslt/JsltEndpoint.java @@ -51,7 +51,7 @@ import org.apache.camel.util.ObjectHelper; * Query or transform JSON payloads using an JSLT. */ @UriEndpoint(firstVersion = "3.1.0", scheme = "jslt", title = "JSLT", syntax = "jslt:resourceUri", producerOnly = true, - category = { Category.TRANSFORMATION }) + category = { Category.TRANSFORMATION }, headersClass = JsltConstants.class) public class JsltEndpoint extends ResourceEndpoint { private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
