Apache Camel 3.x Upgrade Guide

The core has been further modularized and is now split up into three new core modules:

This separates the route model from the runtime processors via the reifiers, by having the classes in their own modules.

The class BreakpointSupport has moved from org/apache/camel/processor/interceptor/BreakpointSupport to org.apache.camel.support.BreakpointSupport.

The following internal classes have been moved to locations that better suit where other similar processors are located:

The class org.apache.camel.impl.validator.ProcessorValidator moved to org.apache.camel.processor.validator.ProcessorValidator. The class org.apache.camel.impl.transformer.ProcessorTransformer moved to org.apache.camel.processor.transformer.ProcessorTransformer. The class org.apache.camel.impl.transformer.DataFormatTransformer moved to org.apache.camel.processor.transformer.DataFormatTransformer. The class org.apache.camel.impl.validator.ValidatorKey moved to org.apache.camel.impl.engine.ValidatorKey. The class org.apache.camel.impl.transformer.TransformerKey moved to org.apache.camel.impl.engine.TransformerKey.

The class org.apache.camel.impl.DefaultExecutorServiceManager was moved from camel-core-engine JAR to org.apache.camel.impl.engine.DefaultExecutorServiceManager in the camel-base JAR.

The class org.apache.camel.processor.ConvertBodyProcessor was moved to org.apache.camel.support.ConvertBodyProcessor in the camel-support JAR.

The class org.apache.camel.impl.engine.DefaultClaimCheckRepository moved to org.apache.camel.processor.DefaultClaimCheckRepository in the camel-core-processor JAR.

The class org.apache.camel.impl.engine.DefaultProducerCache was moved to org.apache.camel.support.cache.DefaultProducerCache. The class org.apache.camel.impl.engine.DefaultConsumerCache was moved to org.apache.camel.support.cache.DefaultConsumerCache. The class org.apache.camel.impl.engine.EmptyProducerCache was moved to org.apache.camel.support.cache.EmptyProducerCache. The class org.apache.camel.impl.engine.ServicePool was moved to org.apache.camel.support.cache.ServicePool. The class org.apache.camel.impl.engine.ProducerServicePool was moved to org.apache.camel.support.cache.ProducerServicePool. The class org.apache.camel.impl.engine.PollingConsumerServicePool was moved to org.apache.camel.support.cache.PollingConsumerServicePool. The class org.apache.camel.impl.engine.EventNotifierCallback was moved to org.apache.camel.support.cache.EventNotifierCallback.

Two methods related to adding and removing error handlers were removed from the interface org.apache.camel.spi.LifecycleStrategy.

Camel 3.7 has optimized its type converter system, which can impact 3rd party components which contain type converters. Previously, the type converter system would attempt to find a type converter that would be capable of converting between two given types (also by walking up the parent classes and super interfaces). But this leads to slower performance, and Camel now relies on there being converter methods with the exact combo of converting from/to types.

The MBeans for error handlers have been removed.

If a custom org.apache.camel.spi.ProcessorFactory is in use, the factory should extend the default implementation org.apache.camel.processor.DefaultProcessorFactory and in the overridden methods, super should be called to let the default implementation create the processor when no custom processors is created.

The class org.apache.camel.impl.engine.TypedProcessorFactor moved from camel-base JAR to org.apache.camel.support.TypedProcessorFactor in the camel-support JAR.

Advice routes moved the adviceWith method from org.apache.camel.reifier.RouteReifier to org.apache.camel.builder.AdviceWith. Also adviceWith methods on org.apache.camel.builder.AdviceWithRouteBuilder are deprecated in favour of using methods on org.apache.camel.builder.AdviceWith.

Support for using multiple languages in the toD EIP has been removed as it was a rarley used feature and was causing problems for maintenance. toD uses simple language by default, but an alternative language can still be specified.

The deprecated option basicPropertyBinding has been removed.

The original URI path has been changed, now the bucket part is simply a required option and it’s not part of the URI anymore.

The event type header is no longer an enum, but it is now the explicit event as a String value.

Component uses a different serialization mechanism, which is not backwards compatible with the original one. For full compatibility, use the camel-leveldb-legacy component (the legacy component will be removed in a future release).

The class InterceptSendToMockEndpointStrategy in camel-base JAR was moved from org.apache.camel.impl.engine.InterceptSendToMockEndpointStrategy to org.apache.camel.component.mock.InterceptSendToMockEndpointStrategy in the camel-mock JAR.

