From ec1c4d6331a9999ee573b235ed291dd367c19b35 Mon Sep 17 00:00:00 2001 From: dhairya05 Date: Sat, 14 Nov 2026 23:43:01 +0530 Subject: [PATCH 1/5] camel-docker: deprecate loggingFilter and followRedirectFilter, which have no effect DockerClientFactory builds the complete DockerClientProfile the client is created from - host, port, credentials, timeout, cert path, the two connection limits, secure, tlsVerify, socket and cmdExecFactory - and it sets neither of these two. DockerClientProfile has no field for either, so isLoggingFilter() and isFollowRedirectFilter() are reachable only from the generated configurers. The matching header constants DOCKER_LOGGING_FILTER and DOCKER_FOLLOW_REDIRECT_FILTER are read nowhere at all, and unlike the other constants in DockerConstants they carry no @Metadata, so they are not even documented as headers. Deprecate the two options with a deprecationNote that says nothing reads them, and the two header constants, with an upgrade-guide entry. --- .../camel/catalog/components/docker.json | 8 +++---- .../apache/camel/component/docker/docker.json | 8 +++---- .../component/docker/DockerConfiguration.java | 22 +++++++++++++++++++ .../component/docker/DockerConstants.java | 8 +++++++ .../pages/camel-4x-upgrade-guide-4_24.adoc | 11 ++++++++++ 5 files changed, 49 insertions(+), 8 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json index 85298f452383b..3e1669fb68a0e 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json @@ -33,8 +33,8 @@ "lazyStartProducer": { "index": 6, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 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 starting the producer may take a little time and prolong the total processing time of the processing." }, "autowiredEnabled": { "index": 7, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." }, "cmdExecFactory": { "index": 8, "kind": "property", "displayName": "Cmd Exec Factory", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "com.github.dockerjava.netty.NettyDockerCmdExecFactory", "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "The fully qualified class name of the DockerCmdExecFactory implementation to use" }, - "followRedirectFilter": { "index": 9, "kind": "property", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter" }, - "loggingFilter": { "index": 10, "kind": "property", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter" }, + "followRedirectFilter": { "index": 9, "kind": "property", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, + "loggingFilter": { "index": 10, "kind": "property", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, "maxPerRouteConnections": { "index": 11, "kind": "property", "displayName": "Max Per Route Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum route connections" }, "maxTotalConnections": { "index": 12, "kind": "property", "displayName": "Max Total Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum total connections" }, "parameters": { "index": 13, "kind": "property", "displayName": "Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Additional configuration parameters as key\/value pairs" }, @@ -147,8 +147,8 @@ "exchangePattern": { "index": 7, "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." }, "lazyStartProducer": { "index": 8, "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 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 starting the producer may take a little time and prolong the total processing time of the processing." }, "cmdExecFactory": { "index": 9, "kind": "parameter", "displayName": "Cmd Exec Factory", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "com.github.dockerjava.netty.NettyDockerCmdExecFactory", "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "The fully qualified class name of the DockerCmdExecFactory implementation to use" }, - "followRedirectFilter": { "index": 10, "kind": "parameter", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter" }, - "loggingFilter": { "index": 11, "kind": "parameter", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter" }, + "followRedirectFilter": { "index": 10, "kind": "parameter", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, + "loggingFilter": { "index": 11, "kind": "parameter", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, "maxPerRouteConnections": { "index": 12, "kind": "parameter", "displayName": "Max Per Route Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum route connections" }, "maxTotalConnections": { "index": 13, "kind": "parameter", "displayName": "Max Total Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum total connections" }, "parameters": { "index": 14, "kind": "parameter", "displayName": "Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Additional configuration parameters as key\/value pairs" }, diff --git a/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json b/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json index 85298f452383b..3e1669fb68a0e 100644 --- a/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json +++ b/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json @@ -33,8 +33,8 @@ "lazyStartProducer": { "index": 6, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 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 starting the producer may take a little time and prolong the total processing time of the processing." }, "autowiredEnabled": { "index": 7, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." }, "cmdExecFactory": { "index": 8, "kind": "property", "displayName": "Cmd Exec Factory", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "com.github.dockerjava.netty.NettyDockerCmdExecFactory", "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "The fully qualified class name of the DockerCmdExecFactory implementation to use" }, - "followRedirectFilter": { "index": 9, "kind": "property", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter" }, - "loggingFilter": { "index": 10, "kind": "property", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter" }, + "followRedirectFilter": { "index": 9, "kind": "property", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, + "loggingFilter": { "index": 10, "kind": "property", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, "maxPerRouteConnections": { "index": 11, "kind": "property", "displayName": "Max Per Route Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum route connections" }, "maxTotalConnections": { "index": 12, "kind": "property", "displayName": "Max Total Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum total connections" }, "parameters": { "index": 13, "kind": "property", "displayName": "Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Additional configuration parameters as key\/value pairs" }, @@ -147,8 +147,8 @@ "exchangePattern": { "index": 7, "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." }, "lazyStartProducer": { "index": 8, "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 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 starting the producer may take a little time and prolong the total processing time of the processing." }, "cmdExecFactory": { "index": 9, "kind": "parameter", "displayName": "Cmd Exec Factory", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "com.github.dockerjava.netty.NettyDockerCmdExecFactory", "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "The fully qualified class name of the DockerCmdExecFactory implementation to use" }, - "followRedirectFilter": { "index": 10, "kind": "parameter", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter" }, - "loggingFilter": { "index": 11, "kind": "parameter", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter" }, + "followRedirectFilter": { "index": 10, "kind": "parameter", "displayName": "Follow Redirect Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to follow redirect filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, + "loggingFilter": { "index": 11, "kind": "parameter", "displayName": "Logging Filter", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Docker client is built", "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Whether to use logging filter. Deprecation note: Not used: nothing reads this option when the Docker client is built" }, "maxPerRouteConnections": { "index": 12, "kind": "parameter", "displayName": "Max Per Route Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum route connections" }, "maxTotalConnections": { "index": 13, "kind": "parameter", "displayName": "Max Total Connections", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Maximum total connections" }, "parameters": { "index": 14, "kind": "parameter", "displayName": "Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.docker.DockerConfiguration", "configurationField": "configuration", "description": "Additional configuration parameters as key\/value pairs" }, diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java index 285d93478d90a..4fd73aa5ad924 100644 --- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java +++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java @@ -58,8 +58,12 @@ public class DockerConfiguration implements Cloneable { @UriParam(label = "advanced", defaultValue = "100") private Integer maxPerRouteConnections = 100; @UriParam(label = "advanced") + @Metadata(deprecationNote = "Not used: nothing reads this option when the Docker client is built") + @Deprecated private boolean loggingFilter; @UriParam(label = "advanced") + @Metadata(deprecationNote = "Not used: nothing reads this option when the Docker client is built") + @Deprecated private boolean followRedirectFilter; @UriParam(label = "security", defaultValue = "false") private boolean tlsVerify; @@ -195,24 +199,42 @@ public void setMaxPerRouteConnections(Integer maxPerRouteConnections) { this.maxPerRouteConnections = maxPerRouteConnections; } + /** + * Whether to use logging filter + * + * @deprecated Not used: nothing reads this option when the Docker client is built + */ + @Deprecated public boolean isLoggingFilter() { return loggingFilter; } /** * Whether to use logging filter + * + * @deprecated Not used: nothing reads this option when the Docker client is built */ + @Deprecated public void setLoggingFilter(boolean loggingFilterEnabled) { this.loggingFilter = loggingFilterEnabled; } + /** + * Whether to follow redirect filter + * + * @deprecated Not used: nothing reads this option when the Docker client is built + */ + @Deprecated public boolean isFollowRedirectFilter() { return followRedirectFilter; } /** * Whether to follow redirect filter + * + * @deprecated Not used: nothing reads this option when the Docker client is built */ + @Deprecated public void setFollowRedirectFilter(boolean followRedirectFilterEnabled) { this.followRedirectFilter = followRedirectFilterEnabled; } diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java index 777e97b9c3b14..bcd6b12558fd5 100644 --- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java +++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java @@ -67,7 +67,15 @@ public final class DockerConstants { + " enables allowConnectionAndCredentialsFromHeaders=true (disabled by default).", javaType = "Boolean", defaultValue = "false") public static final String DOCKER_SECURE = "CamelDockerSecure"; + /** + * @deprecated nothing reads this header; it pairs with the followRedirectFilter option, which has no effect + */ + @Deprecated public static final String DOCKER_FOLLOW_REDIRECT_FILTER = "CamelDockerFollowRedirectFilter"; + /** + * @deprecated nothing reads this header; it pairs with the loggingFilter option, which has no effect + */ + @Deprecated public static final String DOCKER_LOGGING_FILTER = "CamelDockerLoggingFilter"; @Metadata(description = "Check TLS. This header is ignored unless the endpoint" + " enables allowConnectionAndCredentialsFromHeaders=true (disabled by default).", diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc index 028422a474ff9..2128b342d3c4a 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc @@ -8743,3 +8743,14 @@ if it configured the proxy. It is now deprecated, with a `deprecationNote` that says so, and its description no longer claims to configure a proxy. Remove `protocol` from the endpoint URI or the configuration. To send the client's traffic through a proxy, use `proxyProtocol` together with `proxyHost` and `proxyPort`, which the shared client builder does apply. + +=== camel-docker - the loggingFilter and followRedirectFilter options are deprecated + +Neither option has ever had an effect. `DockerClientFactory` builds the whole `DockerClientProfile` that the client is +created from, and it sets neither of them - `DockerClientProfile` has no field for either - so `isLoggingFilter()` and +`isFollowRedirectFilter()` are called only by the generated configurers. The two matching headers, +`CamelDockerLoggingFilter` and `CamelDockerFollowRedirectFilter`, are read nowhere either. + +Both options and both header constants are now deprecated. Remove `loggingFilter` and `followRedirectFilter` from the +endpoint URI or the component configuration; setting them changed nothing. To log the exchanges with the Docker daemon, +use a `log` EIP or raise the log level of the docker-java client instead. From 8fcb95e851c42eb7bfc08816b283d9f2cee9c30b Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Sat, 14 Nov 2026 19:06:51 +0000 Subject: [PATCH 2/5] Regen --- .../dsl/DockerComponentBuilderFactory.java | 8 +++- .../dsl/DockerEndpointBuilderFactory.java | 48 ++++++++++++++----- 2 files changed, 42 insertions(+), 14 deletions(-) diff --git a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java index cbdfebbd05af3..bd671206facce 100644 --- a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java +++ b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java @@ -229,7 +229,8 @@ default DockerComponentBuilder cmdExecFactory(java.lang.String cmdExecFactory) { /** - * Whether to follow redirect filter. + * Whether to follow redirect filter. Deprecation note: Not used: + * nothing reads this option when the Docker client is built. * * The option is a: <code>boolean</code> type. * @@ -239,6 +240,7 @@ default DockerComponentBuilder cmdExecFactory(java.lang.String cmdExecFactory) { * @param followRedirectFilter the value to set * @return the dsl builder */ + @Deprecated default DockerComponentBuilder followRedirectFilter(boolean followRedirectFilter) { doSetProperty("followRedirectFilter", followRedirectFilter); return this; @@ -246,7 +248,8 @@ default DockerComponentBuilder followRedirectFilter(boolean followRedirectFilter /** - * Whether to use logging filter. + * Whether to use logging filter. Deprecation note: Not used: nothing + * reads this option when the Docker client is built. * * The option is a: <code>boolean</code> type. * @@ -256,6 +259,7 @@ default DockerComponentBuilder followRedirectFilter(boolean followRedirectFilter * @param loggingFilter the value to set * @return the dsl builder */ + @Deprecated default DockerComponentBuilder loggingFilter(boolean loggingFilter) { doSetProperty("loggingFilter", loggingFilter); return this; diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java index 3d58f517f862f..b025f99457090 100644 --- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java +++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java @@ -384,7 +384,8 @@ default AdvancedDockerEndpointConsumerBuilder cmdExecFactory(String cmdExecFacto return this; } /** - * Whether to follow redirect filter. + * Whether to follow redirect filter. Deprecation note: Not used: + * nothing reads this option when the Docker client is built. * * The option is a: boolean type. * @@ -394,12 +395,14 @@ default AdvancedDockerEndpointConsumerBuilder cmdExecFactory(String cmdExecFacto * @param followRedirectFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointConsumerBuilder followRedirectFilter(boolean followRedirectFilter) { doSetProperty("followRedirectFilter", followRedirectFilter); return this; } /** - * Whether to follow redirect filter. + * Whether to follow redirect filter. Deprecation note: Not used: + * nothing reads this option when the Docker client is built. * * The option will be converted to a boolean type. * @@ -409,12 +412,14 @@ default AdvancedDockerEndpointConsumerBuilder followRedirectFilter(boolean follo * @param followRedirectFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointConsumerBuilder followRedirectFilter(String followRedirectFilter) { doSetProperty("followRedirectFilter", followRedirectFilter); return this; } /** - * Whether to use logging filter. + * Whether to use logging filter. Deprecation note: Not used: nothing + * reads this option when the Docker client is built. * * The option is a: boolean type. * @@ -424,12 +429,14 @@ default AdvancedDockerEndpointConsumerBuilder followRedirectFilter(String follow * @param loggingFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointConsumerBuilder loggingFilter(boolean loggingFilter) { doSetProperty("loggingFilter", loggingFilter); return this; } /** - * Whether to use logging filter. + * Whether to use logging filter. Deprecation note: Not used: nothing + * reads this option when the Docker client is built. * * The option will be converted to a boolean type. * @@ -439,6 +446,7 @@ default AdvancedDockerEndpointConsumerBuilder loggingFilter(boolean loggingFilte * @param loggingFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointConsumerBuilder loggingFilter(String loggingFilter) { doSetProperty("loggingFilter", loggingFilter); return this; @@ -914,7 +922,8 @@ default AdvancedDockerEndpointProducerBuilder cmdExecFactory(String cmdExecFacto return this; } /** - * Whether to follow redirect filter. + * Whether to follow redirect filter. Deprecation note: Not used: + * nothing reads this option when the Docker client is built. * * The option is a: boolean type. * @@ -924,12 +933,14 @@ default AdvancedDockerEndpointProducerBuilder cmdExecFactory(String cmdExecFacto * @param followRedirectFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointProducerBuilder followRedirectFilter(boolean followRedirectFilter) { doSetProperty("followRedirectFilter", followRedirectFilter); return this; } /** - * Whether to follow redirect filter. + * Whether to follow redirect filter. Deprecation note: Not used: + * nothing reads this option when the Docker client is built. * * The option will be converted to a boolean type. * @@ -939,12 +950,14 @@ default AdvancedDockerEndpointProducerBuilder followRedirectFilter(boolean follo * @param followRedirectFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointProducerBuilder followRedirectFilter(String followRedirectFilter) { doSetProperty("followRedirectFilter", followRedirectFilter); return this; } /** - * Whether to use logging filter. + * Whether to use logging filter. Deprecation note: Not used: nothing + * reads this option when the Docker client is built. * * The option is a: boolean type. * @@ -954,12 +967,14 @@ default AdvancedDockerEndpointProducerBuilder followRedirectFilter(String follow * @param loggingFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointProducerBuilder loggingFilter(boolean loggingFilter) { doSetProperty("loggingFilter", loggingFilter); return this; } /** - * Whether to use logging filter. + * Whether to use logging filter. Deprecation note: Not used: nothing + * reads this option when the Docker client is built. * * The option will be converted to a boolean type. * @@ -969,6 +984,7 @@ default AdvancedDockerEndpointProducerBuilder loggingFilter(boolean loggingFilte * @param loggingFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointProducerBuilder loggingFilter(String loggingFilter) { doSetProperty("loggingFilter", loggingFilter); return this; @@ -1356,7 +1372,8 @@ default AdvancedDockerEndpointBuilder cmdExecFactory(String cmdExecFactory) { return this; } /** - * Whether to follow redirect filter. + * Whether to follow redirect filter. Deprecation note: Not used: + * nothing reads this option when the Docker client is built. * * The option is a: boolean type. * @@ -1366,12 +1383,14 @@ default AdvancedDockerEndpointBuilder cmdExecFactory(String cmdExecFactory) { * @param followRedirectFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointBuilder followRedirectFilter(boolean followRedirectFilter) { doSetProperty("followRedirectFilter", followRedirectFilter); return this; } /** - * Whether to follow redirect filter. + * Whether to follow redirect filter. Deprecation note: Not used: + * nothing reads this option when the Docker client is built. * * The option will be converted to a boolean type. * @@ -1381,12 +1400,14 @@ default AdvancedDockerEndpointBuilder followRedirectFilter(boolean followRedirec * @param followRedirectFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointBuilder followRedirectFilter(String followRedirectFilter) { doSetProperty("followRedirectFilter", followRedirectFilter); return this; } /** - * Whether to use logging filter. + * Whether to use logging filter. Deprecation note: Not used: nothing + * reads this option when the Docker client is built. * * The option is a: boolean type. * @@ -1396,12 +1417,14 @@ default AdvancedDockerEndpointBuilder followRedirectFilter(String followRedirect * @param loggingFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointBuilder loggingFilter(boolean loggingFilter) { doSetProperty("loggingFilter", loggingFilter); return this; } /** - * Whether to use logging filter. + * Whether to use logging filter. Deprecation note: Not used: nothing + * reads this option when the Docker client is built. * * The option will be converted to a boolean type. * @@ -1411,6 +1434,7 @@ default AdvancedDockerEndpointBuilder loggingFilter(boolean loggingFilter) { * @param loggingFilter the value to set * @return the dsl builder */ + @Deprecated default AdvancedDockerEndpointBuilder loggingFilter(String loggingFilter) { doSetProperty("loggingFilter", loggingFilter); return this; From 6044ee27fc8b707a75dfb5efedf5228a79394b45 Mon Sep 17 00:00:00 2001 From: dhairya05 <83921853+Dhairya-007@users.noreply.github.com> Date: Sun, 15 Nov 2026 01:33:46 +0530 Subject: [PATCH 3/5] Update docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc Co-authored-by: Guillaume Nodet - AI Bot --- .../modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc index 2128b342d3c4a..15d56c8a6b2d2 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc @@ -8753,4 +8753,4 @@ created from, and it sets neither of them - `DockerClientProfile` has no field f Both options and both header constants are now deprecated. Remove `loggingFilter` and `followRedirectFilter` from the endpoint URI or the component configuration; setting them changed nothing. To log the exchanges with the Docker daemon, -use a `log` EIP or raise the log level of the docker-java client instead. +Raise the log level of the `com.github.dockerjava` loggers to see the daemon traffic. From 78d5ec8cb2bc793bc90449071ab4f929867a17e6 Mon Sep 17 00:00:00 2001 From: dhairya05 <83921853+Dhairya-007@users.noreply.github.com> Date: Sun, 15 Nov 2026 01:34:07 +0530 Subject: [PATCH 4/5] Update docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc Co-authored-by: Guillaume Nodet - AI Bot --- .../modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc index 15d56c8a6b2d2..7f792b33d1a2c 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc @@ -8746,7 +8746,7 @@ Remove `protocol` from the endpoint URI or the configuration. To send the client === camel-docker - the loggingFilter and followRedirectFilter options are deprecated -Neither option has ever had an effect. `DockerClientFactory` builds the whole `DockerClientProfile` that the client is +Neither option has had any effect since Camel 2.18. `DockerClientFactory` builds the whole `DockerClientProfile` that the client is created from, and it sets neither of them - `DockerClientProfile` has no field for either - so `isLoggingFilter()` and `isFollowRedirectFilter()` are called only by the generated configurers. The two matching headers, `CamelDockerLoggingFilter` and `CamelDockerFollowRedirectFilter`, are read nowhere either. From 9db657f97029faebdec3f9052cb1864fae0fe61d Mon Sep 17 00:00:00 2001 From: dhairya05 Date: Sun, 15 Nov 2026 01:42:28 +0530 Subject: [PATCH 5/5] camel-docker: finish the upgrade-guide wording from review The two suggestions were applied but left a dangling clause ("To log the exchanges with the Docker daemon, Raise the log level ..."). Say when the options stopped working and why - CAMEL-10307, the docker-java 3.x upgrade that first shipped in camel-2.18.0, removed the withLoggingFilter and withFollowRedirectsFilter calls they fed - and give the docker-java logger advice as one sentence. --- .../ROOT/pages/camel-4x-upgrade-guide-4_24.adoc | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc index 7f792b33d1a2c..84931c4777af9 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc @@ -8746,11 +8746,12 @@ Remove `protocol` from the endpoint URI or the configuration. To send the client === camel-docker - the loggingFilter and followRedirectFilter options are deprecated -Neither option has had any effect since Camel 2.18. `DockerClientFactory` builds the whole `DockerClientProfile` that the client is -created from, and it sets neither of them - `DockerClientProfile` has no field for either - so `isLoggingFilter()` and -`isFollowRedirectFilter()` are called only by the generated configurers. The two matching headers, -`CamelDockerLoggingFilter` and `CamelDockerFollowRedirectFilter`, are read nowhere either. +Neither option has had any effect since Camel 2.18, when the docker-java 3.x upgrade removed the +`withLoggingFilter` and `withFollowRedirectsFilter` calls they fed. `DockerClientFactory` now builds the whole +`DockerClientProfile` that the client is created from, and it sets neither of them - `DockerClientProfile` has no field +for either - so `isLoggingFilter()` and `isFollowRedirectFilter()` are called only by the generated configurers. The +two matching headers, `CamelDockerLoggingFilter` and `CamelDockerFollowRedirectFilter`, are read nowhere either. Both options and both header constants are now deprecated. Remove `loggingFilter` and `followRedirectFilter` from the -endpoint URI or the component configuration; setting them changed nothing. To log the exchanges with the Docker daemon, -Raise the log level of the `com.github.dockerjava` loggers to see the daemon traffic. +endpoint URI or the component configuration; setting them has changed nothing since 2.18. To see the traffic with the +Docker daemon, raise the log level of the `com.github.dockerjava` loggers.