Getting Started with Camel Spring Boot
Getting Started with Camel Spring Boot
Abstract
Preface Copy linkLink copied to clipboard!
Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Chapter 1. Getting Started with Camel Spring Boot Copy linkLink copied to clipboard!
This guide introduces Camel Spring Boot and demonstrates how to get started building an application using Camel Spring Boot:
- Section 1.1, “Camel Spring Boot starters”
- Section 1.2, “Spring Boot”
- Section 1.3, “Component Starters”
- Section 1.4, “Starter Configuration”
- Section 1.5, “Generating a Camel for Spring Boot application using Maven”
- Section 1.7, “Applying patch to Camel Spring Boot”
- Section 1.8, “Camel REST DSL OpenApi Maven Plugin”
- Section 1.9, “Support for FIPS Compliance”
1.1. Camel Spring Boot starters Copy linkLink copied to clipboard!
Camel support for Spring Boot provides auto-configuration of the Camel and starters for many Camel components. The opinionated auto-configuration of the Camel context auto-detects Camel routes available in the Spring context and registers the key Camel utilities (such as producer template, consumer template and the type converter) as beans.
For information about using a Maven archtype to generate a Camel for Spring Boot application see Generating a Camel for Spring Boot application using Maven.
To get started, you must add the Camel Spring Boot BOM to your Maven pom.xml file.
The camel-spring-boot-bom is a basic BOM that contains the list of Camel Spring Boot starter JARs.
Next, add the Camel Spring Boot starter to startup the Camel Context.
You must also add any component starters that your Spring Boot application requires. The following example shows how to add the auto-configuration starter to the MQTT5 component
1.1.1. Camel Spring Boot BOM vs Camel Spring Boot Dependencies BOM Copy linkLink copied to clipboard!
The curated camel-spring-boot-dependencies BOM, which is generated, contains the adjusted JARs that both Spring Boot and Apache Camel use to avoid any conflicts. This BOM is used to test camel-spring-boot itself.
Spring Boot users may choose to use pure Camel dependencies by using the camel-spring-boot-bom that only has the Camel starter JARs as managed dependencies. However, this may lead to a classpath conflict if a third-party JAR from Spring Boot is not compatible with a particular Camel component.
1.1.2. Spring Boot configuration support Copy linkLink copied to clipboard!
Each starter lists configuration parameters you can configure in the standard application.properties or application.yml files. These parameters have the form of camel.component.[component-name].[parameter]. For example to configure the URL of the MQTT5 broker you can set:
camel.component.paho-mqtt5.broker-url=tcp://localhost:61616
camel.component.paho-mqtt5.broker-url=tcp://localhost:61616
1.1.3. Adding Camel routes Copy linkLink copied to clipboard!
Camel routes are detected in the Spring application context, for example a route annotated with org.springframework.stereotype.Component will be loaded, added to the Camel context and run.
1.2. Spring Boot Copy linkLink copied to clipboard!
Spring Boot automatically configures Camel for you. The opinionated auto-configuration of the Camel context auto-detects Camel routes available in the Spring context and registers the key Camel utilities (like producer template, consumer template and the type converter) as beans.
Maven users will need to add the following dependency to their pom.xml in order to use this component:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-spring-boot</artifactId>
<version>3.20.1.redhat-00064</version> <!-- use the same version as your Camel core version -->
</dependency>
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-spring-boot</artifactId>
<version>3.20.1.redhat-00064</version> <!-- use the same version as your Camel core version -->
</dependency>
camel-spring-boot jar comes with the spring.factories file, so as soon as you add that dependency into your classpath, Spring Boot will automatically auto-configure Camel for you.
1.2.1. Camel Spring Boot Starter Copy linkLink copied to clipboard!
Apache Camel ships a Spring Boot Starter module that allows you to develop Spring Boot applications using starters. There is a sample application in the source code also.
To use the starter, add the following to your spring boot pom.xml file:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-spring-boot-bom</artifactId>
<version>3.20.1.redhat-00064</version> <!-- use the same version as your Camel core version -->
</dependency>
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-spring-boot-bom</artifactId>
<version>3.20.1.redhat-00064</version> <!-- use the same version as your Camel core version -->
</dependency>
Then you can just add classes with your Camel routes such as:
Then these routes will be started automatically.
You can customize the Camel application in the application.properties or application.yml file.
1.2.2. Spring Boot Auto-configuration Copy linkLink copied to clipboard!
When using spring-boot with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-spring-boot-starter</artifactId> <version>3.20.1.redhat-00064</version> <!-- use the same version as your Camel core version --> </dependency>
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-spring-boot-starter</artifactId>
<version>3.20.1.redhat-00064</version> <!-- use the same version as your Camel core version -->
</dependency>
1.2.3. Auto-configured Camel context Copy linkLink copied to clipboard!
The most important piece of functionality provided by the Camel auto-configuration is the CamelContext instance. Camel auto-configuration creates a SpringCamelContext for you and takes care of the proper initialization and shutdown of that context. The created Camel context is also registered in the Spring application context (under the camelContext bean name), so you can access it like any other Spring bean.
1.2.4. Auto-detecting Camel routes Copy linkLink copied to clipboard!
Camel auto-configuration collects all the RouteBuilder instances from the Spring context and automatically injects them into the provided CamelContext. This means that creating new Camel routes with the Spring Boot starter is as simple as adding the @Component annotated class to your classpath:
Or creating a new route RouteBuilder bean in your @Configuration class:
1.2.5. Camel properties Copy linkLink copied to clipboard!
Spring Boot auto-configuration automatically connects to Spring Boot external configuration (which may contain properties placeholders, OS environment variables or system properties) with the Camel properties support. It basically means that any property defined in application.properties file:
route.from = jms:invoices
route.from = jms:invoices
Or set via system property:
java -Droute.to=jms:processed.invoices -jar mySpringApp.jar
java -Droute.to=jms:processed.invoices -jar mySpringApp.jar
can be used as placeholders in Camel route:
1.2.6. Custom Camel context configuration Copy linkLink copied to clipboard!
If you want to perform some operations on CamelContext bean created by Camel auto-configuration, register CamelContextConfiguration instance in your Spring context:
The method beforeApplicationStart will be called just before the Spring context is started, so the CamelContext instance passed to this callback is fully auto-configured. If you add multiple instances of CamelContextConfiguration into your Spring context, each instance is executed.
1.2.7. Auto-configured consumer and producer templates Copy linkLink copied to clipboard!
Camel auto-configuration provides pre-configured ConsumerTemplate and ProducerTemplate instances. You can simply inject them into your Spring-managed beans:
By default, consumer templates and producer templates come with the endpoint cache sizes set to 1000. You can change these values by modifying the following Spring properties:
camel.springboot.consumer-template-cache-size = 100 camel.springboot.producer-template-cache-size = 200
camel.springboot.consumer-template-cache-size = 100
camel.springboot.producer-template-cache-size = 200
1.2.8. Auto-configured TypeConverter Copy linkLink copied to clipboard!
Camel auto-configuration registers a TypeConverter instance named typeConverter in the Spring context.
1.2.8.1. Spring type conversion API bridge Copy linkLink copied to clipboard!
Spring comes with the powerful type conversion API. The Spring API is similar to the Camel type converter API. As both APIs are so similar, Camel Spring Boot automatically registers a bridge converter (SpringTypeConverter) that delegates to the Spring conversion API. This means that out-of-the-box Camel will treat Spring Converters like Camel ones. With this approach you can use both Camel and Spring converters accessed via Camel TypeConverter API:
Under the hood Camel Spring Boot delegates conversion to the Spring’s ConversionService instances available in the application context. If no ConversionService instance is available, Camel Spring Boot auto-configuration will create one for you.
1.2.9. Keeping the application alive Copy linkLink copied to clipboard!
Camel applications which have this feature enabled launch a new thread on startup for the sole purpose of keeping the application alive by preventing JVM termination. This means that after you start a Camel application with Spring Boot, your application waits for a Ctrl+C signal and does not exit immediately.
The controller thread can be activated using the camel.springboot.main-run-controller to true.
camel.springboot.main-run-controller = true
camel.springboot.main-run-controller = true
Applications using web modules (for example, applications that import the org.springframework.boot:spring-boot-web-starter module), usually don’t need to use this feature because the application is kept alive by the presence of other non-daemon threads.
1.2.10. Adding XML routes Copy linkLink copied to clipboard!
By default, you can put Camel XML routes in the classpath under the directory camel, which camel-spring-boot will auto-detect and include. You can configure the directory name or turn this off using the configuration option:
turn off
# turn off
camel.springboot.routes-include-pattern = false
scan only in the com/foo/routes classpath
# scan only in the com/foo/routes classpath
camel.springboot.routes-include-pattern = classpath:com/foo/routes/*.xml
The XML files should be Camel XML routes (not <CamelContext>) such as:
1.2.11. Testing the JUnit 5 way Copy linkLink copied to clipboard!
For testing, Maven users will need to add the following dependencies to their pom.xml:
To test a Camel Spring Boot application, annotate your test class(es) with @CamelSpringBootTest. This brings Camel’s Spring Test support to your application, so that you can write tests using Spring Boot test conventions.
To get the CamelContext or ProducerTemplate, you can inject them into the class in the normal Spring manner, using @Autowired.
You can also use camel-test-spring-junit5 to configure tests declaratively. This example uses the @MockEndpoints annotation to auto-mock an endpoint:
1.3. Component Starters Copy linkLink copied to clipboard!
Camel Spring Boot supports the following Camel artifacts as Spring Boot Starters:
Reference documentation is not yet available for some of the artifacts listed below. This documentation will be released as soon as it is available.
| Component | Artifact | Description |
|---|---|---|
| camel-amqp-starter | Messaging with AMQP protocol using Apache QPid Client. | |
| camel-aws2-cw-starter | Sending metrics to AWS CloudWatch using AWS SDK version 2.x. | |
| camel-aws2-ddb-starter | Store and retrieve data from AWS DynamoDB service using AWS SDK version 2.x. | |
| camel-aws2-kinesis-starter | Consume and produce records from and to AWS Kinesis Streams using AWS SDK version 2.x. | |
| camel-aws2-lambda-starter | Manage and invoke AWS Lambda functions using AWS SDK version 2.x. | |
| camel-aws2-s3-starter | Store and retrieve objects from AWS S3 Storage Service using AWS SDK version 2.x. | |
| camel-aws2-sns-starter | Send messages to an AWS Simple Notification Topic using AWS SDK version 2.x. | |
| camel-aws2-sqs-starter | Send and receive messages to/from AWS SQS service using AWS SDK version 2.x. | |
| camel-azure-servicebus-starter | Send and receive messages to/from Azure Event Bus. | |
| camel-azure-storage-blob-starter | Store and retrieve blobs from Azure Storage Blob Service using SDK v12. | |
| camel-azure-storage-queue-starter | The azure-storage-queue component is used for storing and retrieving the messages to/from Azure Storage Queue using Azure SDK v12. | |
| camel-bean-starter | Invoke methods of Java beans stored in Camel registry. | |
| camel-bean-validator-starter | Validate the message body using the Java Bean Validation API. | |
| camel-browse-starter | Inspect the messages received on endpoints supporting BrowsableEndpoint. | |
| camel-cassandraql-starter | Integrate with Cassandra 2.0 using the CQL3 API (not the Thrift API). Based on Cassandra Java Driver provided by DataStax. | |
| camel-controlbus-starter | Manage and monitor Camel routes. | |
| camel-cron-starter | A generic interface for triggering events at times specified through the Unix cron syntax. | |
| camel-cxf-soap-starter | Expose SOAP WebServices using Apache CXF or connect to external WebServices using CXF WS client. | |
| camel-dataformat-starter | Use a Camel Data Format as a regular Camel Component. | |
| camel-dataset-starter | Provide data for load and soak testing of your Camel application. | |
| camel-direct-starter | Call another endpoint from the same Camel Context synchronously. | |
| camel-elasticsearch-starter | Send requests to ElasticSearch via Java Client API. | |
| camel-fhir-starter | Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard. | |
| camel-file-starter | Read and write files. | |
| camel-ftp-starter | Upload and download files to/from FTP servers. | |
| camel-google-bigquery-starter | Google BigQuery data warehouse for analytics. | |
| camel-google-pubsub-starter | Send and receive messages to/from Google Cloud Platform PubSub Service. | |
| camel-http-starter | Send requests to external HTTP servers using Apache HTTP Client 4.x. | |
| camel-infinispan-starter | Read and write from/to Infinispan distributed key/value store and data grid. | |
| camel-jira-starter | Interact with JIRA issue tracker. | |
| camel-jms-starter | Sent and receive messages to/from a JMS Queue or Topic. | |
| camel-jpa-starter | Store and retrieve Java objects from databases using Java Persistence API (JPA). | |
| camel-jslt-starter | Query or transform JSON payloads using an JSLT. | |
| camel-kafka-starter | Sent and receive messages to/from an Apache Kafka broker. | |
| camel-kamelet-starter | To call Kamelets | |
| camel-language-starter | Execute scripts in any of the languages supported by Camel. | |
| camel-log-starter | Log messages to the underlying logging mechanism. | |
| camel-mail-starter | Send and receive emails using imap, pop3 and smtp protocols. | |
| camel-mail-microsoft-oauth-starter | Camel Mail OAuth2 Authenticator for Microsoft Exchange Online | |
| camel-mapstruct-starter | Type Conversion using Mapstruct | |
| camel-master-starter | Have only a single consumer in a cluster consuming from a given endpoint; with automatic failover if the JVM dies. | |
| camel-minio-starter | Store and retrieve objects from Minio Storage Service using Minio SDK. | |
| camel-mllp-starter | Communicate with external systems using the MLLP protocol. | |
| camel-mock-starter | Test routes and mediation rules using mocks. | |
| camel-mongodb-starter | Perform operations on MongoDB documents and collections. | |
| camel-netty-starter | Socket level networking using TCP or UDP with Netty 4.x. | |
| camel-paho-starter | Communicate with MQTT message brokers using Eclipse Paho MQTT Client. | |
| camel-paho-mqtt5-starter | Communicate with MQTT message brokers using Eclipse Paho MQTT v5 Client. | |
| camel-quartz-starter | Schedule sending of messages using the Quartz 2.x scheduler. | |
| camel-ref-starter | Route messages to an endpoint looked up dynamically by name in the Camel Registry. | |
| camel-rest-starter | Expose REST services or call external REST services. | |
| camel-salesforce-starter | Communicate with Salesforce using Java DTOs. | |
| camel-sap-starter | Uses the SAP Java Connector (SAP JCo) library to facilitate bidirectional communication with SAP and the SAP IDoc library to facilitate the transmission of documents in the Intermediate Document (IDoc) format. | |
| camel-scheduler-starter | Generate messages in specified intervals using java.util.concurrent.ScheduledExecutorService. | |
| camel-seda-starter | Asynchronously call another endpoint from any Camel Context in the same JVM. | |
| camel-servlet-starter | Serve HTTP requests by a Servlet. | |
| camel-slack-starter | Send and receive messages to/from Slack. | |
| camel-spring-ws-starter | You can use this component to integrate with Spring Web Services. It offers client-side support for accessing web services and server-side support for creating your contract-first web services. | |
| camel-sql-starter | Perform SQL queries using Spring JDBC. | |
| camel-stub-starter | Stub out any physical endpoints while in development or testing. | |
| camel-telegram-starter | Send and receive messages acting as a Telegram Bot Telegram Bot API. | |
| camel-timer-starter | Generate messages in specified intervals using java.util.Timer. | |
| camel-validator-starter | Validate the payload using XML Schema and JAXP Validation. | |
| camel-webhook-starter | Expose webhook endpoints to receive push notifications for other Camel components. | |
| camel-xslt-starter | Transforms XML payload using an XSLT template. |
| Component | Artifact | Description |
|---|---|---|
| camel-avro-starter | Serialize and deserialize messages using Apache Avro binary data format. | |
| camel-jackson-avro-starter | Marshal POJOs to Avro and back using Jackson. | |
| camel-bindy-starter | Marshal and unmarshal between POJOs and key-value pair (KVP) format using Camel Bindy | |
| camel-hl7-starter | Marshal and unmarshal HL7 (Health Care) model objects using the HL7 MLLP codec. | |
| camel-jacksonxml-starter | Unmarshal a XML payloads to POJOs and back using XMLMapper extension of Jackson. | |
| camel-jaxb-starter | Unmarshal XML payloads to POJOs and back using JAXB2 XML marshalling standard. | |
| camel-gson-starter | Marshal POJOs to JSON and back using Gson | |
| camel-jackson-starter | Marshal POJOs to JSON and back using Jackson | |
| camel-jackson-protobuf-starter | Marshal POJOs to Protobuf and back using Jackson. | |
| camel-soap-starter | Marshal Java objects to SOAP messages and back. | |
| camel-zipfile-starter | Compression and decompress streams using java.util.zip.ZipStream. |
| Language | Artifact | Description |
|---|---|---|
| camel-core-starter | A fixed value set only once during the route startup. | |
| camel-core-starter | Evaluate a compiled simple expression. | |
| camel-core-starter | Gets a property from the Exchange. | |
| camel-core-starter | File related capabilities for the Simple language. | |
| camel-core-starter | Gets a header from the Exchange. | |
| camel-jsonpath-starter | Evaluates a JSONPath expression against a JSON message body. | |
| camel-core-starter | Uses an existing expression from the registry. | |
| camel-core-starter | Evaluates a Camel simple expression. | |
| camel-core-starter | Tokenize text payloads using delimiter patterns. | |
| camel-xml-jaxp-starter | Tokenize XML payloads. | |
| camel-xpath-starter | Evaluates an XPath expression against an XML payload. | |
| camel-saxon-starter | Query and/or transform XML payloads using XQuery and Saxon. |
| Extensions | Artifact | Description |
|---|---|---|
| camel-kamelet-main-starter | Main to run Kamelet standalone | |
| camel-openapi-java-starter | Rest-dsl support for using openapi doc | |
| camel-opentelemetry-starter | Distributed tracing using OpenTelemetry | |
| camel-yaml-dsl-starter | Camel DSL with YAML |
1.4. Starter Configuration Copy linkLink copied to clipboard!
Clear and accessible configuration is a crucial part of any application. Camel starters fully support Spring Boot’s external configuration mechanism. You can also configure them through Spring Beans for more complex use cases.
1.4.1. Using External Configuration Copy linkLink copied to clipboard!
Internally, every starter is configured through Spring Boot’s ConfigurationProperties. Each configuration parameter can be set in various ways (application.[properties|json|yaml] files, command line arguments, environments variables etc.). Parameters have the form of camel.[component|language|dataformat].[name].[parameter]
For example to configure the URL of the MQTT5 broker you can set:
camel.component.paho-mqtt5.broker-url=tcp://localhost:61616
camel.component.paho-mqtt5.broker-url=tcp://localhost:61616
Or to configure the delimeter of the CSV dataformat to be a semicolon(;) you can set:
camel.dataformat.csv.delimiter=;
camel.dataformat.csv.delimiter=;
Camel will use the Type Converter mechanism when setting properties to the desired type.
You can refer to beans in the Registry using the #bean:name:
camel.component.jms.transactionManager=#bean:myjtaTransactionManager
camel.component.jms.transactionManager=#bean:myjtaTransactionManager
The Bean would be typically created in Java:
Beans can also be created in configuration files but this is not recommended for complex use cases.
1.4.2. Using Beans Copy linkLink copied to clipboard!
Starters can also be created and configured via Spring Beans. Before creating a starter , Camel will first lookup it up in the Registry by it’s name if it already exists. For example to configure a Kafka component:
The Bean name has to be equal to that of the Component, Dataformat or Language that you are configuring. If the Bean name isn’t specified in the annotation it will be set to the method name.
Typical Camel Spring Boot projects will use a combination of external configuration and Beans to configure an application. For more examples on how to configure your Camel Spring Boot project, please see the example repository.
1.5. Generating a Camel for Spring Boot application using Maven Copy linkLink copied to clipboard!
You can generate a Camel Spring Boot application using the Maven archetype org.apache.camel.archetypes:camel-archetype-spring-boot:3.20.1.redhat-00064.
Procedure
Run the following command:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Build the application:
mvn package -f csb-app/pom.xml
mvn package -f csb-app/pom.xmlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Run the application:
java -jar csb-app/target/csb-app-1.0-SNAPSHOT.jar
java -jar csb-app/target/csb-app-1.0-SNAPSHOT.jarCopy to Clipboard Copied! Toggle word wrap Toggle overflow Verify that the application is running by examining the console log for the Hello World output which is generated by the application.
com.redhat.MySpringBootApplication : Started MySpringBootApplication in 3.514 seconds (JVM running for 4.006) Hello World Hello World
com.redhat.MySpringBootApplication : Started MySpringBootApplication in 3.514 seconds (JVM running for 4.006) Hello World Hello WorldCopy to Clipboard Copied! Toggle word wrap Toggle overflow
1.6. Deploying a Camel Spring Boot application to OpenShift Copy linkLink copied to clipboard!
This guide demonstrates how to deploy a Camel Spring Boot application to OpenShift.
Prerequisites
- You have access to the OpenShift cluster.
-
The OpenShift
ocCLI client is installed or you have access to the OpenShift Container Platform web console.
The certified OpenShift Container platforms are listed in the Camel for Spring Boot Supported Configurations. The Red Hat OpenJDK 11 (ubi8/openjdk-11) container image is used in the following example.
Procedure
- Generate a Camel for Spring Boot application using Maven by following the instructions in section 1.5 Generating a Camel for Spring Boot application using Maven of this guide.
Under the directory which the modified pom.xml exists, execute the following command.
mvn clean -DskipTests oc:deploy -Popenshift
mvn clean -DskipTests oc:deploy -PopenshiftCopy to Clipboard Copied! Toggle word wrap Toggle overflow Verify that the CSB application is running on the pod.
oc logs -f dc/csb-app
oc logs -f dc/csb-appCopy to Clipboard Copied! Toggle word wrap Toggle overflow
1.7. Applying patch to Camel Spring Boot Copy linkLink copied to clipboard!
Using the new patch-maven-plugin mechanism, you can apply a patch to your Red Hat Camel Spring Boot application. This mechanism allows you to change the individual versions provided by different Red Hat application BOMS, for example, camel-spring-boot-bom.
The purpose of the patch-maven-plugin is to update the versions of the dependencies listed in the Camel on Spring Boot BOM to the versions specified in the patch metadata that you wish to apply to your applications.
The patch-maven-plugin performs the following operations:
- Retrieve the patch metadata related to current Red Hat application BOMs.
- Apply the version changes to <dependencyManagement> imported from the BOMs.
After the patch-maven-plugin fetches the metadata, it iterates through all managed and direct dependencies of the project where the plugin was declared and replaces the dependency versions (if they match) using CVE/patch metadata. After the versions are replaced, the Maven build continues and progresses through standard Maven project stages.
Procedure
The following procedure explains how to apply the patch to your application.
Add
patch-maven-pluginto your project’spom.xmlfile. The version of thepatch-maven-pluginmust be the same as the version of the Camel on Spring Boot BOM.Copy to Clipboard Copied! Toggle word wrap Toggle overflow When you run any of the
mvn clean deploy,mvn validate, ormvn dependency:treecommands, the plugin searches through the project modules to check if the modules use the Red Hat Camel Spring Boot BOM. Only the following is the supported BOM:-
com.redhat.camel.springboot.platform:camel-spring-boot-bom: for Camel Spring Boot BOM
-
If the plugin does not find the above BOM, the plugin displays the following messages:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow If the correct BOM is used, the patch metadata is found, but without any patches.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The
patch-maven-pluginattempts to fetch this Maven metadata.For the projects with Camel Spring Boot BOM, the
com.redhat.camel.springboot.platform:redhat-camel-spring-boot-patch-metadata/maven-metadata.xmlis resolved. This XML data is the metadata for the artifact with thecom.redhat.camel.springboot.platform:redhat-camel-spring-boot-patch-metadata:RELEASEcoordinates.Example metadata generated by Maven
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
The
patch-maven-pluginparses the metadata to select the version which applies to the current project. This action is possible only for the Maven projects using Camel on Spring Boot BOM with the specific version. Only the metadata that matches the version range or later is applicable, and it fetches only the latest version of the metadata. The
patch-maven-plugincollects a list of remote Maven repositories for downloading the patch metadata identified bygroupId,artifactId, andversionfound in previous steps. These Maven repositories are listed in the project’s<repositories>elements in the active profiles, and also the repositories from thesettings.xmlfile.Copy to Clipboard Copied! Toggle word wrap Toggle overflow Whether the metadata comes from a remote repository, local repository, or ZIP file, it is analyzed by the
patch-maven-plugin. The fetched metadata contains a list of CVEs, and for each CVE, we have a list of the affected Maven artifacts (specified by glob patterns and version ranges) together with a version that contains a fix for a given CVE. For example,Copy to Clipboard Copied! Toggle word wrap Toggle overflow Finally a list of fixes specified in patch metadata is consulted when iterating over all managed dependencies in the current project. These dependencies (and managed dependencies) that match are changed to fixed versions. For example:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Skipping the patch
If you do not wish to apply a specific patch to your project, the patch-maven-plugin provides a skip option. Assuming that you have already added the patch-maven-plugin to the project’s pom.xml file, and you do not wish to alter the versions, you can use one of the following method to skip the patch.
-
Add the skip option to your project’s
pom.xmlfile as follows.
-
Or use the
-DskipPatchoption when running themvncommand as follows.
As shown in the above output, the patch-maven-plugin was not invoked, which resulted in the patch not being applied to the application.
1.8. Camel REST DSL OpenApi Maven Plugin Copy linkLink copied to clipboard!
The Camel REST DSL OpenApi Maven Plugin supports the following goals.
- camel-restdsl-openapi:generate - To generate consumer REST DSL RouteBuilder source code from OpenApi specification
- camel-restdsl-openapi:generate-with-dto - To generate consumer REST DSL RouteBuilder source code from OpenApi specification and with DTO model classes generated via the swagger-codegen-maven-plugin.
- camel-restdsl-openapi:generate-xml - To generate consumer REST DSL XML source code from OpenApi specification
- camel-restdsl-openapi:generate-xml-with-dto - To generate consumer REST DSL XML source code from OpenApi specification and with DTO model classes generated via the swagger-codegen-maven-plugin.
- camel-restdsl-openapi:generate-yaml - To generate consumer REST DSL YAML source code from OpenApi specification
- camel-restdsl-openapi:generate-yaml-with-dto - To generate consumer REST DSL YAML source code from OpenApi specification and with DTO model classes generated via the swagger-codegen-maven-plugin.
1.8.1. Adding plugin to Maven pom.xml Copy linkLink copied to clipboard!
This plugin can be added to your Maven pom.xml file by adding it to the plugins section, for example in a Spring Boot application:
The plugin can then be executed using its prefix camel-restdsl-openapi as shown below.
$mvn camel-restdsl-openapi:generate
$mvn camel-restdsl-openapi:generate
1.8.2. camel-restdsl-openapi:generate Copy linkLink copied to clipboard!
The goal of the Camel REST DSL OpenApi Maven Plugin is used to generate REST DSL RouteBuilder implementation source code from Maven.
1.8.3. Options Copy linkLink copied to clipboard!
The plugin supports the following options which can be configured from the command line (use -D syntax), or defined in the pom.xml file in the configuration tag.
| Parameter | Default Value | Description |
|---|---|---|
|
|
|
Set to |
|
|
Used for including only the operation ids specified. Multiple ids can be separated by comma. Wildcards can be used, eg | |
|
|
|
URI of the OpenApi specification, supports filesystem paths, HTTP and classpath resources, by default |
|
| Adds authorization headers when fetching the OpenApi specification definitions remotely. Pass in a URL-encoded string of name:header with a comma separating multiple values. | |
|
|
from |
Name of the generated class, taken from the OpenApi specification title or set to |
|
|
from |
Name of the package for the generated class, taken from the OpenApi specification host value or |
|
|
|
Which indenting character(s) to use, by default four spaces, you can use |
|
|
|
Where to place the generated source file, by default |
|
|
Fully qualified class name of the class that implements | |
|
|
| The default to syntax for the to uri, which is to use the direct component. |
|
|
| Whether to include generation of the rest configuration with detected rest component to be used. |
|
|
Define openapi endpoint path if | |
|
|
| Whether to enable request validation. |
|
| Overrides the api base path as defined in the OpenAPI specification. | |
|
|
| Allows generation of custom RequestMapping mapping values. Multiple mapping values can be passed as:
|
1.8.4. Spring Boot Project with Servlet component Copy linkLink copied to clipboard!
If the Maven project is a Spring Boot project and restConfiguration is enabled and the servlet component is being used as REST component, then this plugin will autodetect the package name (if packageName has not been explicitly configured) where the @SpringBootApplication main class is located, and use the same package name for generating Rest DSL source code and a needed CamelRestController support class.
1.8.5. camel-restdsl-openapi:generate-with-dto Copy linkLink copied to clipboard!
Works as generate goal but also generates DTO model classes by automatic executing the swagger-codegen-maven-plugin to generate java source code of the DTO model classes from the OpenApi specification.
This plugin has been scoped and limited to only support a good effort set of defaults for using the swagger-codegen-maven-plugin to generate the model DTOs. If you need more power and flexibility then use the Swagger Codegen Maven Plugin directly to generate the DTO and not this plugin.
The DTO classes may require additional dependencies such as:
1.8.6. Options Copy linkLink copied to clipboard!
The plugin supports the following additional options
| Parameter | Default Value | Description |
|---|---|---|
|
| 3.0.36 |
The version of the |
|
| Target output path (default is ${project.build.directory}/generated-sources/openapi) | |
|
|
| The package to use for generated model objects/classes |
|
| Sets the pre- or suffix for model classes and enums | |
|
| Sets the pre- or suffix for model classes and enums | |
|
| false | Enable XML annotations inside the generated models (only works with libraries that provide support for JSON and XML) |
|
|
Pass a map of language-specific parameters to |
1.8.7. camel-restdsl-openapi:generate-xml Copy linkLink copied to clipboard!
The camel-restdsl-openapi:generate-xml goal of the Camel REST DSL OpenApi Maven Plugin is used to generate REST DSL XML implementation source code from Maven.
1.8.8. Options Copy linkLink copied to clipboard!
The plugin supports the following options which can be configured from the command line (use -D syntax), or defined in the pom.xml file in the <configuration> tag.
| Parameter | Default Value | Description |
|---|---|---|
|
|
|
Set to |
|
|
Used for including only the operation ids specified. Multiple ids can be separated by comma. Wildcards can be used, eg | |
|
|
|
URI of the OpenApi specification, supports filesystem paths, HTTP and classpath resources, by default |
|
| Adds authorization headers when fetching the OpenApi specification definitions remotely. Pass in a URL-encoded string of name:header with a comma separating multiple values. | |
|
|
|
Where to place the generated source file, by default |
|
|
| The name of the XML file as output. |
|
|
| If enabled generates OSGi Blueprint XML instead of Spring XML. |
|
|
Fully qualified class name of the class that implements | |
|
|
| The default to syntax for the to uri, which is to use the direct component. |
|
|
| |
| Whether to include generation of the rest configuration with detected rest component to be used. |
| |
|
Define openapi endpoint path if |
|
|
| Whether to enable request validation. |
| |
| Overrides the api base path as defined in the OpenAPI specification. |
|
|
1.8.9. camel-restdsl-openapi:generate-xml-with-dto Copy linkLink copied to clipboard!
Works as generate-xml goal but also generates DTO model classes by automatic executing the swagger-codegen-maven-plugin to generate java source code of the DTO model classes from the OpenApi specification.
This plugin has been scoped and limited to only support a good effort set of defaults for using the swagger-codegen-maven-plugin to generate the model DTOs. If you need more power and flexibility then use the Swagger Codegen Maven Plugin directly to generate the DTO and not this plugin.
The DTO classes may require additional dependencies such as:
1.8.10. Options Copy linkLink copied to clipboard!
The plugin supports the following additional options
| Parameter | Default Value | Description |
|---|---|---|
|
| 3.0.36 |
The version of the |
|
| Target output path (default is ${project.build.directory}/generated-sources/openapi) | |
|
|
| The package to use for generated model objects/classes |
|
| Sets the pre- or suffix for model classes and enums | |
|
| Sets the pre- or suffix for model classes and enums | |
|
| false | Enable XML annotations inside the generated models (only works with libraries that provide support for JSON and XML) |
|
|
Pass a map of language-specific parameters to |
1.8.11. camel-restdsl-openapi:generate-yaml Copy linkLink copied to clipboard!
The camel-restdsl-openapi:generate-yaml goal of the Camel REST DSL OpenApi Maven Plugin is used to generate REST DSL YAML implementation source code from Maven.
1.8.12. Options Copy linkLink copied to clipboard!
The plugin supports the following options which can be configured from the command line (use -D syntax), or defined in the pom.xml file in the <configuration> tag.
| Parameter | Default Value | Description |
|---|---|---|
|
|
|
Set to |
|
|
Used for including only the operation ids specified. Multiple ids can be separated by comma. Wildcards can be used, eg | |
|
|
|
URI of the OpenApi specification, supports filesystem paths, HTTP and classpath resources, by default |
|
| Adds authorization headers when fetching the OpenApi specification definitions remotely. Pass in a URL-encoded string of name:header with a comma separating multiple values. | |
|
|
|
Where to place the generated source file, by default |
|
|
| The name of the XML file as output. |
|
|
Fully qualified class name of the class that implements | |
|
|
| The default to syntax for the to uri, which is to use the direct component. |
|
|
| |
| Whether to include generation of the rest configuration with detected rest component to be used. |
| |
|
Define openapi endpoint path if |
|
|
| Whether to enable request validation. |
| |
| Overrides the api base path as defined in the OpenAPI specification. |
|
|
1.8.13. camel-restdsl-openapi:generate-yaml-with-dto Copy linkLink copied to clipboard!
Works as generate-yaml goal but also generates DTO model classes by automatic executing the swagger-codegen-maven-plugin to generate java source code of the DTO model classes from the OpenApi specification.
This plugin has been scoped and limited to only support a good effort set of defaults for using the swagger-codegen-maven-plugin to generate the model DTOs. If you need more power and flexibility then use the Swagger Codegen Maven Plugin directly to generate the DTO and not this plugin.
The DTO classes may require additional dependencies such as:
1.8.14. Options Copy linkLink copied to clipboard!
The plugin supports the following additional options
| Parameter | Default Value | Description |
|---|---|---|
|
| 3.0.36 |
The version of the |
|
| Target output path (default is ${project.build.directory}/generated-sources/openapi) | |
|
|
| The package to use for generated model objects/classes |
|
| Sets the pre- or suffix for model classes and enums | |
|
| Sets the pre- or suffix for model classes and enums | |
|
| false | Enable XML annotations inside the generated models (only works with libraries that provide support for JSON and XML) |
|
|
Pass a map of language-specific parameters to |
1.9. Support for FIPS Compliance Copy linkLink copied to clipboard!
You can install an OpenShift Container Platform cluster that uses FIPS Validated / Modules in Process cryptographic libraries on the x86_64 architecture.
For the Red Hat Enterprise Linux CoreOS (RHCOS) machines in your cluster, this change applies when the machines deploy based on the status of an option in the install-config.yaml file, which governs the cluster options that users can change during cluster deployment. With Red Hat Enterprise Linux (RHEL) machines, you must enable FIPS mode when installing the operating system on the machines you plan to use as worker machines. These configuration methods ensure that your cluster meets the requirements of a FIPS compliance audit. Only FIPS Validated / Modules in Process cryptography packages are enabled before the initial system boot.
Because you must enable FIPS before your cluster’s operating system boots for the first time, you cannot enable FIPS after you deploy a cluster.
1.9.1. FIPS validation in OpenShift Container Platform Copy linkLink copied to clipboard!
OpenShift Container Platform uses certain FIPS Validated / Modules in Process modules within RHEL and RHCOS for its operating system components. For example, when users SSH into OpenShift Container Platform clusters and containers, those connections are properly encrypted.
OpenShift Container Platform components are written in Go and built with Red Hat’s Golang compiler. When you enable FIPS mode for your cluster, all OpenShift Container Platform components that require cryptographic signing call RHEL and RHCOS cryptographic libraries.
For more details about FIPS, see FIPS mode attributes and limitations
For details on deploying Camel Spring Boot on OpenShift, see How to deploy a Camel Spring Boot application to OpenShift?
Details about supported configurations can be found at, Camel for Spring Boot Supported Configurations
Chapter 2. Migrating to Camel Spring Boot Copy linkLink copied to clipboard!
This guide provides information on migrating from Red Hat Fuse 7 to Camel 3 on Spring Boot.
2.1. Java versions Copy linkLink copied to clipboard!
Camel 3 supports Java 17 and Java 11 but not Java 8.
In Java 11 the JAXB modules have been removed from the JDK, therefore you will need to add them as Maven dependencies (if you use JAXB such as when using XML DSL or the camel-jaxb component):
NOTE : The Java Platform, Standard Edition 11 Development Kit (JDK 11) is deprecated in Camel Spring Boot 3.x release version and not supported from the further 4.x release versions.
2.2. Modularization of camel-core Copy linkLink copied to clipboard!
In Camel 3.x, camel-core has been split into many JARs as follows:
- camel-api
- camel-base
- camel-caffeine-lrucache
- camel-cloud
- camel-core
- camel-jaxp
- camel-main
- camel-management-api
- camel-management
- camel-support
- camel-util
- camel-util-json
Maven users of Apache Camel can keep using the dependency camel-core which has transitive dependencies on all of its modules, except for camel-main, and therefore no migration is needed.
2.3. Modularization of Components Copy linkLink copied to clipboard!
In Camel 3.x, some of the camel-core components are moved into individual components.
- camel-attachments
- camel-bean
- camel-browse
- camel-controlbus
- camel-dataformat
- camel-dataset
- camel-direct
- camel-directvm
- camel-file
- camel-language
- camel-log
- camel-mock
- camel-ref
- camel-rest
- camel-saga
- camel-scheduler
- camel-seda
- camel-stub
- camel-timer
- camel-validator
- camel-vm
- camel-xpath
- camel-xslt
- camel-xslt-saxon
- camel-zip-deflater
2.4. Changes to Spring Boot starters Copy linkLink copied to clipboard!
The Maven groupId for the Spring Boot starters is changed from org.apache.camel to org.apache.camel.springboot.
Example
Use:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-component-starter</artifactId> </dependency>
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-component-starter</artifactId>
</dependency>
Instead of
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-component-starter</artifactId> </dependency>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-component-starter</artifactId>
</dependency>
2.5. Multiple CamelContexts per application not supported Copy linkLink copied to clipboard!
Support for multiple CamelContexts has been removed and only one CamelContext per deployment is recommended and supported. The context attribute on the various Camel annotations such as @EndpointInject, @Produce, @Consume etc. has therefore been removed.
2.6. Deprecated APIs and Components Copy linkLink copied to clipboard!
All deprecated APIs and components from Camel 2.x have been removed in Camel 3.
2.6.1. Removed components Copy linkLink copied to clipboard!
All deprecated components from Camel 2.x are removed in Camel 3.x, including the old camel-http, camel-hdfs, camel-mina, camel-mongodb, camel-netty, camel-netty-http, camel-quartz, camel-restlet and camel-rx components.
-
Removed
camel-jibxcomponent. -
Removed
camel-boondataformat. -
Removed the
camel-linkedincomponent as the Linkedin API 1.0 is no longer supported. Support for the new 2.0 API is tracked by CAMEL-13813. -
The
camel-zookeeperhas its route policy functionality removed, instead useZooKeeperClusterServiceor thecamel-zookeeper-mastercomponent. -
The
camel-jettycomponent no longer supports producer (which has been removed), usecamel-httpcomponent instead. -
The
twitter-streamingcomponent has been removed as it relied on the deprecated Twitter Streaming API and is no longer functional.
2.6.2. Renamed components Copy linkLink copied to clipboard!
Following components are renamed in Camel 3.x.
-
The
Camel-microprofile-metricshas been renamed tocamel-micrometer -
The
testcomponent has been renamed todataset-testand moved out ofcamel-coreintocamel-datasetJAR. -
The
http4component has been renamed tohttp, and it’s corresponding component package fromorg.apache.camel.component.http4toorg.apache.camel.component.http. The supported schemes are now onlyhttpandhttps. -
The
hdfs2component has been renamed tohdfs, and it’s corresponding component package fromorg.apache.camel.component.hdfs2toorg.apache.camel.component.hdfs. The supported scheme is nowhdfs. -
The
mina2component has been renamed tomina, and it’s corresponding component package fromorg.apache.camel.component.mina2toorg.apache.camel.component.mina. The supported scheme is nowmina. -
The
mongodb3component has been renamed tomongodb, and it’s corresponding component package fromorg.apache.camel.component.mongodb3toorg.apache.camel.component.mongodb. The supported scheme is nowmongodb. -
The
netty4-httpcomponent has been renamed tonetty-http, and it’s corresponding component package fromorg.apache.camel.component.netty4.httptoorg.apache.camel.component.netty.http. The supported scheme is nownetty-http. -
The
netty4component has been renamed tonetty, and it’s corresponding component package fromorg.apache.camel.component.netty4toorg.apache.camel.component.netty. The supported scheme is nownetty. -
The
quartz2component has been renamed toquartz, and it’s corresponding component package fromorg.apache.camel.component.quartz2toorg.apache.camel.component.quartz. The supported scheme is nowquartz. -
The
rxjava2component has been renamed torxjava, and it’s corresponding component package fromorg.apache.camel.component.rxjava2toorg.apache.camel.component.rxjava. -
Renamed
camel-jetty9tocamel-jetty. The supported scheme is nowjetty.
2.7. Changes to Camel components Copy linkLink copied to clipboard!
2.7.1. Mock component Copy linkLink copied to clipboard!
The mock component has been moved out of camel-core. Because of this a number of methods on its assertion clause builder are removed.
2.7.2. ActiveMQ Copy linkLink copied to clipboard!
If you are using the activemq-camel component, then you should migrate to use camel-activemq component, where the component name has changed from org.apache.activemq.camel.component.ActiveMQComponent to org.apache.camel.component.activemq.ActiveMQComponent.
2.7.3. AWS Copy linkLink copied to clipboard!
The component camel-aws has been split into multiple components:
- camel-aws-cw
- camel-aws-ddb (which contains both ddb and ddbstreams components)
- camel-aws-ec2
- camel-aws-iam
- camel-aws-kinesis (which contains both kinesis and kinesis-firehose components)
- camel-aws-kms
- camel-aws-lambda
- camel-aws-mq
- camel-aws-s3
- camel-aws-sdb
- camel-aws-ses
- camel-aws-sns
- camel-aws-sqs
- camel-aws-swf
It is recommended to add specifc dependencies for these components.
2.7.4. Camel CXF Copy linkLink copied to clipboard!
The camel-cxf JAR has been divided into SOAP vs REST and Spring and non Spring JARs. It is recommended to choose the specific JAR from the following list when migrating from came-cxf.
-
camel-cxf-soap -
camel-cxf-spring-soap -
camel-cxf-rest -
camel-cxf-spring-rest -
camel-cxf-transport -
camel-cxf-spring-transport
For example, if you were using CXF for SOAP and with Spring XML, then select camel-cxf-spring-soap and camel-cxf-spring-transport when migrating from camel-cxf.
When using Spring Boot, choose from the following starter when you migrate from camel-cxf-starter to SOAP or REST:
-
camel-cxf-soap-starter -
camel-cxf-rest-starter
The camel-cxf XML XSD schemas has also changed namespaces.
| Old Namespace | New Namespace |
|---|---|
The camel-cxf SOAP component is moved to a new jaxws sub-package, that is, org.apache.camel.component.cxf is now org.apache.camel.component.cxf.jaws. For example, the CxfComponent class is now located in org.apache.camel.component.cxf.jaxws.
2.7.5. FHIR Copy linkLink copied to clipboard!
The camel-fhir component has upgraded it’s hapi-fhir dependency to 4.1.0. The default FHIR version has been changed to R4. Therefore if DSTU3 is desired it has to be explicitly set.
2.7.6. Kafka Copy linkLink copied to clipboard!
The camel-kafka component has removed the options bridgeEndpoint and circularTopicDetection as this is no longer needed as the component is acting as bridging would work on Camel 2.x. In other words camel-kafka will send messages to the topic from the endpoint uri. To override this use the KafkaConstants.OVERRIDE_TOPIC header with the new topic. See more details in the camel-kafka component documentation.
2.7.7. Telegram Copy linkLink copied to clipboard!
The camel-telegram component has moved the authorization token from uri-path to a query parameter instead, e.g. migrate
telegram:bots/myTokenHere
telegram:bots/myTokenHere
to
telegram:bots?authorizationToken=myTokenHere
telegram:bots?authorizationToken=myTokenHere
2.7.8. JMX Copy linkLink copied to clipboard!
If you run Camel standalone with just camel-core as a dependency, and you want JMX enabled out of the box, then you need to add camel-management as a dependency.
For using ManagedCamelContext you now need to get this extension from CamelContext as follows:
ManagedCamelContext managed = camelContext.getExtension(ManagedCamelContext.class);
ManagedCamelContext managed = camelContext.getExtension(ManagedCamelContext.class);
2.7.9. XSLT Copy linkLink copied to clipboard!
The XSLT component has moved out of camel-core into camel-xslt and camel-xslt-saxon. The component is separated so camel-xslt is for using the JDK XSTL engine (Xalan), and camel-xslt-saxon is when you use Saxon. This means that you should use xslt and xslt-saxon as component name in your Camel endpoint URIs. If you are using XSLT aggregation strategy, then use org.apache.camel.component.xslt.saxon.XsltSaxonAggregationStrategy for Saxon support. And use org.apache.camel.component.xslt.saxon.XsltSaxonBuilder for Saxon support if using xslt builder. Also notice that allowStax is also only supported in camel-xslt-saxon as this is not supported by the JDK XSLT.
2.7.10. XML DSL Migration Copy linkLink copied to clipboard!
The XML DSL has been changed slightly.
The custom load balancer EIP has changed from <custom> to <customLoadBalancer>
The XMLSecurity data format has renamed the attribute keyOrTrustStoreParametersId to keyOrTrustStoreParametersRef in the <secureXML> tag.
The <zipFile> data format has been renamed to <zipfile>.
2.8. Migrating Camel Maven Plugins Copy linkLink copied to clipboard!
The camel-maven-plugin has been split up into two maven plugins:
camel-maven-plugin-
camel-maven-plugin has the
rungoal, which is intended for quickly running Camel applications standalone. See https://camel.apache.org/manual/camel-maven-plugin.html for more information. camel-report-maven-plugin-
The
camel-report-maven-pluginhas thevalidateandroute-coveragegoals which is used for generating reports of your Camel projects such as validating Camel endpoint URIs and route coverage reports, etc. See https://camel.apache.org/manual/camel-report-maven-plugin.html for more information.