The class org.apache.camel.impl.saga.InMemorySagaService was moved to org.apache.camel.saga.InMemorySagaService. The class org.apache.camel.impl.saga.InMemorySagaCoordinator was moved to org.apache.camel.saga.InMemorySagaCoordinator.

The listTypeConverters operation on ManagedTypeConverterRegistryMBean has been removed.

We changed some option’s naming because they were a bit misleading:

For more information, have a look at CAMEL-15770

The Camel Git Commit consumer has been changed a bit.

For each exchange now in the body, you’ll get the commit full message as a String and the Commit Object like before.

Other information has been stored in headers declared in GitConstants class:

The Camel Git Branch consumer has been changed a bit.

For each exchange now in the body, you’ll get the branch ref name and not the full ref like before.

Other information has been stored in headers declared in GitConstants class:

The Camel Git Tag consumer has been changed a bit.

For each exchange now in the body, you’ll get the tag ref name and not the full ref like before.

Other information has been stored in headers declared in GitConstants class:

Login using username and password is no longer supported by GitHub and these options have been removed (https://developer.github.com/changes/2020-02-14-deprecating-password-auth/).

Login must be done using the oauthToken option.

The camel-aws2-s3 component now has support for autowiring the amazonS3Client option with a S3Client instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The option useIamCredentials has been renamed to useDefaultCredentialsProvider, since we changed to a DefaultCredentialsProvider approach.

The camel-aws2-cw component now has support for autowiring the amazonCwClient option with a CloudWatchClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-ddb component now has support for autowiring the amazonDDBClient option with a DynamoDbClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-ddbstreams component now has support for autowiring the amazonDynamoDbStreamsClient option with a DynamoDbStreamsClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-ec2 component now has support for autowiring the amazonEc2Client option with an Ec2Client instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-ecs component now has support for autowiring the ecsClient option with an EcsClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-eks component now has support for autowiring the eksClient option with an EksClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-eventbridge component now has support for autowiring the eventBridgeClient option with an EventBridgeClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-iam component now has support for autowiring the iamClient option with an IamClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-kinesis component now has support for autowiring the amazonKinesisClient option with a KinesisClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-kinesis-firehose component now has support for autowiring the amazonKinesisFirehoseClient option with a FirehoseClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-kms component now has support for autowiring the awsLambdaClient option with a LambdaClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-kms component now has support for autowiring the kmsClient option with a KmsClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-mq component now has support for autowiring the amazonMqClient option with a MqClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-msk component now has support for autowiring the mskClient option with a KafkaClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-ses component now has support for autowiring the amazonSESClient option with a SesClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-sns component now has support for autowiring the amazonSNSClient option with a SnsClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The option useIamCredentials has been renamed to useDefaultCredentialsProvider, since we changed to a DefaultCredentialsProvider approach.

The camel-aws2-sqs component now has support for autowiring the 1 amazonSQSClient option with a SqsClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The option useIamCredentials has been renamed to useDefaultCredentialsProvider, since we changed to a DefaultCredentialsProvider approach.

The camel-aws2-sts component now has support for autowiring the stsClient option with a StsClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-translate component now has support for autowiring the translateClient option with a TranslateClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The camel-aws2-athena component now has support for autowiring the amazonAthenaClient option with an AthenaClient instance coming from the registry. In this context, it wasn’t making sense to maintain the autodiscoverClient option, which has been removed.

The default API version for camel-salesforce has been updated to 50.0. Older versions are still supported and can be set via the apiVersion component option.

The packages option must be set if using the XML format option. This change is a result of adopting XStream’s Security Framework.

CAMEL-15890 fixed a bug in which values for External Ids that contained spaces would have spaces converted to "+". This has been fixed. However, any such values that now have the plus sign in salesforce will no longer match as Camel will now preserve the space. Therefore you may need to have a transformation that explicitly converts spaces to "+" if you need to preserve the old behavior.

The camel-google-bigquery component was updated to use the latest version of google-cloud-bigquery. Some features of GoogleBigQueryConnectionFactory are no longer supported.

It is no longer possible to provide the service account private key as a String parameter to GoogleBigQueryConnectionFactory. Instead, you should use setCredentialsFileLocation to discover the private key from your credential’s file. Or use the fallback mechanism for discovering credentials by setting the GOOGLE_APPLICATION_CREDENTIALS environment variable. Refer to the component documentation for more information.