Chapter 2. Extensions reference

2.2. Avro
Copy link

Serialize and deserialize messages using Apache Avro binary data format.

2.2.1. What’s inside
Copy link

Avro data format

Please refer to the above link for usage and configuration details.

2.2.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-avro</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-avro</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.2.3. Additional Camel Quarkus configuration
Copy link

Beyond standard usages known from vanilla Camel, Camel Quarkus adds the possibility to parse the Avro schema at build time both in JVM and Native mode.

The approach to generate Avro classes from Avro schema files is the one coined by the quarkus-avro extension. It requires the following:

Store *.avsc files in a folder named src/main/avro or src/test/avro

In addition to the usual build goal of quarkus-maven-plugin, add the generate-code goal:

<plugin>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>generate-code-and-build</id>
            <goals>
                <goal>generate-code</goal>
                <goal>build</goal>
            </goals>
        </execution>
    </executions>
</plugin>

<plugin>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>generate-code-and-build</id>
            <goals>
                <goal>generate-code</goal>
                <goal>build</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Copy to Clipboard

Toggle word wrap

Please see a working configuration in Camel Quarkus Avro integration test and Quarkus Avro integration test.

2.4. AWS 2 DynamoDB
Copy link

Store and retrieve data from AWS DynamoDB service or receive messages from AWS DynamoDB Stream using AWS SDK version 2.x.

2.4.1. What’s inside
Copy link

AWS DynamoDB component, URI syntax: aws2-ddb:tableName
AWS DynamoDB Streams component, URI syntax: aws2-ddbstream:tableName

Please refer to the above links for usage and configuration details.

2.4.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-ddb</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-ddb</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.4.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.4.4. Additional Camel Quarkus configuration
Copy link

2.4.4.1. Optional integration with Quarkus Amazon DynamoDB
Copy link

If desired, it is possible to use the Quarkus Amazon DynamoDB extension in conjunction with Camel Quarkus AWS 2 DynamoDB. Note that this is fully optional and not mandatory at all. Please follow the Quarkus documentation but beware of the following caveats:

The client type apache has to be selected by configuring the following property:
```
quarkus.dynamodb.sync-client.type=apache
```
```
quarkus.dynamodb.sync-client.type=apache
```
Copy to Clipboard Toggle word wrap

The DynamoDbClient has to be "unremovable" in the sense of Quarkus CDI reference so that Camel Quarkus is able to look it up at runtime. You can reach that, for example, by adding a dummy bean injecting DynamoDbClient:

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;

@ApplicationScoped
@Unremovable
class UnremovableDynamoDbClient {
    @Inject
    DynamoDbClient dynamoDbClient;
}

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;

@ApplicationScoped
@Unremovable
class UnremovableDynamoDbClient {
    @Inject
    DynamoDbClient dynamoDbClient;
}

Copy to Clipboard

Toggle word wrap

2.5. AWS 2 Kinesis
Copy link

Consume and produce records from AWS Kinesis Streams using AWS SDK version 2.x.

2.5.1. What’s inside
Copy link

AWS Kinesis component, URI syntax: aws2-kinesis:streamName
AWS Kinesis Firehose component, URI syntax: aws2-kinesis-firehose:streamName

Please refer to the above links for usage and configuration details.

2.5.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-kinesis</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-kinesis</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.5.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.6. AWS 2 Lambda
Copy link

Manage and invoke AWS Lambda functions using AWS SDK version 2.x.

2.6.1. What’s inside
Copy link

AWS Lambda component, URI syntax: aws2-lambda:function

Please refer to the above link for usage and configuration details.

2.6.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-lambda</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-lambda</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.6.3. Camel Quarkus limitations
Copy link

The getAlias and listAliases operations need to be used with pojoRequest in order to work. It implies that the request for those operations should be explicitly constructed by hand as shown below.

Example of creating a getAlias request by hand:

.process(new Processor() {
   public void process(Exchange exchange) {
    GetAliasRequest getAliasRequest = GetAliasRequest.builder().functionName(functionName).name(aliasName).build();
    exchange.getIn().setBody(getAliasRequest);
  }})
.to("aws2-lambda:functionName?operation=getAlias&pojoRequest=true");

.process(new Processor() {
   public void process(Exchange exchange) {
    GetAliasRequest getAliasRequest = GetAliasRequest.builder().functionName(functionName).name(aliasName).build();
    exchange.getIn().setBody(getAliasRequest);
  }})
.to("aws2-lambda:functionName?operation=getAlias&pojoRequest=true");

Copy to Clipboard

Toggle word wrap

Example of creating a listAliases request by hand:

.process(new Processor() {
   public void process(Exchange exchange) {
    ListAliasesRequest listAliasesRequest = ListAliasesRequest.builder().functionName(functionName).build();
    exchange.getIn().setBody(listAliasesRequest);
  }})
.to("aws2-lambda:functionName?operation=listAliases&pojoRequest=true");

.process(new Processor() {
   public void process(Exchange exchange) {
    ListAliasesRequest listAliasesRequest = ListAliasesRequest.builder().functionName(functionName).build();
    exchange.getIn().setBody(listAliasesRequest);
  }})
.to("aws2-lambda:functionName?operation=listAliases&pojoRequest=true");

Copy to Clipboard

Toggle word wrap

2.6.4. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.6.5. Additional Camel Quarkus configuration
Copy link

2.6.5.1. Not possible to leverage quarkus-amazon-lambda by Camel aws2-lambda extension
Copy link

The quarkus-amazon-lambda extension allows you to use Quarkus to build your AWS Lambdas, whereas Camel component manages (deploy, undeploy, …) existing functions. Therefore, it is not possible to use quarkus-amazon-lambda as a client for Camel aws2-lambda extension.

2.7. AWS 2 S3 Storage Service
Copy link

Store and retrieve objects from AWS S3 Storage Service using AWS SDK version 2.x.

2.7.1. What’s inside
Copy link

AWS S3 Storage Service component, URI syntax: aws2-s3://bucketNameOrArn

Please refer to the above link for usage and configuration details.

2.7.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-s3</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-s3</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.7.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.7.4. Additional Camel Quarkus configuration
Copy link

2.7.4.1. Optional integration with Quarkus Amazon S3
Copy link

If desired, it is possible to use the Quarkus Amazon S3 extension in conjunction with Camel Quarkus AWS 2 S3 Storage Service. Note that this is fully optional and not mandatory at all. Please follow the Quarkus documentation but beware of the following caveats:

The client type apache has to be selected by configuring the following property:
```
quarkus.s3.sync-client.type=apache
```
```
quarkus.s3.sync-client.type=apache
```
Copy to Clipboard Toggle word wrap

The S3Client has to be "unremovable" in the sense of Quarkus CDI reference so that Camel Quarkus is able to look it up at runtime. You can reach that, for example, by adding a dummy bean injecting S3Client:

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.s3.S3Client;

@ApplicationScoped
@Unremovable
class UnremovableS3Client {
    @Inject
    S3Client s3Client;
}

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.s3.S3Client;

@ApplicationScoped
@Unremovable
class UnremovableS3Client {
    @Inject
    S3Client s3Client;
}

Copy to Clipboard

Toggle word wrap

Note

If you use the camel-quarkus-aws2-s3 extension to create a download link with Browser Compatibility, you must disable checksum validation explicity to avoid a HTTP 403 Forbidden error when using the HTTP GET request:

quarkus.s3.checksum-validation=false

quarkus.s3.checksum-validation=false

Copy to Clipboard

Toggle word wrap

2.8. AWS 2 Simple Notification System (SNS)
Copy link

Send messages to an AWS Simple Notification Topic using AWS SDK version 2.x.

2.8.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-sns</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-sns</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.8.4. Additional Camel Quarkus configuration
Copy link

2.8.4.1. Optional integration with Quarkus Amazon SNS
Copy link

If desired, it is possible to use the Quarkus Amazon SNS extension in conjunction with Camel Quarkus AWS 2 Simple Notification System (SNS). Note that this is fully optional and not mandatory at all. Please follow the Quarkus documentation but beware of the following caveats:

The client type apache has to be selected by configuring the following property:
```
quarkus.sns.sync-client.type=apache
```
```
quarkus.sns.sync-client.type=apache
```
Copy to Clipboard Toggle word wrap

The SnsClient has to be made "unremovable" in the sense of Quarkus CDI reference so that Camel Quarkus is able to look it up at runtime. You can reach that e.g. by adding a dummy bean injecting SnsClient:

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.sns.SnsClient;

@ApplicationScoped
@Unremovable
class UnremovableSnsClient {
    @Inject
    SnsClient snsClient;
}

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.sns.SnsClient;

@ApplicationScoped
@Unremovable
class UnremovableSnsClient {
    @Inject
    SnsClient snsClient;
}

Copy to Clipboard

Toggle word wrap

2.9. AWS 2 Simple Queue Service (SQS)
Copy link

Sending and receive messages to/from AWS SQS service using AWS SDK version 2.x.

2.9.1. What’s inside
Copy link

AWS Simple Queue Service (SQS) component, URI syntax: aws2-sqs:queueNameOrArn

Please refer to the above link for usage and configuration details.

2.9.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-sqs</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-sqs</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.9.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.9.4. Additional Camel Quarkus configuration
Copy link

2.9.4.1. Optional integration with Quarkus Amazon SQS
Copy link

If desired, it is possible to use the Quarkus Amazon SQS extension in conjunction with Camel Quarkus AWS 2 Simple Queue Service (SQS). Note that this is fully optional and not mandatory at all. Please follow the Quarkus documentation but beware of the following caveats:

The client type apache has to be selected by configuring the following property:
```
quarkus.sqs.sync-client.type=apache
```
```
quarkus.sqs.sync-client.type=apache
```
Copy to Clipboard Toggle word wrap

The SqsClient has to be made "unremovable" in the sense of Quarkus CDI reference so that Camel Quarkus is able to look it up at runtime. You can reach that e.g. by adding a dummy bean injecting SqsClient:

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.sqs.SqsClient;

