This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 3e6f70611e3495130ce1cabba7870dc685e8df1e
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Tue May 12 08:00:35 2020 +0200
CAMEL-15050: Templating components - Variable map to be limited to
body/headers
---
components/camel-chunk/README.md | 101 ---------------------
.../component/chunk/ChunkComponentConfigurer.java | 5 +
.../component/chunk/ChunkEndpointConfigurer.java | 5 +
.../org/apache/camel/component/chunk/chunk.json | 2 +
.../camel-chunk/src/main/docs/chunk-component.adoc | 6 +-
.../camel/component/chunk/ChunkComponent.java | 17 ++++
.../camel/component/chunk/ChunkEndpoint.java | 2 +-
.../dsl/ChunkComponentBuilderFactory.java | 18 ++++
.../endpoint/dsl/ChunkEndpointBuilderFactory.java | 68 +++++++-------
9 files changed, 86 insertions(+), 138 deletions(-)
diff --git a/components/camel-chunk/README.md b/components/camel-chunk/README.md
deleted file mode 100644
index 340a8a8..0000000
--- a/components/camel-chunk/README.md
+++ /dev/null
@@ -1,101 +0,0 @@
-# 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:
-
-```xml
-
-<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.
-
-| Option | Default | Description
|
-|---------------------|---------|------------------------------------------------------------------------------------------------------------------------|
-| encoding | null | Character encoding of the resource content.
|
-| themesFolder | null | Alternative folder to scan for a template
name. |
-| themeSubfolder | null | Alternative subfolder to scan for a template
name if themeFolder parameter is set. |
-| themeLayer | null | A specific layer of a template file to use
as template. |
-| extension | null | Alternative 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.
-
-| Header | Type | Description
| Support Version |
-|----------------------------------------------|-----------|----------------------------------------------------------------------------|-----------------|
-| ChunkConstants.CHUNK_RESOURCE_URI | String | A URI for the
template resource to use instead of the endpoint configured. | |
-| ChunkConstants.CHUNK_TEMPLATE | String | The template to
use instead of the endpoint configured. | |
-
-# Examples
-
-**Example 1**
-
-```java
- 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**
-
-```java
- 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**
-
-```java
- 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**
-
-```java
- 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**
-
-```java
- 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.
diff --git
a/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkComponentConfigurer.java
b/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkComponentConfigurer.java
index 7e76053..4ba5caa 100644
---
a/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkComponentConfigurer.java
+++
b/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkComponentConfigurer.java
@@ -19,6 +19,8 @@ public class ChunkComponentConfigurer extends
PropertyConfigurerSupport implemen
public boolean configure(CamelContext camelContext, Object obj, String
name, Object value, boolean ignoreCase) {
ChunkComponent target = (ChunkComponent) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "allowcontextmapall":
+ case "allowContextMapAll":
target.setAllowContextMapAll(property(camelContext, boolean.class, value));
return true;
case "allowtemplatefromheader":
case "allowTemplateFromHeader":
target.setAllowTemplateFromHeader(property(camelContext, boolean.class,
value)); return true;
case "basicpropertybinding":
@@ -32,6 +34,7 @@ public class ChunkComponentConfigurer extends
PropertyConfigurerSupport implemen
@Override
public Map<String, Object> getAllOptions(Object target) {
Map<String, Object> answer = new CaseInsensitiveMap();
+ answer.put("allowContextMapAll", boolean.class);
answer.put("allowTemplateFromHeader", boolean.class);
answer.put("basicPropertyBinding", boolean.class);
answer.put("lazyStartProducer", boolean.class);
@@ -42,6 +45,8 @@ public class ChunkComponentConfigurer extends
PropertyConfigurerSupport implemen
public Object getOptionValue(Object obj, String name, boolean ignoreCase) {
ChunkComponent target = (ChunkComponent) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "allowcontextmapall":
+ case "allowContextMapAll": return target.isAllowContextMapAll();
case "allowtemplatefromheader":
case "allowTemplateFromHeader": return
target.isAllowTemplateFromHeader();
case "basicpropertybinding":
diff --git
a/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkEndpointConfigurer.java
b/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkEndpointConfigurer.java
index b8bbe84..12e438a 100644
---
a/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkEndpointConfigurer.java
+++
b/components/camel-chunk/src/generated/java/org/apache/camel/component/chunk/ChunkEndpointConfigurer.java
@@ -19,6 +19,8 @@ public class ChunkEndpointConfigurer extends
PropertyConfigurerSupport implement
public boolean configure(CamelContext camelContext, Object obj, String
name, Object value, boolean ignoreCase) {
ChunkEndpoint target = (ChunkEndpoint) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "allowcontextmapall":
+ case "allowContextMapAll":
target.setAllowContextMapAll(property(camelContext, boolean.class, value));
return true;
case "allowtemplatefromheader":
case "allowTemplateFromHeader":
target.setAllowTemplateFromHeader(property(camelContext, boolean.class,
value)); return true;
case "basicpropertybinding":
@@ -43,6 +45,7 @@ public class ChunkEndpointConfigurer extends
PropertyConfigurerSupport implement
@Override
public Map<String, Object> getAllOptions(Object target) {
Map<String, Object> answer = new CaseInsensitiveMap();
+ answer.put("allowContextMapAll", boolean.class);
answer.put("allowTemplateFromHeader", boolean.class);
answer.put("basicPropertyBinding", boolean.class);
answer.put("contentCache", boolean.class);
@@ -60,6 +63,8 @@ public class ChunkEndpointConfigurer extends
PropertyConfigurerSupport implement
public Object getOptionValue(Object obj, String name, boolean ignoreCase) {
ChunkEndpoint target = (ChunkEndpoint) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "allowcontextmapall":
+ case "allowContextMapAll": return target.isAllowContextMapAll();
case "allowtemplatefromheader":
case "allowTemplateFromHeader": return
target.isAllowTemplateFromHeader();
case "basicpropertybinding":
diff --git
a/components/camel-chunk/src/generated/resources/org/apache/camel/component/chunk/chunk.json
b/components/camel-chunk/src/generated/resources/org/apache/camel/component/chunk/chunk.json
index aecf06b..919bf66 100644
---
a/components/camel-chunk/src/generated/resources/org/apache/camel/component/chunk/chunk.json
+++
b/components/camel-chunk/src/generated/resources/org/apache/camel/component/chunk/chunk.json
@@ -21,12 +21,14 @@
"lenientProperties": false
},
"componentProperties": {
+ "allowContextMapAll": { "kind": "property", "displayName": "Allow Context
Map All", "group": "producer", "label": "", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": 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. Doing so impose a [...]
"allowTemplateFromHeader": { "kind": "property", "displayName": "Allow
Template From Header", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "false", "description": "Whether to allow to use resource
template from header or not (default false). Enabling this allows to specify
dynamic templates via message header. However this can be seen as a potential
security vulnerability if the he [...]
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a producer may otherwise
fail during starting and cause the r [...]
"basicPropertyBinding": { "kind": "property", "displayName": "Basic
Property Binding", "group": "advanced", "label": "advanced", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities" }
},
"properties": {
"resourceUri": { "kind": "path", "displayName": "Resource Uri", "group":
"producer", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "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 call a method on a [...]
+ "allowContextMapAll": { "kind": "parameter", "displayName": "Allow Context
Map All", "group": "producer", "label": "", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": 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. Doing so impose a [...]
"allowTemplateFromHeader": { "kind": "parameter", "displayName": "Allow
Template From Header", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "false", "description": "Whether to allow to use resource
template from header or not (default false). Enabling this allows to specify
dynamic templates via message header. However this can be seen as a potential
security vulnerability if the h [...]
"contentCache": { "kind": "parameter", "displayName": "Content Cache",
"group": "producer", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"false", "description": "Sets whether to use resource content cache or not" },
"encoding": { "kind": "parameter", "displayName": "Encoding", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description":
"Define the encoding of the body" },
diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc
b/components/camel-chunk/src/main/docs/chunk-component.adoc
index 2ed8c16..f509302 100644
--- a/components/camel-chunk/src/main/docs/chunk-component.adoc
+++ b/components/camel-chunk/src/main/docs/chunk-component.adoc
@@ -45,13 +45,14 @@ format, `?option=value&option=value&...`
// component options: START
-The Chunk component supports 3 options, which are listed below.
+The Chunk component supports 4 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| 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 impose 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 allows to specify
dynamic templates via message header. However this can be seen as a potential
security vulnerability if the header is coming from a malicious user, so use
this with care. | false | boolean
| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
| *basicPropertyBinding* (advanced) | Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
@@ -79,12 +80,13 @@ with the following path and query parameters:
|===
-=== Query Parameters (10 parameters):
+=== Query Parameters (11 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
|===
| 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 impose 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 allows to specify
dynamic templates via message header. However this can be seen as a potential
security vulnerability if the header is coming from a malicious user, so use
this with care. | false | boolean
| *contentCache* (producer) | Sets whether to use resource content cache or
not | false | boolean
| *encoding* (producer) | Define the encoding of the body | | String
diff --git
a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkComponent.java
b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkComponent.java
index d700f1a..0f85b72 100644
---
a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkComponent.java
+++
b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkComponent.java
@@ -28,6 +28,8 @@ public class ChunkComponent extends DefaultComponent {
@Metadata(defaultValue = "false")
private boolean allowTemplateFromHeader;
+ @Metadata(defaultValue = "false")
+ private boolean allowContextMapAll;
public ChunkComponent() {
}
@@ -36,6 +38,7 @@ public class ChunkComponent extends DefaultComponent {
protected Endpoint createEndpoint(String uri, String remaining,
Map<String, Object> parameters) throws Exception {
ChunkEndpoint endpoint = new ChunkEndpoint(uri, this, remaining);
endpoint.setAllowTemplateFromHeader(allowTemplateFromHeader);
+ endpoint.setAllowContextMapAll(allowContextMapAll);
setProperties(endpoint, parameters);
return endpoint;
}
@@ -54,4 +57,18 @@ public class ChunkComponent extends DefaultComponent {
this.allowTemplateFromHeader = allowTemplateFromHeader;
}
+ public boolean isAllowContextMapAll() {
+ return allowContextMapAll;
+ }
+
+ /**
+ * 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 impose a potential security risk as this opens access to the
full power of CamelContext API.
+ */
+ public void setAllowContextMapAll(boolean allowContextMapAll) {
+ this.allowContextMapAll = allowContextMapAll;
+ }
+
}
diff --git
a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
index 4066ce5..a0e7dfb 100644
---
a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
+++
b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java
@@ -114,7 +114,7 @@ public class ChunkEndpoint extends ResourceEndpoint {
}
// Execute Chunk
- Map<String, Object> variableMap =
ExchangeHelper.createVariableMap(exchange);
+ Map<String, Object> variableMap =
ExchangeHelper.createVariableMap(exchange, isAllowContextMapAll());
StringWriter writer = new StringWriter();
newChunk.putAll(variableMap);
newChunk.render(writer);
diff --git
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/ChunkComponentBuilderFactory.java
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/ChunkComponentBuilderFactory.java
index a319cb6..dfeb261 100644
---
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/ChunkComponentBuilderFactory.java
+++
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/ChunkComponentBuilderFactory.java
@@ -47,6 +47,23 @@ public interface ChunkComponentBuilderFactory {
*/
interface ChunkComponentBuilder extends ComponentBuilder<ChunkComponent> {
/**
+ * 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 impose a potential security risk as this
opens
+ * access to the full power of CamelContext API.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ */
+ default ChunkComponentBuilder allowContextMapAll(
+ boolean allowContextMapAll) {
+ doSetProperty("allowContextMapAll", allowContextMapAll);
+ return this;
+ }
+ /**
* Whether to allow to use resource template from header or not
(default
* false). Enabling this allows to specify dynamic templates via
message
* header. However this can be seen as a potential security
@@ -115,6 +132,7 @@ public interface ChunkComponentBuilderFactory {
String name,
Object value) {
switch (name) {
+ case "allowContextMapAll": ((ChunkComponent)
component).setAllowContextMapAll((boolean) value); return true;
case "allowTemplateFromHeader": ((ChunkComponent)
component).setAllowTemplateFromHeader((boolean) value); return true;
case "lazyStartProducer": ((ChunkComponent)
component).setLazyStartProducer((boolean) value); return true;
case "basicPropertyBinding": ((ChunkComponent)
component).setBasicPropertyBinding((boolean) value); return true;
diff --git
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ChunkEndpointBuilderFactory.java
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ChunkEndpointBuilderFactory.java
index bace03e..f591861 100644
---
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ChunkEndpointBuilderFactory.java
+++
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ChunkEndpointBuilderFactory.java
@@ -38,6 +38,40 @@ public interface ChunkEndpointBuilderFactory {
return (AdvancedChunkEndpointBuilder) this;
}
/**
+ * 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 impose a potential security risk as this
opens
+ * access to the full power of CamelContext API.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ */
+ default ChunkEndpointBuilder allowContextMapAll(
+ boolean allowContextMapAll) {
+ doSetProperty("allowContextMapAll", allowContextMapAll);
+ return this;
+ }
+ /**
+ * 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 impose a potential security risk as this
opens
+ * access to the full power of CamelContext API.
+ *
+ * The option will be converted to a <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ */
+ default ChunkEndpointBuilder allowContextMapAll(
+ String allowContextMapAll) {
+ doSetProperty("allowContextMapAll", allowContextMapAll);
+ return this;
+ }
+ /**
* Whether to allow to use resource template from header or not
(default
* false). Enabling this allows to specify dynamic templates via
message
* header. However this can be seen as a potential security
@@ -96,40 +130,6 @@ public interface ChunkEndpointBuilderFactory {
return this;
}
/**
- * Whether the context map is limited to only include the message body
- * and headers (default). However access to the current Exchange and
- * CamelContext can be enabled by turning this option off. Doing so
- * impose a potential security risk as this opens access to the full
- * power of CamelContext API.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: true
- * Group: producer
- */
- default ChunkEndpointBuilder contextMapBodyAndHeadersOnly(
- boolean contextMapBodyAndHeadersOnly) {
- doSetProperty("contextMapBodyAndHeadersOnly",
contextMapBodyAndHeadersOnly);
- return this;
- }
- /**
- * Whether the context map is limited to only include the message body
- * and headers (default). However access to the current Exchange and
- * CamelContext can be enabled by turning this option off. Doing so
- * impose a potential security risk as this opens access to the full
- * power of CamelContext API.
- *
- * The option will be converted to a <code>boolean</code> type.
- *
- * Default: true
- * Group: producer
- */
- default ChunkEndpointBuilder contextMapBodyAndHeadersOnly(
- String contextMapBodyAndHeadersOnly) {
- doSetProperty("contextMapBodyAndHeadersOnly",
contextMapBodyAndHeadersOnly);
- return this;
- }
- /**
* Define the encoding of the body.
*
* The option is a: <code>java.lang.String</code> type.
