Apache Camel 3.x Upgrade Guide

The behavior for breakOnFirstError was altered as numerous issues were fixed. The behavior related to committing the offset is now determined by the CommitManager that is configured.

When the default CommitManager is used (NoopCommitManager) then no commit is performed. The route implementation will be responsible for managing the offset using KafkaManualCommit to manage the retrying of the payload.

When using the SyncCommitManager then the offset will be committed so that the payload is continually retried. This was the behavior described in the documentation.

When using the AsyncCommitManager then the offset will be committed so that the payload is continually retried. This was the behavior described in the documentation.

XML parsers & XML transformers has been made more secure by disabling DOCTYPE and/or access to external DTD/Schema.

The class org.apache.camel.impl.console.AbstractDevConsole has moved from camel-console to camel-support and moved to package org.apache.camel.support.console.AbstractDevConsole.

Component developers that has plugins for Camel Developer Console, should just use camel-support and camel-util-json as dependencies, and then extend AbstractDevConsole for custom console implementations.

The org.apache.camel.health.HealthCheck method isLiveness is now default false instead of true.

Camel provides the CamelContextCheck as both readiness and liveness checks, so there is at least one of each out of the box.

The option camel.main.routesReloadRestartDuration has changed its default value from true to false.

The option itemPartitionKey has been updated. Now it’s a String and not a PartitionKey POJO anymore. More details in CAMEL-19222.

The API in org.apache.camel.http.common.HttpBinding has changed slightly to be more reusable. The parseBody method now takes in HttpServletRequest as input parameter. And all HttpMessage has been changed to generic Message types.

When using schema validation, then access to external DTD/Schema is disabled by default. To enable access, then set accessExternalSchemaProtocols=all or specify allowed protocols, such as accessExternalSchemaProtocols=file.

XML parser in StAXJAXBIteratorExpression has been made more secure by disabling DOCTYPE and/or access to external DTD/Schema.

XML parsers has been made more secure by disabling DOCTYPE and/or access to external DTD/Schema.

XML parsers has been made more secure by disabling DOCTYPE and/or access to external DTD/Schema.

XML parsers has been made more secure by disabling DOCTYPE and/or access to external DTD/Schema.

The command camel dependencies has been renamed to camel dependency.

The health-check has aligned to be more similar to microprofile-health in the JSon output. Spring Boot now also includes additional data per check, when using full exposure level.

For example as shown below for the context health check:

Camel now shutdowns a bit later during Spring Boot shutdown. This allows Spring Boot graceful shutdown to complete first (stopping Spring Boot HTTP server gracefully), and then afterward Camel is doing its own Graceful Shutdown.

Technically camel-spring has changed getPhase() from returning Integer.MAX_VALUE to Integer.MAX_VALUE - 2049. This gives room for Spring Boot services to shut down first.

The camel-java-joor-dsl cannot anymore load routes defined in class files as we consider it no more needed, consequently the ability to configure the compile directory and the compile load first flag using the corresponding camel-main properties is no longer possible.

The certificatePath parameter can now be specified as resource: for user pointing to a local certificate, the file should be now prefixed with file:. It’s also possible to use the classic resource helper prefixes, like classpath, https etc.

The deprecated option componentName was removed. Please use either producerComponentName or consumerComponentName.

The metrics has been renamed to follow Micrometer naming convention Naming Meters.

The following components that had been marked as deprecated, were removed in this release:

The uri tags are now static instead of dynamic (by default), as potential too many tags generated due to URI with dynamic values. This can be enabled again by setting camel.metrics.uriTagDynamic=true.

The platform-http-starter has been changed from using camel-servlet to use Spring HTTP server directly. Therefore, all the HTTP endpoints are no longer prefixed with the servlet context-path (default is camel).

For example:

Then calling myservice would before require to include the context-path, such as http://localhost:8080/camel/myservice. Now the context-path is not in use, and the endpoint can be called with http://localhost:8080/myservice.