@ApplicationScoped
@Unremovable
class UnremovableSqsClient {
    @Inject
    SqsClient sqsClient;
}

import javax.enterprise.context.ApplicationScoped;
import io.quarkus.arc.Unremovable;
import software.amazon.awssdk.services.sqs.SqsClient;

@ApplicationScoped
@Unremovable
class UnremovableSqsClient {
    @Inject
    SqsClient sqsClient;
}

Copy to Clipboard

Toggle word wrap

2.10. Azure Storage Blob Service
Copy link

Store and retrieve blobs from Azure Storage Blob Service using SDK v12.

2.10.1. What’s inside
Copy link

Azure Storage Blob Service component, URI syntax: azure-storage-blob:accountName/containerName

Please refer to the above link for usage and configuration details.

2.10.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-azure-storage-blob</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-azure-storage-blob</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.10.3. Usage
Copy link

2.10.3.1. Micrometer metrics support
Copy link

If you wish to enable the collection of Micrometer metrics for the Reactor Netty transports, then you should declare a dependency on quarkus-micrometer to ensure that they are available via the Quarkus metrics HTTP endpoint.

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-micrometer</artifactId>
</dependency>

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-micrometer</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.10.4. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.11. Azure Storage Queue Service
Copy link

The azure-storage-queue component is used for storing and retrieving the messages to/from Azure Storage Queue using Azure SDK v12.

2.11.1. What’s inside
Copy link

Azure Storage Queue Service component, URI syntax: azure-storage-queue:accountName/queueName

Please refer to the above link for usage and configuration details.

2.11.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-azure-storage-queue</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-azure-storage-queue</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.11.3. Usage
Copy link

2.11.3.1. Micrometer metrics support
Copy link

If you wish to enable the collection of Micrometer metrics for the Reactor Netty transports, then you should declare a dependency on quarkus-micrometer to ensure that they are available via the Quarkus metrics HTTP endpoint.

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-micrometer</artifactId>
</dependency>

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-micrometer</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.11.4. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.12. Bean Validator
Copy link

Validate the message body using the Java Bean Validation API.

2.12.1. What’s inside
Copy link

Bean Validator component, URI syntax: bean-validator:label

Please refer to the above link for usage and configuration details.

2.12.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-bean-validator</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-bean-validator</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.12.3. Usage
Copy link

2.12.3.1. Configuring the ValidatorFactory
Copy link

Implementation of this extension leverages the Quarkus Hibernate Validator extension.

Therefore it is not possible to configure the ValidatorFactory by Camel’s properties (constraintValidatorFactory, messageInterpolator, traversableResolver, validationProviderResolver and validatorFactory).

You can configure the ValidatorFactory by the creation of beans which will be injected into the default ValidatorFactory (created by Quarkus). See the Quarkus CDI documentation for more information.

2.12.3.2. Custom validation groups in native mode
Copy link

When using custom validation groups in native mode, all the interfaces need to be registered for reflection (see the documentation).

Example:

@RegisterForReflection
public interface OptionalChecks {
}

@RegisterForReflection
public interface OptionalChecks {
}

Copy to Clipboard

Toggle word wrap

2.12.4. Camel Quarkus limitations
Copy link

It is not possible to describe your constraints as XML (by providing the file META-INF/validation.xml), only Java annotations are supported. This is caused by the limitation of the Quarkus Hibernate Validator extension (see the issue).

2.13. Bean
Copy link

Invoke methods of Java beans

2.13.1. What’s inside
Copy link

Bean component, URI syntax: bean:beanName
Bean Method language
Class component, URI syntax: class:beanName

Please refer to the above links for usage and configuration details.

2.13.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-bean</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-bean</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.13.3. Usage
Copy link

Except for invoking methods of beans available in Camel registry, Bean component and Bean method language can also invoke Quarkus CDI beans.

2.14. Bindy
Copy link

Marshal and unmarshal between POJOs on one side and Comma separated values (CSV), fixed field length or key-value pair (KVP) formats on the other side using Camel Bindy

2.14.1. What’s inside
Copy link

Please refer to the above links for usage and configuration details.

2.14.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-bindy</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-bindy</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.14.3. Camel Quarkus limitations
Copy link

When using camel-quarkus-bindy in native mode, only the build machine’s locale is supported.

For instance, on build machines with french locale, the code below:

BindyDataFormat dataFormat = new BindyDataFormat();
dataFormat.setLocale("ar");

BindyDataFormat dataFormat = new BindyDataFormat();
dataFormat.setLocale("ar");

Copy to Clipboard

Toggle word wrap

formats numbers the arabic way in JVM mode as expected. However, it formats numbers the french way in native mode.

Without further tuning, the build machine’s default locale would be used. Another locale could be specified with the quarkus.native.user-language and quarkus.native.user-country configuration properties.

2.15. Cassandra CQL
Copy link

Integrate with Cassandra 2.0 using the CQL3 API (not the Thrift API). Based on Cassandra Java Driver provided by DataStax.

2.15.1. What’s inside
Copy link

Cassandra CQL component, URI syntax: cql:beanRef:hosts:port/keyspace

Please refer to the above link for usage and configuration details.

2.15.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-cassandraql</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-cassandraql</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.15.3. Additional Camel Quarkus configuration
Copy link

2.15.3.1. Cassandra aggregation repository in native mode
Copy link

In order to use Cassandra aggregation repositories like CassandraAggregationRepository in native mode, you must enable native serialization support.

In addition, if your exchange bodies are custom types, then they must be registered for serialization by annotating their class declaration with @RegisterForReflection(serialization = true).

2.16. Core
Copy link

Camel core functionality and basic Camel languages/ Constant, ExchangeProperty, Header, Ref, Simple and Tokenize

2.16.1. What’s inside
Copy link

Please refer to the above links for usage and configuration details.

2.16.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-core</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-core</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.16.3. Additional Camel Quarkus configuration
Copy link

2.16.3.1. Simple language
Copy link

2.16.3.1.1. Using the OGNL notation
Copy link

When using the OGNL notation from the simple language, the camel-quarkus-bean extension should be used.

For instance, the simple expression below is accessing the getAddress() method on the message body of type Client.

---
simple("${body.address}")
---

---
simple("${body.address}")
---

Copy to Clipboard

Toggle word wrap

In such a situation, one should take an additional dependency on the camel-quarkus-bean extension as described here. Note that in native mode, some classes may need to be registered for reflection. In the example above, the Client class needs to be registered for reflection.

2.16.3.1.2. Using dynamic type resolution in native mode
Copy link

When dynamically resolving a type from simple expressions like:

simple("${mandatoryBodyAs(TYPE)}")
simple("${type:package.Enum.CONSTANT}")
from("…").split(bodyAs(TYPE.class))
simple("${body} is TYPE")

It may be needed to register some classes for reflection manually.

For instance, the simple expression below is dynamically resolving the type java.nio.ByteBuffer at runtime:

---
simple("${body} is 'java.nio.ByteBuffer'")
---

---
simple("${body} is 'java.nio.ByteBuffer'")
---

Copy to Clipboard

Toggle word wrap

As such, the class java.nio.ByteBuffer needs to be registered for reflection.

2.16.3.1.3. Using the simple language with classpath resources in native mode
Copy link

If your route is supposed to load a Simple script from classpath, like in the following example

from("direct:start").transform().simple("resource:classpath:mysimple.txt");

from("direct:start").transform().simple("resource:classpath:mysimple.txt");

Copy to Clipboard

Toggle word wrap

then you need to use Quarkus quarkus.native.resources.includes property to include the resource in the native executable as demonstrated below:

quarkus.native.resources.includes = mysimple.txt

quarkus.native.resources.includes = mysimple.txt

Copy to Clipboard

Toggle word wrap

2.16.3.1.4. Configuring a custom bean via properties in native mode
Copy link

When specifying a custom bean via properties in native mode with configuration like #class:* or #type:*, it may be needed to register some classes for reflection manually.

For instance, the custom bean definition below involves the use of reflection for bean instantiation and setter invocation:

---
camel.beans.customBeanWithSetterInjection = #class:org.example.PropertiesCustomBeanWithSetterInjection
camel.beans.customBeanWithSetterInjection.counter = 123
---

---
camel.beans.customBeanWithSetterInjection = #class:org.example.PropertiesCustomBeanWithSetterInjection
camel.beans.customBeanWithSetterInjection.counter = 123
---

Copy to Clipboard

Toggle word wrap

As such, the class PropertiesCustomBeanWithSetterInjection needs to be registered for reflection, note that field access could be omitted in this case.

Expand

