This is an automated email from the ASF dual-hosted git repository.
Croway pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new e20bdc2a6a3f CAMEL-23507: camel-cometd: Integrate HeaderFilterStrategy
for inbound header mapping
e20bdc2a6a3f is described below
commit e20bdc2a6a3fd1128bcebe1b64c8e8589f0bc57d
Author: Croway <[email protected]>
AuthorDate: Thu May 14 11:14:51 2026 +0200
CAMEL-23507: camel-cometd: Integrate HeaderFilterStrategy for inbound
header mapping
---
.../apache/camel/catalog/components/cometd.json | 3 +-
.../apache/camel/catalog/components/cometds.json | 3 +-
.../component/cometd/CometdEndpointConfigurer.java | 6 ++
.../component/cometd/CometdEndpointUriFactory.java | 3 +-
.../org/apache/camel/component/cometd/cometd.json | 3 +-
.../org/apache/camel/component/cometd/cometds.json | 3 +-
.../camel/component/cometd/CometdBinding.java | 40 ++++++----
.../camel/component/cometd/CometdConsumer.java | 3 +
.../camel/component/cometd/CometdEndpoint.java | 11 +++
.../cometd/CometdHeaderFilterStrategy.java | 28 +++++++
.../camel/component/cometd/CometdProducer.java | 8 +-
.../camel/component/cometd/CometBindingTest.java | 32 ++++++++
.../endpoint/dsl/CometdEndpointBuilderFactory.java | 90 ++++++++++++++++++++++
13 files changed, 214 insertions(+), 19 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometd.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometd.json
index bb3b43efd04d..8307b159158e 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometd.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometd.json
@@ -59,6 +59,7 @@
"exceptionHandler": { "index": 15, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 16, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"disconnectLocalSession": { "index": 17, "kind": "parameter",
"displayName": "Disconnect Local Session", "group": "producer", "label":
"producer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "Whether to disconnect local sessions after publishing a
message to its channel. Disconnecting local session is needed as they are not
swept by default by CometD, and therefore you can [...]
- "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "headerFilterStrategy": { "index": 19, "kind": "parameter", "displayName":
"Header Filter Strategy", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter headers." }
}
}
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometds.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometds.json
index 825498f78077..2296c9c28d46 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometds.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/cometds.json
@@ -59,6 +59,7 @@
"exceptionHandler": { "index": 15, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 16, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"disconnectLocalSession": { "index": 17, "kind": "parameter",
"displayName": "Disconnect Local Session", "group": "producer", "label":
"producer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "Whether to disconnect local sessions after publishing a
message to its channel. Disconnecting local session is needed as they are not
swept by default by CometD, and therefore you can [...]
- "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "headerFilterStrategy": { "index": 19, "kind": "parameter", "displayName":
"Header Filter Strategy", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter headers." }
}
}
diff --git
a/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointConfigurer.java
b/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointConfigurer.java
index 93a57c276d72..fe410ffa6fc0 100644
---
a/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointConfigurer.java
+++
b/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointConfigurer.java
@@ -39,6 +39,8 @@ public class CometdEndpointConfigurer extends
PropertyConfigurerSupport implemen
case "exchangePattern":
target.setExchangePattern(property(camelContext,
org.apache.camel.ExchangePattern.class, value)); return true;
case "filterpath":
case "filterPath": target.setFilterPath(property(camelContext,
java.lang.String.class, value)); return true;
+ case "headerfilterstrategy":
+ case "headerFilterStrategy":
target.setHeaderFilterStrategy(property(camelContext,
org.apache.camel.spi.HeaderFilterStrategy.class, value)); return true;
case "interval": target.setInterval(property(camelContext, int.class,
value)); return true;
case "jsoncommented":
case "jsonCommented": target.setJsonCommented(property(camelContext,
boolean.class, value)); return true;
@@ -76,6 +78,8 @@ public class CometdEndpointConfigurer extends
PropertyConfigurerSupport implemen
case "exchangePattern": return org.apache.camel.ExchangePattern.class;
case "filterpath":
case "filterPath": return java.lang.String.class;
+ case "headerfilterstrategy":
+ case "headerFilterStrategy": return
org.apache.camel.spi.HeaderFilterStrategy.class;
case "interval": return int.class;
case "jsoncommented":
case "jsonCommented": return boolean.class;
@@ -114,6 +118,8 @@ public class CometdEndpointConfigurer extends
PropertyConfigurerSupport implemen
case "exchangePattern": return target.getExchangePattern();
case "filterpath":
case "filterPath": return target.getFilterPath();
+ case "headerfilterstrategy":
+ case "headerFilterStrategy": return target.getHeaderFilterStrategy();
case "interval": return target.getInterval();
case "jsoncommented":
case "jsonCommented": return target.isJsonCommented();
diff --git
a/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointUriFactory.java
b/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointUriFactory.java
index 2ef90cfcc9d7..55e3875316ed 100644
---
a/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointUriFactory.java
+++
b/components/camel-cometd/src/generated/java/org/apache/camel/component/cometd/CometdEndpointUriFactory.java
@@ -24,7 +24,7 @@ public class CometdEndpointUriFactory extends
org.apache.camel.support.component
private static final Set<String> SECRET_PROPERTY_NAMES;
private static final Map<String, String> MULTI_VALUE_PREFIXES;
static {
- Set<String> props = new HashSet<>(19);
+ Set<String> props = new HashSet<>(20);
props.add("allowedOrigins");
props.add("baseResource");
props.add("bridgeErrorHandler");
@@ -34,6 +34,7 @@ public class CometdEndpointUriFactory extends
org.apache.camel.support.component
props.add("exceptionHandler");
props.add("exchangePattern");
props.add("filterPath");
+ props.add("headerFilterStrategy");
props.add("host");
props.add("interval");
props.add("jsonCommented");
diff --git
a/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometd.json
b/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometd.json
index bb3b43efd04d..8307b159158e 100644
---
a/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometd.json
+++
b/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometd.json
@@ -59,6 +59,7 @@
"exceptionHandler": { "index": 15, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 16, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"disconnectLocalSession": { "index": 17, "kind": "parameter",
"displayName": "Disconnect Local Session", "group": "producer", "label":
"producer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "Whether to disconnect local sessions after publishing a
message to its channel. Disconnecting local session is needed as they are not
swept by default by CometD, and therefore you can [...]
- "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "headerFilterStrategy": { "index": 19, "kind": "parameter", "displayName":
"Header Filter Strategy", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter headers." }
}
}
diff --git
a/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometds.json
b/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometds.json
index 825498f78077..2296c9c28d46 100644
---
a/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometds.json
+++
b/components/camel-cometd/src/generated/resources/META-INF/org/apache/camel/component/cometd/cometds.json
@@ -59,6 +59,7 @@
"exceptionHandler": { "index": 15, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 16, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"disconnectLocalSession": { "index": 17, "kind": "parameter",
"displayName": "Disconnect Local Session", "group": "producer", "label":
"producer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "Whether to disconnect local sessions after publishing a
message to its channel. Disconnecting local session is needed as they are not
swept by default by CometD, and therefore you can [...]
- "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "lazyStartProducer": { "index": 18, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": 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 produ [...]
+ "headerFilterStrategy": { "index": 19, "kind": "parameter", "displayName":
"Header Filter Strategy", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter headers." }
}
}
diff --git
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
index 3afacbcc499f..7e104a212d1c 100644
---
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
+++
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdBinding.java
@@ -24,6 +24,7 @@ import java.util.Set;
import org.apache.camel.CamelContext;
import org.apache.camel.Exchange;
import org.apache.camel.Message;
+import org.apache.camel.spi.HeaderFilterStrategy;
import org.apache.camel.spi.Metadata;
import org.apache.camel.support.DefaultMessage;
import org.cometd.bayeux.server.ServerChannel;
@@ -48,6 +49,7 @@ public class CometdBinding {
private static final Logger LOG =
LoggerFactory.getLogger(CometdBinding.class);
private final BayeuxServerImpl bayeux;
+ private final HeaderFilterStrategy headerFilterStrategy;
private boolean enableSessionHeader;
public CometdBinding(BayeuxServerImpl bayeux) {
@@ -55,8 +57,13 @@ public class CometdBinding {
}
public CometdBinding(BayeuxServerImpl bayeux, boolean enableSessionHeader)
{
+ this(bayeux, enableSessionHeader, new CometdHeaderFilterStrategy());
+ }
+
+ public CometdBinding(BayeuxServerImpl bayeux, boolean enableSessionHeader,
HeaderFilterStrategy headerFilterStrategy) {
this.bayeux = bayeux;
this.enableSessionHeader = enableSessionHeader;
+ this.headerFilterStrategy = headerFilterStrategy;
}
public ServerMessage.Mutable createCometdMessage(ServerChannel channel,
ServerSession serverSession, Message camelMessage) {
@@ -81,7 +88,14 @@ public class CometdBinding {
message.setBody(data);
Map<String, Object> headers = getHeadersFromMessage(cometdMessage);
if (headers != null) {
- message.setHeaders(headers);
+ for (Entry<String, Object> entry : headers.entrySet()) {
+ String name = entry.getKey();
+ Object value = entry.getValue();
+ if (headerFilterStrategy == null
+ ||
!headerFilterStrategy.applyFilterToExternalHeaders(name, value, null)) {
+ message.setHeader(name, value);
+ }
+ }
}
message.setHeader(COMETD_CLIENT_ID_HEADER_NAME, remote.getId());
@@ -116,20 +130,20 @@ public class CometdBinding {
public void addHeadersToMessage(ServerMessage.Mutable cometdMessage,
Message camelMessage) {
if (camelMessage.hasHeaders()) {
- Map<String, Object> ext = cometdMessage.getExt(true);
- ext.put(HEADERS_FIELD, filterHeaders(camelMessage.getHeaders()));
- }
- }
-
- //TODO: do something in the style of JMS where they have header Strategies?
- private Object filterHeaders(Map<String, Object> headers) {
- Map<String, Object> map = new HashMap<>();
- for (Entry<String, Object> entry : headers.entrySet()) {
- if (entry != null && entry.getKey() != null) {
- map.put(entry.getKey(), entry.getValue());
+ Map<String, Object> filtered = new HashMap<>();
+ for (Entry<String, Object> entry :
camelMessage.getHeaders().entrySet()) {
+ if (entry != null && entry.getKey() != null) {
+ if (headerFilterStrategy == null
+ ||
!headerFilterStrategy.applyFilterToCamelHeaders(entry.getKey(),
entry.getValue(), null)) {
+ filtered.put(entry.getKey(), entry.getValue());
+ }
+ }
+ }
+ if (!filtered.isEmpty()) {
+ Map<String, Object> ext = cometdMessage.getExt(true);
+ ext.put(HEADERS_FIELD, filtered);
}
}
- return map;
}
@SuppressWarnings("unchecked")
diff --git
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdConsumer.java
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdConsumer.java
index 5f557476005a..406324965ec2 100644
---
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdConsumer.java
+++
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdConsumer.java
@@ -91,6 +91,9 @@ public class CometdConsumer extends DefaultConsumer
implements CometdProducerCon
private CometdBinding createBinding(BayeuxServerImpl bayeux) {
boolean enableSessionHeaders = endpoint != null &&
endpoint.isSessionHeadersEnabled();
+ if (endpoint != null && endpoint.getHeaderFilterStrategy() !=
null) {
+ return new CometdBinding(bayeux, enableSessionHeaders,
endpoint.getHeaderFilterStrategy());
+ }
return new CometdBinding(bayeux, enableSessionHeaders);
}
diff --git
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
index a731b7c86a60..59c9d709cd63 100644
---
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
+++
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java
@@ -24,6 +24,7 @@ import org.apache.camel.Consumer;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.spi.EndpointServiceLocation;
+import org.apache.camel.spi.HeaderFilterStrategy;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
@@ -77,6 +78,8 @@ public class CometdEndpoint extends DefaultEndpoint
implements EndpointServiceLo
private String filterPath;
@UriParam(label = "producer")
private boolean disconnectLocalSession;
+ @UriParam(label = "advanced", description = "To use a custom
HeaderFilterStrategy to filter headers.")
+ private HeaderFilterStrategy headerFilterStrategy;
public CometdEndpoint(CometdComponent component, String uri, String
remaining) {
super(uri, component);
@@ -289,4 +292,12 @@ public class CometdEndpoint extends DefaultEndpoint
implements EndpointServiceLo
public void setDisconnectLocalSession(boolean disconnectLocalSession) {
this.disconnectLocalSession = disconnectLocalSession;
}
+
+ public HeaderFilterStrategy getHeaderFilterStrategy() {
+ return headerFilterStrategy;
+ }
+
+ public void setHeaderFilterStrategy(HeaderFilterStrategy
headerFilterStrategy) {
+ this.headerFilterStrategy = headerFilterStrategy;
+ }
}
diff --git
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdHeaderFilterStrategy.java
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdHeaderFilterStrategy.java
new file mode 100644
index 000000000000..3c6c6d89532b
--- /dev/null
+++
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdHeaderFilterStrategy.java
@@ -0,0 +1,28 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.component.cometd;
+
+import org.apache.camel.support.DefaultHeaderFilterStrategy;
+
+public class CometdHeaderFilterStrategy extends DefaultHeaderFilterStrategy {
+
+ public CometdHeaderFilterStrategy() {
+ setLowerCase(true);
+ setInFilterStartsWith(CAMEL_FILTER_STARTS_WITH);
+ setOutFilterStartsWith(CAMEL_FILTER_STARTS_WITH);
+ }
+}
diff --git
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdProducer.java
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdProducer.java
index 8bfe6bcd84e4..e347975d24ee 100644
---
a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdProducer.java
+++
b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdProducer.java
@@ -50,8 +50,14 @@ public class CometdProducer extends DefaultProducer
implements CometdProducerCon
endpoint.connect(this);
// should probably look into synchronization for this.
if (service == null) {
+ CometdBinding binding;
+ if (endpoint.getHeaderFilterStrategy() != null) {
+ binding = new CometdBinding(bayeux, false,
endpoint.getHeaderFilterStrategy());
+ } else {
+ binding = new CometdBinding(bayeux);
+ }
service = new ProducerService(
- getBayeux(), new CometdBinding(bayeux),
endpoint.getPath(), this, getEndpoint().isDisconnectLocalSession());
+ getBayeux(), binding, endpoint.getPath(), this,
getEndpoint().isDisconnectLocalSession());
}
}
diff --git
a/components/camel-cometd/src/test/java/org/apache/camel/component/cometd/CometBindingTest.java
b/components/camel-cometd/src/test/java/org/apache/camel/component/cometd/CometBindingTest.java
index 705260fd1b1f..f8e0bb25223b 100644
---
a/components/camel-cometd/src/test/java/org/apache/camel/component/cometd/CometBindingTest.java
+++
b/components/camel-cometd/src/test/java/org/apache/camel/component/cometd/CometBindingTest.java
@@ -17,7 +17,9 @@
package org.apache.camel.component.cometd;
import java.util.Arrays;
+import java.util.HashMap;
import java.util.HashSet;
+import java.util.Map;
import java.util.Set;
import org.apache.camel.CamelContext;
@@ -33,6 +35,7 @@ import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.when;
@@ -126,4 +129,33 @@ public class CometBindingTest {
result.getHeader(CometdBinding.COMETD_SUBSCRIPTION_HEADER_NAME));
}
+ @Test
+ void testInboundCamelHeadersAreFiltered() {
+ Map<String, Object> camelHeaders = new HashMap<>();
+ camelHeaders.put("CamelSqlQuery", "SELECT * FROM secrets");
+ camelHeaders.put("CamelHttpUri", "http://evil.com";);
+ camelHeaders.put("CamelFileName", "../../etc/passwd");
+ camelHeaders.put("X-App-Header", "normal-value");
+
+ Map<String, Object> ext = new HashMap<>();
+ ext.put(CometdBinding.HEADERS_FIELD, camelHeaders);
+ when(cometdMessage.getExt()).thenReturn(ext);
+ when(remote.getId()).thenReturn("test-client-id");
+
+ // act
+ Message result = testObj.createCamelMessage(camelContext, remote,
cometdMessage, null);
+
+ // assert: Camel* control headers from ext must be filtered out
+ assertNull(result.getHeader("CamelSqlQuery"), "CamelSqlQuery should be
filtered");
+ assertNull(result.getHeader("CamelHttpUri"), "CamelHttpUri should be
filtered");
+ assertNull(result.getHeader("CamelFileName"), "CamelFileName should be
filtered");
+
+ // assert: non-Camel headers from ext must pass through
+ assertNotNull(result.getHeader("X-App-Header"), "X-App-Header should
pass through");
+ assertEquals("normal-value", result.getHeader("X-App-Header"));
+
+ // assert: CometdClientId is set by the binding itself (not from ext),
so it must be present
+
assertNotNull(result.getHeader(CometdBinding.COMETD_CLIENT_ID_HEADER_NAME));
+ }
+
}
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CometdEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CometdEndpointBuilderFactory.java
index 8204f732d2c7..622bb9330d22 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CometdEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CometdEndpointBuilderFactory.java
@@ -473,6 +473,36 @@ public interface CometdEndpointBuilderFactory {
doSetProperty("exchangePattern", exchangePattern);
return this;
}
+ /**
+ * To use a custom HeaderFilterStrategy to filter headers.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code> type.
+ *
+ * Group: advanced
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedCometdEndpointConsumerBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy
headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
+ /**
+ * To use a custom HeaderFilterStrategy to filter headers.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code> type.
+ *
+ * Group: advanced
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedCometdEndpointConsumerBuilder
headerFilterStrategy(String headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
}
/**
@@ -844,6 +874,36 @@ public interface CometdEndpointBuilderFactory {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
+ /**
+ * To use a custom HeaderFilterStrategy to filter headers.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code> type.
+ *
+ * Group: advanced
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedCometdEndpointProducerBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy
headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
+ /**
+ * To use a custom HeaderFilterStrategy to filter headers.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code> type.
+ *
+ * Group: advanced
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedCometdEndpointProducerBuilder
headerFilterStrategy(String headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
}
/**
@@ -1139,6 +1199,36 @@ public interface CometdEndpointBuilderFactory {
return (CometdEndpointBuilder) this;
}
+ /**
+ * To use a custom HeaderFilterStrategy to filter headers.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code> type.
+ *
+ * Group: advanced
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedCometdEndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy
headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
+ /**
+ * To use a custom HeaderFilterStrategy to filter headers.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code> type.
+ *
+ * Group: advanced
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedCometdEndpointBuilder headerFilterStrategy(String
headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
}
public interface CometdBuilders {