Configuration property	Type	Default
`quarkus.camel.bootstrap.enabled` When set to true, the `CamelRuntime` will be started automatically.	`boolean`	`true`
`quarkus.camel.service.discovery.exclude-patterns` A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will not be discoverable via the `org.apache.camel.spi.FactoryFinder` mechanism. The excludes have higher precedence than includes. The excludes defined here can also be used to veto the discoverability of services included by Camel Quarkus extensions. Example values: `META-INF/services/org/apache/camel/foo/,META-INF/services/org/apache/camel/foo/*/bar`	`string`
`quarkus.camel.service.discovery.include-patterns` A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will be discoverable via the `org.apache.camel.spi.FactoryFinder` mechanism unless the given file is excluded via `exclude-patterns`. Note that Camel Quarkus extensions may include some services by default. The services selected here added to those services and the exclusions defined in `exclude-patterns` are applied to the union set. Example values: `META-INF/services/org/apache/camel/foo/,META-INF/services/org/apache/camel/foo/*/bar`	`string`
`quarkus.camel.service.registry.exclude-patterns` A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will not be added to Camel registry during application’s static initialization. The excludes have higher precedence than includes. The excludes defined here can also be used to veto the registration of services included by Camel Quarkus extensions. Example values: `META-INF/services/org/apache/camel/foo/,META-INF/services/org/apache/camel/foo/*/bar`	`string`
`quarkus.camel.service.registry.include-patterns` A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will be added to Camel registry during application’s static initialization unless the given file is excluded via `exclude-patterns`. Note that Camel Quarkus extensions may include some services by default. The services selected here added to those services and the exclusions defined in `exclude-patterns` are applied to the union set. Example values: `META-INF/services/org/apache/camel/foo/,META-INF/services/org/apache/camel/foo/*/bar`	`string`
`quarkus.camel.runtime-catalog.components` If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel components available in the application; otherwise component JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException. Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.	`boolean`	`true`
`quarkus.camel.runtime-catalog.languages` If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel languages available in the application; otherwise language JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException. Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.	`boolean`	`true`
`quarkus.camel.runtime-catalog.dataformats` If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel data formats available in the application; otherwise data format JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException. Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.	`boolean`	`true`
`quarkus.camel.runtime-catalog-models` If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel EIP models available in the application; otherwise EIP model JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException. Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.	`boolean`	`true`
`quarkus.camel.routes-discovery.enabled` Enable automatic discovery of routes during static initialization.	`boolean`	`true`
`quarkus.camel.routes-discovery.exclude-patterns` Used for exclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to exclude all classes starting with Bar use: */Bar To exclude all routes form a specific package use: com/mycompany/bar/* To exclude all routes form a specific package and its sub-packages use double wildcards: com/mycompany/bar/** And to exclude all routes from two specific packages use: com/mycompany/bar/,com/mycompany/stuff/	`string`
`quarkus.camel.routes-discovery.include-patterns` Used for inclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to include all classes starting with Foo use: */Foo To include all routes form a specific package use: com/mycompany/foo/* To include all routes form a specific package and its sub-packages use double wildcards: com/mycompany/foo/** And to include all routes from two specific packages use: com/mycompany/foo/,com/mycompany/stuff/	`string`
`quarkus.camel.native.resources.exclude-patterns` Replaced by `quarkus.native.resources.excludes` in Camel Quarkus 2.0.0. Using this property throws an exception at build time.	`string`
`quarkus.camel.native.resources.include-patterns` Replaced by `quarkus.native.resources.includes` in Camel Quarkus 2.0.0. Using this property throws an exception at build time.	`string`
`quarkus.camel.native.reflection.exclude-patterns` A comma separated list of Ant-path style patterns to match class names that should be excluded from registering for reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.` and inner classes by dollar sign `$`. This option narrows down the set selected by `include-patterns`. By default, no classes are excluded. This option cannot be used to unregister classes which have been registered internally by Quarkus extensions.	`string`
`quarkus.camel.native.reflection.include-patterns` A comma separated list of Ant-path style patterns to match class names that should be registered for reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.` and inner classes by dollar sign `$`. By default, no classes are included. The set selected by this option can be narrowed down by `exclude-patterns`. Note that Quarkus extensions typically register the required classes for reflection by themselves. This option is useful in situations when the built in functionality is not sufficient. Note that this option enables the full reflective access for constructors, fields and methods. If you need a finer grained control, consider using `io.quarkus.runtime.annotations.RegisterForReflection` annotation in your Java code. For this option to work properly, at least one of the following conditions must be satisfied: - There are no wildcards (`` or `/`) in the patterns - The artifacts containing the selected classes contain a Jandex index (`META-INF/jandex.idx`) - The artifacts containing the selected classes are registered for indexing using the `quarkus.index-dependency.` family of options in `application.properties` - e.g. quarkus.index-dependency.my-dep.group-id = org.my-group quarkus.index-dependency.my-dep.artifact-id = my-artifact where `my-dep` is a label of your choice to tell Quarkus that `org.my-group` and with `my-artifact` belong together.	`string`
`quarkus.camel.native.reflection.serialization-enabled` If `true`, basic classes are registered for serialization; otherwise basic classes won’t be registered automatically for serialization in native mode. The list of classes automatically registered for serialization can be found in CamelSerializationProcessor.BASE_SERIALIZATION_CLASSES. Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `true` except for making the behavior consistent with native mode.	`boolean`	`false`
`quarkus.camel.csimple.on-build-time-analysis-failure` What to do if it is not possible to extract CSimple expressions from a route definition at build time.	`org.apache.camel.quarkus.core.CamelConfig.FailureRemedy`	`warn`
`quarkus.camel.event-bridge.enabled` Whether to enable the bridging of Camel events to CDI events. This allows CDI observers to be configured for Camel events. E.g. those belonging to the `org.apache.camel.quarkus.core.events`, `org.apache.camel.quarkus.main.events` & `org.apache.camel.impl.event` packages. Note that this configuration item only has any effect when observers configured for Camel events are present in the application.	`boolean`	`true`
`quarkus.camel.main.shutdown.timeout` A timeout (with millisecond precision) to wait for `CamelMain#stop()` to finish	`java.time.Duration`	`PT3S`
`quarkus.camel.main.arguments.on-unknown` The action to take when `CamelMain` encounters an unknown argument. fail - Prints the `CamelMain` usage statement and throws a `RuntimeException` ignore - Suppresses any warnings and the application startup proceeds as normal warn - Prints the `CamelMain` usage statement but allows the application startup to proceed as normal	`org.apache.camel.quarkus.core.CamelConfig.FailureRemedy`	`warn`

lock Configuration property fixed at build time. All other configuration properties are overridable at runtime.

2.17. Cron
Copy link

A generic interface for triggering events at times specified through the Unix cron syntax.

2.17.1. What’s inside
Copy link

Cron component, URI syntax: cron:name

Please refer to the above link for usage and configuration details.

2.17.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-cron</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-cron</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.17.3. Additional Camel Quarkus configuration
Copy link

The cron component is a generic interface component, as such Camel Quarkus users will need to use the cron extension together with another extension offering an implementation.

For instance, one can use the Quartz Extension and cron extension together in its project.

2.18. Direct
Copy link

Call another endpoint from the same Camel Context synchronously.

2.18.1. What’s inside
Copy link

Direct component, URI syntax: direct:name

Please refer to the above link for usage and configuration details.

2.18.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-direct</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-direct</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.19. FHIR
Copy link

Exchange information in the healthcare domain using the FHIR (Fast Healthcare Interoperability Resources) standard. Marshall and unmarshall FHIR objects to/from JSON. Marshall and unmarshall FHIR objects to/from XML.

2.19.1. What’s inside
Copy link

FHIR component, URI syntax: fhir:apiName/methodName
FHIR JSon data format
FHIR XML data format

Please refer to the above links for usage and configuration details.

2.19.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-fhir</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-fhir</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.19.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.19.4. Additional Camel Quarkus configuration
Copy link

By default, only FHIR versions R4 & DSTU3 are enabled in native mode, since they are the default values on the FHIR component and DataFormat.

Expand

Configuration property	Type	Default
`quarkus.camel.fhir.enable-dstu2` Enable FHIR DSTU2 Specs in native mode.	`boolean`	`false`
`quarkus.camel.fhir.enable-dstu2_hl7org` Enable FHIR DSTU2_HL7ORG Specs in native mode.	`boolean`	`false`
`quarkus.camel.fhir.enable-dstu2_1` Enable FHIR DSTU2_1 Specs in native mode.	`boolean`	`false`
`quarkus.camel.fhir.enable-dstu3` Enable FHIR DSTU3 Specs in native mode.	`boolean`	`true`
`quarkus.camel.fhir.enable-r4` Enable FHIR R4 Specs in native mode.	`boolean`	`true`
`quarkus.camel.fhir.enable-r5` Enable FHIR R5 Specs in native mode.	`boolean`	`false`

lock Configuration property fixed at build time. All other configuration properties are overridable at runtime.

2.20. File
Copy link

Read and write files.

2.20.1. What’s inside
Copy link

File component, URI syntax: file:directoryName

Please refer to the above link for usage and configuration details.

2.20.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-file</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-file</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.21. FTP
Copy link

Upload and download files to/from SFTP, FTP or SFTP servers

2.21.1. What’s inside
Copy link

FTP component, URI syntax: ftp:host:port/directoryName
FTPS component, URI syntax: ftps:host:port/directoryName
SFTP component, URI syntax: sftp:host:port/directoryName

Please refer to the above links for usage and configuration details.

2.21.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-ftp</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-ftp</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.22. Gson
Copy link

Marshal POJOs to JSON and back using Gson

2.22.1. What’s inside
Copy link

JSON Gson data format

Please refer to the above link for usage and configuration details.

2.22.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-gson</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-gson</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.22.3. Additional Camel Quarkus configuration
Copy link

2.22.3.1. Marshaling/Unmarshaling objects in native mode
Copy link

When marshaling/unmarshaling objects in native mode, all the serialized classes need to be registered for reflection. As such, when using GsonDataFormat.setUnmarshalType(…), GsonDataFormat.setUnmarshalTypeName(…) and even GsonDataFormat.setUnmarshalGenericType(…), the unmarshal type as well as sub field types should be registered for reflection. See a working example in this integration test.

2.23. HL7
Copy link

Marshal and unmarshal HL7 (Health Care) model objects using the HL7 MLLP codec.

2.23.1. What’s inside
Copy link

Please refer to the above links for usage and configuration details.

2.23.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-hl7</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-hl7</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.23.3. Camel Quarkus limitations
Copy link

For MLLP with TCP, Netty is the only supported means of running an Hl7 MLLP listener. Mina is not supported since it has no GraalVM native support at present.

Optional support for HL7MLLPNettyEncoderFactory & HL7MLLPNettyDecoderFactory codecs can be obtained by adding a dependency in your project pom.xml to camel-quarkus-netty.

2.24. HTTP
Copy link

Send requests to external HTTP servers using Apache HTTP Client 4.x.

2.24.1. What’s inside
Copy link

HTTP component, URI syntax: http://httpUri
HTTPS (Secure) component, URI syntax: https://httpUri

Please refer to the above links for usage and configuration details.

2.24.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-http</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-http</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.24.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.24.4. transferException option in native mode
Copy link

To use the transferException option in native mode, you must enable support for object serialization. For more information, refer to the Registering Classes for Serialization section in the Developing Applications with Camel Extensions for Quarkus guide.

You will also need to enable serialization for the exception classes that you intend to serialize. For example.

@RegisterForReflection(targets = { IllegalStateException.class, MyCustomException.class }, serialization = true)

@RegisterForReflection(targets = { IllegalStateException.class, MyCustomException.class }, serialization = true)

Copy to Clipboard

Toggle word wrap

2.24.5. Additional Camel Quarkus configuration
Copy link

your application to send or receive requests using non-default encodings.

your application to send or receive requests using non-default encodings.

Copy to Clipboard

Toggle word wrap

2.25. Infinispan
Copy link

Read and write from/to Infinispan distributed key/value store and data grid.

2.25.1. What’s inside
Copy link

Infinispan component, URI syntax: infinispan:cacheName

Please refer to the above link for usage and configuration details.

2.25.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-infinispan</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-infinispan</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.25.3. Camel Quarkus limitations
Copy link

2.25.3.1. InfinispanRemoteAggregationRepository is unsupported
Copy link

At present the InfinispanRemoteAggregationRepository is not supported. The are some planned future enhancements to make this possible.

2.25.4. Additional Camel Quarkus configuration
Copy link

You can either configure the Infinispan client via the relevant Camel Infinispan component & endpoint options, or you may use the Quarkus Infinispan extension configuration properties.

2.26. Jackson
Copy link

Marshal POJOs to JSON and back using Jackson

2.26.1. What’s inside
Copy link

JSON Jackson data format

Please refer to the above link for usage and configuration details.

2.26.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jackson</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jackson</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.27. JacksonXML
Copy link

Unmarshal a XML payloads to POJOs and back using XMLMapper extension of Jackson.

2.27.1. What’s inside
Copy link

JacksonXML data format

Please refer to the above link for usage and configuration details.

2.27.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jacksonxml</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jacksonxml</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.28. Jira
Copy link

Interact with JIRA issue tracker.

2.28.1. What’s inside
Copy link

Jira component, URI syntax: jira:type

Please refer to the above link for usage and configuration details.

2.28.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jira</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jira</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

Note

Applications using the camel-quarkus-jira extension require an additional Maven repository https://packages.atlassian.com/maven-external/ to be configured either in the Maven settings.xml file or in the pom.xml file of the application project.

2.28.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.29. JMS
Copy link

Sent and receive messages to/from a JMS Queue or Topic.

2.29.1. What’s inside
Copy link

JMS component, URI syntax: jms:destinationType:destinationName

Please refer to the above link for usage and configuration details.

2.29.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jms</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jms</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.29.3. Usage
Copy link

2.29.3.1. Message mapping with org.w3c.dom.Node
Copy link

The Camel JMS component supports message mapping between javax.jms.Message and org.apache.camel.Message. When wanting to convert a Camel message body type of org.w3c.dom.Node, you must ensure that the camel-quarkus-jaxp extension is present on the classpath.

2.29.3.2. Native mode support for javax.jms.ObjectMessage
Copy link

When sending JMS message payloads as javax.jms.ObjectMessage, you must annotate the relevant classes to be registered for serialization with @RegisterForReflection(serialization = true). Note that this extension automatically sets quarkus.camel.native.reflection.serialization-enabled = true for you.

For more information, refer to the Registering Classes for Serialization section in the Developing Applications with Camel Extensions for Quarkus guide.

2.29.4. transferException option in native mode
Copy link

To use the transferException option in native mode, you must enable support for object serialization. For more information, refer to the Registering Classes for Serialization section in the Developing Applications with Camel Extensions for Quarkus guide.

You will also need to enable serialization for the exception classes that you intend to serialize. For example.

@RegisterForReflection(targets = { IllegalStateException.class, MyCustomException.class }, serialization = true)

@RegisterForReflection(targets = { IllegalStateException.class, MyCustomException.class }, serialization = true)

Copy to Clipboard

Toggle word wrap

2.30. JSON Path
Copy link

Evaluate a JSONPath expression against a JSON message body

2.30.1. What’s inside
Copy link

JSONPath language

Please refer to the above link for usage and configuration details.

2.30.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jsonpath</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jsonpath</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.31. JTA
Copy link

Enclose Camel routes in transactions using Java Transaction API (JTA) and Narayana transaction manager

2.31.1. What’s inside
Copy link

JTA

Please refer to the above link for usage and configuration details.

2.31.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jta</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jta</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.31.3. Usage
Copy link

This extension should be added when you need to use the transacted() EIP in the router. It leverages the transaction capabilities provided by the narayana-jta extension in Quarkus.

Refer to the Quarkus Transaction guide for the more details about transaction support. For a simple usage:

from("direct:transaction")
    .transacted()
    .to("sql:INSERT INTO A TABLE ...?dataSource=ds1")
    .to("sql:INSERT INTO A TABLE ...?dataSource=ds2")
    .log("all data are in the ds1 and ds2")

from("direct:transaction")
    .transacted()
    .to("sql:INSERT INTO A TABLE ...?dataSource=ds1")
    .to("sql:INSERT INTO A TABLE ...?dataSource=ds2")
    .log("all data are in the ds1 and ds2")

Copy to Clipboard

Toggle word wrap

Support is provided for various transaction policies.

Expand

Policy	Description
`PROPAGATION_MANDATORY`	Support a current transaction; throw an exception if no current transaction exists.
`PROPAGATION_NEVER`	Do not support a current transaction; throw an exception if a current transaction exists.
`PROPAGATION_NOT_SUPPORTED`	Do not support a current transaction; rather always execute non-transactionally.
`PROPAGATION_REQUIRED`	Support a current transaction; create a new one if none exists.
`PROPAGATION_REQUIRES_NEW`	Create a new transaction, suspending the current transaction if one exists.
`PROPAGATION_SUPPORTS`	Support a current transaction; execute non-transactionally if none exists.

2.32. Kafka
Copy link

Sent and receive messages to/from an Apache Kafka broker.

2.32.1. What’s inside
Copy link

Kafka component, URI syntax: kafka:topic

Please refer to the above link for usage and configuration details.

2.32.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-kafka</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-kafka</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.32.3. Usage
Copy link

2.32.3.1. Quarkus Kafka Dev Services
Copy link

Camel Quarkus Kafka can take advantage of Quarkus Kafka Dev services to simplify development and testing with a local containerized Kafka broker.

Kafka Dev Services is enabled by default in dev & test mode. The Camel Kafka component is automatically configured so that the brokers component option is set to point at the local containerized Kafka broker. Meaning that there’s no need to configure this option yourself.

This functionality can be disabled with the configuration property quarkus.kafka.devservices.enabled=false.

2.32.4. Additional Camel Quarkus configuration
Copy link

Expand

Configuration property Type Default

Configuration property	Type	Default
`quarkus.camel.kafka.kubernetes-service-binding.merge-configuration` If `true` then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension (if configured) will be merged with those set via Camel Kafka component or endpoint options. If `false` then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension are ignored, and all of the Kafka component configuration is driven by Camel.	`boolean`	`true`

quarkus.camel.kafka.kubernetes-service-binding.merge-configuration

If true then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension (if configured) will be merged with those set via Camel Kafka component or endpoint options. If false then any Kafka configuration properties discovered by the Quarkus Kubernetes Service Binding extension are ignored, and all of the Kafka component configuration is driven by Camel.

boolean

true

lock Configuration property fixed at build time. All other configuration properties are overridable at runtime.

2.33. Kamelet
Copy link

Materialize route templates

2.33.1. What’s inside
Copy link

Kamelet component, URI syntax: kamelet:templateId/routeId

Please refer to the above link for usage and configuration details.

2.33.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-kamelet</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-kamelet</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.33.3. Usage
Copy link

2.33.3.1. Pre-load Kamelets at build-time
Copy link

This extension allows to pre-load a set of Kamelets at build time using the quarkus.camel.kamelet.identifiers property.

2.33.3.2. Using the Kamelet Catalog
Copy link

A set of pre-made Kamelets can be found on the /camel-kamelets/latest[Kamelet Catalog]. To use the Kamelet from the catalog you need to copy their yaml definition (that you can find in the camel-kamelet repo) on your project in the classpath. Alternatively you can add the camel-kamelets-catalog artifact to your pom.xml:

<dependency>
    <groupId>org.apache.camel.kamelets</groupId>
    <artifactId>camel-kamelets-catalog</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.kamelets</groupId>
    <artifactId>camel-kamelets-catalog</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

This artifact add all the kamelets available in the catalog to your Camel Quarkus application for build time processing. If you include it with the scope provided the artifact should not be part of the runtime classpath, but at build time, all the kamelets listed via quarkus.camel.kamelet.identifiers property should be preloaded.

2.33.4. Additional Camel Quarkus configuration
Copy link

Expand

Configuration property Type Default

Configuration property	Type	Default
`quarkus.camel.kamelet.identifiers` List of kamelets identifiers to pre-load at build time. Each individual identifier is used to set the related `org.apache.camel.model.RouteTemplateDefinition` id.	`string`

lock quarkus.camel.kamelet.identifiers

List of kamelets identifiers to pre-load at build time. Each individual identifier is used to set the related org.apache.camel.model.RouteTemplateDefinition id.

string

lock Configuration property fixed at build time. All other configuration properties are overridable at runtime.

2.34. Log
Copy link

Log messages to the underlying logging mechanism.

2.34.1. What’s inside
Copy link

Log component, URI syntax: log:loggerName

Please refer to the above link for usage and configuration details.

2.34.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-log</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-log</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.35. Mail
Copy link

Send and receive emails using imap, pop3 and smtp protocols. Marshal Camel messages with attachments into MIME-Multipart messages and back.

2.35.1. What’s inside
Copy link

IMAP component, URI syntax: imap:host:port
IMAPS (Secure) component, URI syntax: imaps:host:port
MIME Multipart data format
POP3 component, URI syntax: pop3:host:port
POP3S component, URI syntax: pop3s:host:port
SMTP component, URI syntax: smtp:host:port
SMTPS component, URI syntax: smtps:host:port

Please refer to the above links for usage and configuration details.

2.35.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mail</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mail</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.36. Microprofile Fault Tolerance
Copy link

Circuit Breaker EIP using Microprofile Fault Tolerance

2.36.1. What’s inside
Copy link

Microprofile Fault Tolerance

Please refer to the above link for usage and configuration details.

2.36.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-microprofile-fault-tolerance</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-microprofile-fault-tolerance</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.37. MicroProfile Health
Copy link

Expose Camel health checks via MicroProfile Health

2.37.1. What’s inside
Copy link

Microprofile Health

Please refer to the above link for usage and configuration details.

2.37.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-microprofile-health</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-microprofile-health</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.37.3. Usage
Copy link

By default, classes extending AbstractHealthCheck are registered as both liveness and readiness checks. You can override the isReadiness method to control this behaviour.

Any checks provided by your application are automatically discovered and bound to the Camel registry. They will be available via the Quarkus health endpoints /q/health/live and /q/health/ready.

You can also provide custom HealthCheckRepository implementations and these are also automatically discovered and bound to the Camel registry for you.

Refer to the Quarkus health guide for further information.

2.37.3.1. Provided health checks
Copy link

Some checks are automatically registered for your application.

2.37.3.1.1. Camel Context Health
Copy link

Inspects the Camel Context status and causes the health check status to be DOWN if the status is anything other than 'Started'.

2.37.3.1.2. Camel Route Health
Copy link

Inspects the status of each route and causes the health check status to be DOWN if any route status is not 'Started'.

2.37.4. Additional Camel Quarkus configuration
Copy link

Expand

Configuration property Type Default

Configuration property	Type	Default
`quarkus.camel.health.enabled` Set whether to enable Camel health checks	`boolean`	`true`

lock quarkus.camel.health.enabled

Set whether to enable Camel health checks

boolean

true

lock Configuration property fixed at build time. All other configuration properties are overridable at runtime.

2.38. MicroProfile Metrics
Copy link

Expose metrics from Camel routes.

2.38.1. What’s inside
Copy link

MicroProfile Metrics component, URI syntax: microprofile-metrics:metricType:metricName

Please refer to the above link for usage and configuration details.

2.38.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-microprofile-metrics</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-microprofile-metrics</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.38.3. Usage
Copy link

The microprofile-metrics component automatically exposes a set of Camel application metrics. Some of these include:

2.38.3.1. Camel Context metrics
Copy link

Expand

Metric Name	Type
`camel.context.status` The status of the Camel Context represented by the `ServiceStatus` enum ordinal	Gauge
`camel.context.uptime` The Camel Context uptime in milliseconds	Gauge
`camel.context.exchanges.completed.total` The total number of completed exchanges	Counter
`camel.context.exchanges.failed.total` The total number of failed exchanges	Counter
`camel.context.exchanges.inflight.total` The total number of inflight exchanges	Gauge
`camel.context.exchanges.total` The total number of all exchanges	Counter
`camel.context.externalRedeliveries.total` The total number of all external redeliveries	Counter
`camel.context.failuresHandled.total` The total number of all failures handled	Counter

2.38.3.2. Camel Route metrics
Copy link

Expand

Metric Name	Type
`camel.route.count` The number of routes	Gauge
`camel.route.running.count` The number of running routes	Gauge
`camel.route.exchanges.completed.total` The total number of completed exchanges for the route	Counter
`camel.route.exchanges.failed.total` The total number of failed exchanges for the route	Counter
`camel.route.exchanges.inflight.total` The total number of inflight exchanges for the route	Gauge
`camel.route.exchanges.total` The total number of all exchanges for the route	Counter
`camel.route.externalRedeliveries.total` The total number of all external redeliveries for the route	Counter
`camel.route.failuresHandled.total` The total number of all failures handled for the route	Counter

All metrics are tagged with the name of the Camel Context and the id of the route where applicable.

You can also produce your own customized metrics in your Camel routes. For more information, refer to the microprofile-metrics component documentation.

Metrics are exposed to Quarkus as application metrics and they can be browsed at http://localhost:8080/q/metrics/application.

2.38.4. Additional Camel Quarkus configuration
Copy link

Expand

Configuration property	Type	Default
`quarkus.camel.metrics.enable-route-policy` Set whether to enable the MicroProfileMetricsRoutePolicyFactory for capturing metrics on route processing times.	`boolean`	`true`
`quarkus.camel.metrics.enable-message-history` Set whether to enable the MicroProfileMetricsMessageHistoryFactory for capturing metrics on individual route node processing times. Depending on the number of configured route nodes, there is the potential to create a large volume of metrics. Therefore, this option is disabled by default.	`boolean`	`false`
`quarkus.camel.metrics.enable-exchange-event-notifier` Set whether to enable the MicroProfileMetricsExchangeEventNotifier for capturing metrics on exchange processing times.	`boolean`	`true`
`quarkus.camel.metrics.enable-route-event-notifier` Set whether to enable the MicroProfileMetricsRouteEventNotifier for capturing metrics on the total number of routes and total number of routes running.	`boolean`	`true`
`quarkus.camel.metrics.enable-camel-context-event-notifier` Set whether to enable the MicroProfileMetricsCamelContextEventNotifier for capturing metrics about the CamelContext, such as status and uptime.	`boolean`	`true`

lock Configuration property fixed at build time. All other configuration properties are overridable at runtime.

2.39. MLLP
Copy link

Communicate with external systems using the MLLP protocol.

2.39.1. What’s inside
Copy link

MLLP component, URI syntax: mllp:hostname:port

Please refer to the above link for usage and configuration details.

2.39.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mllp</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mllp</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.39.3. Additional Camel Quarkus configuration
Copy link

2.40. Mock
Copy link

Test routes and mediation rules using mocks.

2.40.1. What’s inside
Copy link

Mock component, URI syntax: mock:name

Please refer to the above link for usage and configuration details.

2.40.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mock</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mock</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.40.3. Usage
Copy link

To use camel-mock capabilities in tests it is required to get access to MockEndpoint instances.

CDI injection could be used for accessing instances (see Quarkus documentation). You can inject camelContext into test using @Inject annotation. Camel context can be then used for obtaining mock endpoints. See the following example:

import javax.inject.Inject;

import org.apache.camel.CamelContext;
import org.apache.camel.ProducerTemplate;
import org.apache.camel.component.mock.MockEndpoint;
import org.junit.jupiter.api.Test;

import io.quarkus.test.junit.QuarkusTest;

@QuarkusTest
public class MockJvmTest {

    @Inject
    CamelContext camelContext;

    @Inject
    ProducerTemplate producerTemplate;

    @Test
    public void test() throws InterruptedException {

        producerTemplate.sendBody("direct:start", "Hello World");

        MockEndpoint mockEndpoint = camelContext.getEndpoint("mock:result", MockEndpoint.class);
        mockEndpoint.expectedBodiesReceived("Hello World");

        mockEndpoint.assertIsSatisfied();
    }
}

import javax.inject.Inject;

import org.apache.camel.CamelContext;
import org.apache.camel.ProducerTemplate;
import org.apache.camel.component.mock.MockEndpoint;
import org.junit.jupiter.api.Test;

import io.quarkus.test.junit.QuarkusTest;

@QuarkusTest
public class MockJvmTest {

    @Inject
    CamelContext camelContext;

    @Inject
    ProducerTemplate producerTemplate;

    @Test
    public void test() throws InterruptedException {

        producerTemplate.sendBody("direct:start", "Hello World");

        MockEndpoint mockEndpoint = camelContext.getEndpoint("mock:result", MockEndpoint.class);
        mockEndpoint.expectedBodiesReceived("Hello World");

        mockEndpoint.assertIsSatisfied();
    }
}

Copy to Clipboard

Toggle word wrap

Route used for the example test:

import javax.enterprise.context.ApplicationScoped;

import org.apache.camel.builder.RouteBuilder;

@ApplicationScoped
public class MockRoute extends RouteBuilder {

    @Override
    public void configure() throws Exception {
        from("direct:start").to("mock:result");
    }
}

import javax.enterprise.context.ApplicationScoped;

import org.apache.camel.builder.RouteBuilder;

@ApplicationScoped
public class MockRoute extends RouteBuilder {

    @Override
    public void configure() throws Exception {
        from("direct:start").to("mock:result");
    }
}

Copy to Clipboard

Toggle word wrap

2.40.4. Camel Quarkus limitations
Copy link

Injection of CDI beans (described in Usage) does not work in native mode.

In the native mode the test and the application under test are running in two different processes and it is not possible to share a mock bean between them (see Quarkus documentation).

2.41. MongoDB
Copy link

Perform operations on MongoDB documents and collections.

2.41.1. What’s inside
Copy link

MongoDB component, URI syntax: mongodb:connectionBean

Please refer to the above link for usage and configuration details.

2.41.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mongodb</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-mongodb</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.41.3. Additional Camel Quarkus configuration
Copy link

The extension leverages the Quarkus MongoDB Client extension. The Mongo client can be configured via the Quarkus MongoDB Client configuration options.

The Camel Quarkus MongoDB extension automatically registers a MongoDB client bean named camelMongoClient. This can be referenced in the mongodb endpoint URI connectionBean path parameter. For example:

from("direct:start")
.to("mongodb:camelMongoClient?database=myDb&collection=myCollection&operation=findAll")

from("direct:start")
.to("mongodb:camelMongoClient?database=myDb&collection=myCollection&operation=findAll")

Copy to Clipboard

Toggle word wrap

If your application needs to work with multiple MongoDB servers, you can create a "named" client and reference in your route by injecting a client and the related configuration as explained in the Quarkus MongoDB extension client injection. For example:

//application.properties
quarkus.mongodb.mongoClient1.connection-string = mongodb://root:example@localhost:27017/

//application.properties
quarkus.mongodb.mongoClient1.connection-string = mongodb://root:example@localhost:27017/

Copy to Clipboard

Toggle word wrap

//Routes.java

    @ApplicationScoped
    public class Routes extends RouteBuilder {
        @Inject
        @MongoClientName("mongoClient1")
        MongoClient mongoClient1;

        @Override
        public void configure() throws Exception {
            from("direct:defaultServer")
                .to("mongodb:camelMongoClient?database=myDb&collection=myCollection&operation=findAll")

            from("direct:otherServer")
                .to("mongodb:mongoClient1?database=myOtherDb&collection=myOtherCollection&operation=findAll");
        }
    }

//Routes.java

    @ApplicationScoped
    public class Routes extends RouteBuilder {
        @Inject
        @MongoClientName("mongoClient1")
        MongoClient mongoClient1;

        @Override
        public void configure() throws Exception {
            from("direct:defaultServer")
                .to("mongodb:camelMongoClient?database=myDb&collection=myCollection&operation=findAll")

            from("direct:otherServer")
                .to("mongodb:mongoClient1?database=myOtherDb&collection=myOtherCollection&operation=findAll");
        }
    }

Copy to Clipboard

Toggle word wrap

Note that when using named clients, the "default" camelMongoClient bean will still be produced. Refer to the Quarkus documentation on Multiple MongoDB Clients for more information.

2.42. Netty
Copy link

Socket level networking using TCP or UDP with Netty 4.x.

2.42.1. What’s inside
Copy link

Netty component, URI syntax: netty:protocol://host:port

Please refer to the above link for usage and configuration details.

2.42.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-netty</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-netty</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.43. OpenAPI Java
Copy link

Expose OpenAPI resources defined in Camel REST DSL

2.43.1. What’s inside
Copy link

Openapi Java

Please refer to the above link for usage and configuration details.

2.43.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-openapi-java</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-openapi-java</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.43.3. Camel Quarkus limitations
Copy link

The apiContextIdListing configuration option is not supported. Since multiple CamelContext`s are not supported and Quarkus applications run standalone, there is no scenario where attempting to resolve OpenApi specifications for a specific `CamelContext would be useful. It also introduces some additional overhead of requiring JMX (which is not supported in native mode) & additional Camel Quarkus extensions for processing XML.

2.44. Paho
Copy link

Communicate with MQTT message brokers using Eclipse Paho MQTT Client.

2.44.1. What’s inside
Copy link

Paho component, URI syntax: paho:topic

Please refer to the above link for usage and configuration details.

2.44.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-paho</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-paho</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.45. Paho MQTT5
Copy link

Communicate with MQTT message brokers using Eclipse Paho MQTT v5 Client.

2.45.1. What’s inside
Copy link

Paho MQTT 5 component, URI syntax: paho-mqtt5:topic

Please refer to the above link for usage and configuration details.

2.45.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-paho-mqtt5</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-paho-mqtt5</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.46. Platform HTTP
Copy link

This extension allows for creating HTTP endpoints for consuming HTTP requests.

It is built on top of the Eclipse Vert.x HTTP server provided by the quarkus-vertx-http extension.

2.46.1. What’s inside
Copy link

Platform HTTP component, URI syntax: platform-http:path

Please refer to the above link for usage and configuration details.

2.46.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-platform-http</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-platform-http</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.46.3. Usage
Copy link

2.46.3.1. Basic Usage
Copy link

Serve all HTTP methods on the /hello endpoint:

from("platform-http:/hello").setBody(simple("Hello ${header.name}"));

from("platform-http:/hello").setBody(simple("Hello ${header.name}"));

Copy to Clipboard

Toggle word wrap

Serve only GET requests on the /hello endpoint:

from("platform-http:/hello?httpMethodRestrict=GET").setBody(simple("Hello ${header.name}"));

from("platform-http:/hello?httpMethodRestrict=GET").setBody(simple("Hello ${header.name}"));

Copy to Clipboard

Toggle word wrap

2.46.3.2. Using platform-http via Camel REST DSL
Copy link

To be able to use Camel REST DSL with the platform-http component, add camel-quarkus-rest in addition to camel-quarkus-platform-http to your pom.xml:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-rest</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-rest</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

Then you can use the Camel REST DSL:

rest()
    .get("/my-get-endpoint")
        .route()
        .setBody(constant("Hello from /my-get-endpoint"))
        .endRest()
    .post("/my-post-endpoint")
        .route()
        .setBody(constant("Hello from /my-post-endpoint"))
        .endRest();

rest()
    .get("/my-get-endpoint")
        .route()
        .setBody(constant("Hello from /my-get-endpoint"))
        .endRest()
    .post("/my-post-endpoint")
        .route()
        .setBody(constant("Hello from /my-post-endpoint"))
        .endRest();

Copy to Clipboard

Toggle word wrap

2.46.3.3. Handling multipart/form-data file uploads
Copy link

You can restrict the uploads to certain file extensions by white listing them:

from("platform-http:/upload/multipart?fileNameExtWhitelist=html,txt&httpMethodRestrict=POST")
    .to("log:multipart")
    .process(e -> {
        final AttachmentMessage am = e.getMessage(AttachmentMessage.class);
        if (am.hasAttachments()) {
            am.getAttachments().forEach((fileName, dataHandler) -> {
                try (InputStream in = dataHandler.getInputStream()) {
                    // do something with the input stream
                } catch (IOException ioe) {
                    throw new RuntimeException(ioe);
                }
            });
        }
    });

from("platform-http:/upload/multipart?fileNameExtWhitelist=html,txt&httpMethodRestrict=POST")
    .to("log:multipart")
    .process(e -> {
        final AttachmentMessage am = e.getMessage(AttachmentMessage.class);
        if (am.hasAttachments()) {
            am.getAttachments().forEach((fileName, dataHandler) -> {
                try (InputStream in = dataHandler.getInputStream()) {
                    // do something with the input stream
                } catch (IOException ioe) {
                    throw new RuntimeException(ioe);
                }
            });
        }
    });

Copy to Clipboard

Toggle word wrap

2.46.3.4. Securing platform-http endpoints
Copy link

Quarkus provides a variety of security and authentication mechanisms which can be used to secure platform-http endpoints. Refer to the Quarkus Security documentation for further details.

Within a route, it is possible to obtain the authenticated user and its associated SecurityIdentity and Principal:

from("platform-http:/secure")
    .process(e -> {
        Message message = e.getMessage();
        QuarkusHttpUser user = message.getHeader(VertxPlatformHttpConstants.AUTHENTICATED_USER, QuarkusHttpUser.class);
        SecurityIdentity securityIdentity = user.getSecurityIdentity();
        Principal principal = securityIdentity.getPrincipal();
        // Do something useful with SecurityIdentity / Principal. E.g check user roles etc.
    });

from("platform-http:/secure")
    .process(e -> {
        Message message = e.getMessage();
        QuarkusHttpUser user = message.getHeader(VertxPlatformHttpConstants.AUTHENTICATED_USER, QuarkusHttpUser.class);
        SecurityIdentity securityIdentity = user.getSecurityIdentity();
        Principal principal = securityIdentity.getPrincipal();
        // Do something useful with SecurityIdentity / Principal. E.g check user roles etc.
    });

Copy to Clipboard

Toggle word wrap

Also check the quarkus.http.body.* configuration options in Quarkus documentation, esp. quarkus.http.body.handle-file-uploads, quarkus.http.body.uploads-directory and quarkus.http.body.delete-uploaded-files-on-end.

2.46.4. Additional Camel Quarkus configuration
Copy link

2.46.4.1. Platform HTTP server configuration
Copy link

Configuration of the platform HTTP server is managed by Quarkus. Refer to the Quarkus HTTP configuration guide for the full list of configuration options.

To configure SSL for the Platform HTTP server, follow the secure connections with SSL guide. Note that configuring the server for SSL with SSLContextParameters is not currently supported.

2.46.4.2. Character encodings
Copy link

Check the Character Encodings section of the Developing Applications with Camel Extensions for Quarkus guide if you expect your application to send or receive requests using non-default encodings.

2.47. Protobuf Jackson
Copy link

Marshal POJOs to Protobuf and back using Jackson.

2.47.1. What’s inside
Copy link

Protobuf Jackson data format

Please refer to the above link for usage and configuration details.

2.47.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jackson-protobuf</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jackson-protobuf</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.48. Quartz
Copy link

Schedule sending of messages using the Quartz 2.x scheduler.

2.48.1. What’s inside
Copy link

Quartz component, URI syntax: quartz:groupName/triggerName

Please refer to the above link for usage and configuration details.

2.48.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-quartz</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-quartz</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.49. Rest
Copy link

Expose REST services and their OpenAPI Specification or call external REST services.

2.49.1. What’s inside
Copy link

REST component, URI syntax: rest:method:path:uriTemplate
REST API component, URI syntax: rest-api:path

Please refer to the above links for usage and configuration details.

2.49.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-rest</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-rest</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.49.3. Additional Camel Quarkus configuration
Copy link

This extension depends on the Platform HTTP extension and configures it as the component that provides the REST transport.

2.49.3.1. Path parameters containing special characters with platform-http
Copy link

When using the platform-http REST transport, some characters are not allowed within path parameter names. This includes the '-' and '$' characters.

In order to make the below example REST /dashed/param route work correctly, a system property is required io.vertx.web.route.param.extended-pattern=true.

import org.apache.camel.builder.RouteBuilder;

public class CamelRoute extends RouteBuilder {

    @Override
    public void configure() {
        rest("/api")
            // Dash '-' is not allowed by default
            .get("/dashed/param/{my-param}")
            .route()
                .setBody(constant("Hello World"))
            .endRest()

            // The non-dashed path parameter works by default
            .get("/undashed/param/{myParam}")
            .route()
                .setBody(constant("Hello World"))
            .endRest();
    }
}

import org.apache.camel.builder.RouteBuilder;

public class CamelRoute extends RouteBuilder {

    @Override
    public void configure() {
        rest("/api")
            // Dash '-' is not allowed by default
            .get("/dashed/param/{my-param}")
            .route()
                .setBody(constant("Hello World"))
            .endRest()

            // The non-dashed path parameter works by default
            .get("/undashed/param/{myParam}")
            .route()
                .setBody(constant("Hello World"))
            .endRest();
    }
}

Copy to Clipboard

Toggle word wrap

There is some more background to this in the Vert.x Web documentation.

2.49.3.2. Configuring alternate REST transport providers
Copy link

To use another REST transport provider, such as netty-http or servlet, you need to add the respective extension as a dependency to your project and set the provider in your RouteBuilder. E.g. for servlet, you’d have to add the org.apache.camel.quarkus:camel-quarkus-servlet dependency and the set the provider as follows:

import org.apache.camel.builder.RouteBuilder;

public class CamelRoute extends RouteBuilder {

    @Override
    public void configure() {
        restConfiguration()
                .component("servlet");
        ...
    }
}

import org.apache.camel.builder.RouteBuilder;

public class CamelRoute extends RouteBuilder {

    @Override
    public void configure() {
        restConfiguration()
                .component("servlet");
        ...
    }
}

Copy to Clipboard

Toggle word wrap

2.50. Salesforce
Copy link

Communicate with Salesforce using Java DTOs.

2.50.1. What’s inside
Copy link

Salesforce component, URI syntax: salesforce:operationName:topicName

Please refer to the above link for usage and configuration details.

2.50.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-salesforce</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-salesforce</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.50.3. Usage
Copy link

2.50.3.1. Generating Salesforce DTOs with the salesforce-maven-plugin
Copy link

Note

The camel-salesforce-maven-plugin is only covered by community support.

To generate Salesforce DTOs for your project, use the salesforce-maven-plugin. The example code snippet below creates a single DTO for the Account object.

<plugin>
    <groupId>org.apache.camel.maven</groupId>
    <artifactId>camel-salesforce-maven-plugin</artifactId>
    <version>3.14.1</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <clientId>${env.SALESFORCE_CLIENTID}</clientId>
                <clientSecret>${env.SALESFORCE_CLIENTSECRET}</clientSecret>
                <userName>${env.SALESFORCE_USERNAME}</userName>
                <password>${env.SALESFORCE_PASSWORD}</password>
                <loginUrl>https://login.salesforce.com</loginUrl>
                <packageName>org.apache.camel.quarkus.component.salesforce.generated</packageName>
                <outputDirectory>src/main/java</outputDirectory>
                <includes>
                    <include>Account</include>
                </includes>
            </configuration>
        </execution>
    </executions>
</plugin>

<plugin>
    <groupId>org.apache.camel.maven</groupId>
    <artifactId>camel-salesforce-maven-plugin</artifactId>
    <version>3.14.1</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <clientId>${env.SALESFORCE_CLIENTID}</clientId>
                <clientSecret>${env.SALESFORCE_CLIENTSECRET}</clientSecret>
                <userName>${env.SALESFORCE_USERNAME}</userName>
                <password>${env.SALESFORCE_PASSWORD}</password>
                <loginUrl>https://login.salesforce.com</loginUrl>
                <packageName>org.apache.camel.quarkus.component.salesforce.generated</packageName>
                <outputDirectory>src/main/java</outputDirectory>
                <includes>
                    <include>Account</include>
                </includes>
            </configuration>
        </execution>
    </executions>
</plugin>

Copy to Clipboard

Toggle word wrap

2.50.4. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.51. SEDA
Copy link

Asynchronously call another endpoint from any Camel Context in the same JVM.

2.51.1. What’s inside
Copy link

SEDA component, URI syntax: seda:name

Please refer to the above link for usage and configuration details.

2.51.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-seda</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-seda</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.52. Slack
Copy link

Send and receive messages to/from Slack.

2.52.1. What’s inside
Copy link

Slack component, URI syntax: slack:channel

Please refer to the above link for usage and configuration details.

2.52.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-slack</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-slack</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.52.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.53. SOAP dataformat
Copy link

Marshal Java objects to SOAP messages and back.

2.53.1. What’s inside
Copy link

SOAP data format

Please refer to the above link for usage and configuration details.

2.53.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-soap</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-soap</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.54. SQL
Copy link

Perform SQL queries.

2.54.1. What’s inside
Copy link

SQL component, URI syntax: sql:query
SQL Stored Procedure component, URI syntax: sql-stored:template

Please refer to the above links for usage and configuration details.

2.54.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-sql</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-sql</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.54.3. Camel Quarkus limitations
Copy link

Oracle JDBC driver brings some GraalVM native-image configuration that breaks the serialization support in Camel Quarkus and Quarkus in general. See this quarkus issue for more details.

Aggregation repository does not work in native mode with Oracle db, because of this issue.

2.54.4. Additional Camel Quarkus configuration
Copy link

2.54.4.1. Configuring a DataSource
Copy link

This extension leverages Quarkus Agroal for DataSource support. Setting up a DataSource can be achieved via configuration properties.

quarkus.datasource.db-kind=postgresql
quarkus.datasource.username=your-username
quarkus.datasource.password=your-password
quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/your-database
quarkus.datasource.jdbc.max-size=16

quarkus.datasource.db-kind=postgresql
quarkus.datasource.username=your-username
quarkus.datasource.password=your-password
quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/your-database
quarkus.datasource.jdbc.max-size=16

Copy to Clipboard

Toggle word wrap

The Camel SQL component will automatically resolve the DataSource bean from the registry. When configuring multiple datasources, you can specify which one is to be used on an SQL endpoint via the URI options datasource or dataSourceRef. Refer to the SQL component documentation for more details.

2.54.4.1.1. Zero configuration with Quarkus Dev Services
Copy link

In dev and test mode you can take advantage of Configuration Free Databases. The Camel SQL component will be automatically configured to use a DataSource that points to a local containerized instance of the database matching the JDBC driver type that you have selected.

2.54.4.2. SQL scripts
Copy link

When configuring sql or sql-stored endpoints to reference script files from the classpath, set the following configuration property to ensure that they are available in native mode.

quarkus.native.resources.includes = queries.sql, sql/*.sql

quarkus.native.resources.includes = queries.sql, sql/*.sql

Copy to Clipboard

Toggle word wrap

2.54.4.3. SQL aggregation repository in native mode
Copy link

In order to use SQL aggregation repositories like JdbcAggregationRepository in native mode, you must enable native serialization support.

In addition, if your exchange bodies are custom types, they must be registered for serialization by annotating their class declaration with @RegisterForReflection(serialization = true).

2.55. Telegram
Copy link

Send and receive messages acting as a Telegram Bot Telegram Bot API.

2.55.1. What’s inside
Copy link

Telegram component, URI syntax: telegram:type

Please refer to the above link for usage and configuration details.

2.55.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-telegram</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-telegram</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.55.3. SSL in native mode
Copy link

This extension auto-enables SSL support in native mode. Hence you do not need to add quarkus.ssl.native=true to your application.properties yourself. See also Quarkus SSL guide.

2.56. Timer
Copy link

Generate messages in specified intervals using java.util.Timer.

2.56.1. What’s inside
Copy link

Timer component, URI syntax: timer:timerName

Please refer to the above link for usage and configuration details.

2.56.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-timer</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-timer</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.57. XPath
Copy link

Evaluates an XPath expression against an XML payload.

2.57.1. What’s inside
Copy link

XPath language

Please refer to the above link for usage and configuration details.

2.57.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-xpath</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-xpath</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.57.3. Additional Camel Quarkus configuration
Copy link

This component is able to load xpath expressions from classpath resources. To make it work also in native mode, you need to explicitly embed the expression files in the native executable by using the quarkus.native.resources.includes property.

For instance, the route below would load an XPath expression from a classpath resource named myxpath.txt:

from("direct:start").transform().xpath("resource:classpath:myxpath.txt");

from("direct:start").transform().xpath("resource:classpath:myxpath.txt");

Copy to Clipboard

Toggle word wrap

To include this (an possibly other expressions stored in .txt files) in the native image, you would have to add something like the following to your application.properties file:

quarkus.native.resources.includes = *.txt

quarkus.native.resources.includes = *.txt

Copy to Clipboard

Toggle word wrap

2.58. XQuery
Copy link

Query and/or transform XML payloads using XQuery and Saxon.

2.58.1. What’s inside
Copy link

XQuery component, URI syntax: xquery:resourceUri
XQuery language

Please refer to the above links for usage and configuration details.

2.58.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-saxon</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-saxon</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.58.3. Additional Camel Quarkus configuration
Copy link

This component is able to load XQuery definitions from classpath. To make it work also in native mode, you need to explicitly embed the queries in the native executable by using the quarkus.native.resources.includes property.

For instance, the two routes below load an XQuery script from two classpath resources named myxquery.txt and another-xquery.txt respectively:

from("direct:start").transform().xquery("resource:classpath:myxquery.txt", String.class);
from("direct:start").to("xquery:another-xquery.txt");

from("direct:start").transform().xquery("resource:classpath:myxquery.txt", String.class);
from("direct:start").to("xquery:another-xquery.txt");

Copy to Clipboard

Toggle word wrap

To include these (an possibly other queries stored in .txt files) in the native image, you would have to add something like the following to your application.properties file:

quarkus.native.resources.includes = *.txt

quarkus.native.resources.includes = *.txt

Copy to Clipboard

Toggle word wrap

2.59. Zip File
Copy link

Compression and decompress streams using java.util.zip.ZipStream.

2.59.1. What’s inside
Copy link

Zip File data format

Please refer to the above link for usage and configuration details.

2.59.2. Maven coordinates
Copy link

Create a new project with this extension on code.quarkus.redhat.com

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-zipfile</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-zipfile</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

2.1. AttachmentsCopy linkLink copied to clipboard!

2.1.1. What’s insideCopy linkLink copied to clipboard!

2.1.2. Maven coordinatesCopy linkLink copied to clipboard!

2.2. AvroCopy linkLink copied to clipboard!

2.2.1. What’s insideCopy linkLink copied to clipboard!

2.2.2. Maven coordinatesCopy linkLink copied to clipboard!

2.2.3. Additional Camel Quarkus configurationCopy linkLink copied to clipboard!

2.3. Avro JacksonCopy linkLink copied to clipboard!

2.3.1. What’s insideCopy linkLink copied to clipboard!

2.3.2. Maven coordinatesCopy linkLink copied to clipboard!

2.4. AWS 2 DynamoDBCopy linkLink copied to clipboard!

2.4.1. What’s insideCopy linkLink copied to clipboard!

2.4.2. Maven coordinatesCopy linkLink copied to clipboard!

2.4.3. SSL in native modeCopy linkLink copied to clipboard!

2.4.4. Additional Camel Quarkus configurationCopy linkLink copied to clipboard!

2.4.4.1. Optional integration with Quarkus Amazon DynamoDBCopy linkLink copied to clipboard!

2.5. AWS 2 KinesisCopy linkLink copied to clipboard!

2.5.1. What’s insideCopy linkLink copied to clipboard!

2.5.2. Maven coordinatesCopy linkLink copied to clipboard!

2.5.3. SSL in native modeCopy linkLink copied to clipboard!

2.6. AWS 2 LambdaCopy linkLink copied to clipboard!

2.6.1. What’s insideCopy linkLink copied to clipboard!

2.6.2. Maven coordinatesCopy linkLink copied to clipboard!

2.6.3. Camel Quarkus limitationsCopy linkLink copied to clipboard!

2.6.4. SSL in native modeCopy linkLink copied to clipboard!

2.6.5. Additional Camel Quarkus configurationCopy linkLink copied to clipboard!

2.6.5.1. Not possible to leverage quarkus-amazon-lambda by Camel aws2-lambda extensionCopy linkLink copied to clipboard!

2.7. AWS 2 S3 Storage ServiceCopy linkLink copied to clipboard!

2.7.1. What’s insideCopy linkLink copied to clipboard!

2.7.2. Maven coordinatesCopy linkLink copied to clipboard!

2.7.3. SSL in native modeCopy linkLink copied to clipboard!

2.7.4. Additional Camel Quarkus configurationCopy linkLink copied to clipboard!

2.7.4.1. Optional integration with Quarkus Amazon S3Copy linkLink copied to clipboard!

2.8. AWS 2 Simple Notification System (SNS)Copy linkLink copied to clipboard!

2.8.1. What’s insideCopy linkLink copied to clipboard!

2.8.2. Maven coordinatesCopy linkLink copied to clipboard!

2.8.3. SSL in native modeCopy linkLink copied to clipboard!

2.8.4. Additional Camel Quarkus configurationCopy linkLink copied to clipboard!

2.8.4.1. Optional integration with Quarkus Amazon SNSCopy linkLink copied to clipboard!

2.9. AWS 2 Simple Queue Service (SQS)Copy linkLink copied to clipboard!

2.9.1. What’s insideCopy linkLink copied to clipboard!

2.9.2. Maven coordinatesCopy linkLink copied to clipboard!

2.9.3. SSL in native modeCopy linkLink copied to clipboard!

2.9.4. Additional Camel Quarkus configurationCopy linkLink copied to clipboard!

2.9.4.1. Optional integration with Quarkus Amazon SQSCopy linkLink copied to clipboard!

2.10. Azure Storage Blob ServiceCopy linkLink copied to clipboard!

2.10.1. What’s insideCopy linkLink copied to clipboard!

2.10.2. Maven coordinatesCopy linkLink copied to clipboard!

2.10.3. UsageCopy linkLink copied to clipboard!

2.10.3.1. Micrometer metrics supportCopy linkLink copied to clipboard!

2.10.4. SSL in native modeCopy linkLink copied to clipboard!

2.11. Azure Storage Queue ServiceCopy linkLink copied to clipboard!

2.11.1. What’s insideCopy linkLink copied to clipboard!

2.11.2. Maven coordinatesCopy linkLink copied to clipboard!

2.11.3. UsageCopy linkLink copied to clipboard!

2.11.3.1. Micrometer metrics supportCopy linkLink copied to clipboard!

2.11.4. SSL in native modeCopy linkLink copied to clipboard!

2.12. Bean ValidatorCopy linkLink copied to clipboard!

2.12.1. What’s insideCopy linkLink copied to clipboard!

2.12.2. Maven coordinatesCopy linkLink copied to clipboard!

2.12.3. UsageCopy linkLink copied to clipboard!

2.12.3.1. Configuring the ValidatorFactoryCopy linkLink copied to clipboard!

2.12.3.2. Custom validation groups in native modeCopy linkLink copied to clipboard!

2.12.4. Camel Quarkus limitationsCopy linkLink copied to clipboard!

2.13. BeanCopy linkLink copied to clipboard!

2.13.1. What’s insideCopy linkLink copied to clipboard!

2.13.2. Maven coordinatesCopy linkLink copied to clipboard!

2.13.3. UsageCopy linkLink copied to clipboard!

2.14. BindyCopy linkLink copied to clipboard!

2.14.1. What’s insideCopy linkLink copied to clipboard!

2.14.2. Maven coordinatesCopy linkLink copied to clipboard!

2.14.3. Camel Quarkus limitationsCopy linkLink copied to clipboard!

2.15. Cassandra CQLCopy linkLink copied to clipboard!

2.15.1. What’s insideCopy linkLink copied to clipboard!

2.15.2. Maven coordinatesCopy linkLink copied to clipboard!

2.15.3. Additional Camel Quarkus configurationCopy linkLink copied to clipboard!

2.15.3.1. Cassandra aggregation repository in native modeCopy linkLink copied to clipboard!

2.16. CoreCopy linkLink copied to clipboard!

2.16.1. What’s insideCopy linkLink copied to clipboard!

2.1. Attachments
Copy link

2.1.1. What’s inside
Copy link

2.1.2. Maven coordinates
Copy link

2.2. Avro
Copy link

2.2.1. What’s inside
Copy link

2.2.2. Maven coordinates
Copy link

2.2.3. Additional Camel Quarkus configuration
Copy link

2.3. Avro Jackson
Copy link

2.3.1. What’s inside
Copy link

2.3.2. Maven coordinates
Copy link

2.4. AWS 2 DynamoDB
Copy link

2.4.1. What’s inside
Copy link

2.4.2. Maven coordinates
Copy link

2.4.3. SSL in native mode
Copy link

2.4.4. Additional Camel Quarkus configuration
Copy link

2.4.4.1. Optional integration with Quarkus Amazon DynamoDB
Copy link

2.5. AWS 2 Kinesis
Copy link

2.5.1. What’s inside
Copy link

2.5.2. Maven coordinates
Copy link

2.5.3. SSL in native mode
Copy link

2.6. AWS 2 Lambda
Copy link

2.6.1. What’s inside
Copy link

2.6.2. Maven coordinates
Copy link

2.6.3. Camel Quarkus limitations
Copy link

2.6.4. SSL in native mode
Copy link

2.6.5. Additional Camel Quarkus configuration
Copy link

2.6.5.1. Not possible to leverage quarkus-amazon-lambda by Camel aws2-lambda extension
Copy link

2.7. AWS 2 S3 Storage Service
Copy link

2.7.1. What’s inside
Copy link

2.7.2. Maven coordinates
Copy link

2.7.3. SSL in native mode
Copy link

2.7.4. Additional Camel Quarkus configuration
Copy link

2.7.4.1. Optional integration with Quarkus Amazon S3
Copy link

2.8. AWS 2 Simple Notification System (SNS)
Copy link

2.8.1. What’s inside
Copy link

2.8.2. Maven coordinates
Copy link

2.8.3. SSL in native mode
Copy link

2.8.4. Additional Camel Quarkus configuration
Copy link

2.8.4.1. Optional integration with Quarkus Amazon SNS
Copy link

2.9. AWS 2 Simple Queue Service (SQS)
Copy link

2.9.1. What’s inside
Copy link

2.9.2. Maven coordinates
Copy link

2.9.3. SSL in native mode
Copy link

2.9.4. Additional Camel Quarkus configuration
Copy link

2.9.4.1. Optional integration with Quarkus Amazon SQS
Copy link

2.10. Azure Storage Blob Service
Copy link

2.10.1. What’s inside
Copy link

2.10.2. Maven coordinates
Copy link

2.10.3. Usage
Copy link

2.10.3.1. Micrometer metrics support
Copy link

2.10.4. SSL in native mode
Copy link

2.11. Azure Storage Queue Service
Copy link

2.11.1. What’s inside
Copy link

2.11.2. Maven coordinates
Copy link

2.11.3. Usage
Copy link

2.11.3.1. Micrometer metrics support
Copy link

2.11.4. SSL in native mode
Copy link

2.12. Bean Validator
Copy link

2.12.1. What’s inside
Copy link

2.12.2. Maven coordinates
Copy link

2.12.3. Usage
Copy link

2.12.3.1. Configuring the ValidatorFactory
Copy link

2.12.3.2. Custom validation groups in native mode
Copy link

2.12.4. Camel Quarkus limitations
Copy link

2.13. Bean
Copy link

2.13.1. What’s inside
Copy link

2.13.2. Maven coordinates
Copy link

2.13.3. Usage
Copy link

2.14. Bindy
Copy link

2.14.1. What’s inside
Copy link

2.14.2. Maven coordinates
Copy link

2.14.3. Camel Quarkus limitations
Copy link

2.15. Cassandra CQL
Copy link

2.15.1. What’s inside
Copy link

2.15.2. Maven coordinates
Copy link

2.15.3. Additional Camel Quarkus configuration
Copy link

2.15.3.1. Cassandra aggregation repository in native mode
Copy link

2.16. Core
Copy link

2.16.1. What’s inside
Copy link

2.16.2. Maven coordinates
Copy link