Skip to navigation
Skip to main content
Search
Content extracted on:
2026-04-09
Home
Product Documentation
Red Hat Integration
2023.Q1
Camel Spring Boot Reference 3.14
Camel Spring Boot Reference 3.14
Preface
1. AWS CloudWatch
1.1. URI Format
1.2. Configuring Options
1.2.1. Configuring Component Options
1.2.2. Configuring Endpoint Options
1.3. Component Options
1.4. Endpoint Options
1.4.1. Path Parameters (1 parameters)
1.4.2. Query Parameters (16 parameters)
1.5. Usage
1.5.1. Static credentials vs Default Credential Provider
1.5.2. Message headers evaluated by the CW producer
1.5.3. Advanced CloudWatchClient configuration
1.6. Dependencies
1.7. Examples
1.7.1. Producer Example
1.8. Spring Boot Auto-Configuration
2. AWS DynamoDB
2.1. URI Format
2.2. Configuring Options
2.2.1. Configuring Component Options
2.2.2. Configuring Endpoint Options
2.3. Component Options
2.4. Endpoint Options
2.4.1. Path Parameters (1 parameters)
2.4.2. Query Parameters (20 parameters)
2.5. Usage
2.5.1. Static credentials vs Default Credential Provider
2.5.2. Message headers evaluated by the DDB producer
2.5.3. Message headers set during BatchGetItems operation
2.5.4. Message headers set during DeleteItem operation
2.5.5. Message headers set during DeleteTable operation
2.5.6. Message headers set during DescribeTable operation
2.5.7. Message headers set during GetItem operation
2.5.8. Message headers set during PutItem operation
2.5.9. Message headers set during Query operation
2.5.10. Message headers set during Scan operation
2.5.11. Message headers set during UpdateItem operation
2.5.12. Advanced AmazonDynamoDB configuration
2.6. Supported producer operations
2.7. Examples
2.7.1. Producer Examples
2.8. Spring Boot Auto-Configuration
3. AWS Kinesis
3.1. URI Format
3.2. Configuring Options
3.2.1. Configuring Component Options
3.2.2. Configuring Endpoint Options
3.3. Component Options
3.4. Endpoint Options
3.4.1. Path Parameters (1 parameters)
3.4.2. Query Parameters (38 parameters)
3.5. Batch Consumer
3.6. Usage
3.6.1. Static credentials vs Default Credential Provider
3.6.2. Message headers set by the Kinesis consumer
3.6.3. AmazonKinesis configuration
3.6.4. Providing AWS Credentials
3.6.5. Message headers used by the Kinesis producer to write to Kinesis. The producer expects that the message body is a byte[].
3.6.6. Message headers set by the Kinesis producer on successful storage of a Record
3.7. Dependencies
3.8. Spring Boot Auto-Configuration
4. AWS 2 Lambda
4.1. URI Format
4.2. Configuring Options
4.2.1. Configuring Component Options
4.2.2. Configuring Endpoint Options
4.3. Component Options
4.4. Endpoint Options
4.4.1. Path Parameters (1 parameters)
4.4.2. Query Parameters (14 parameters)
4.5. Usage
4.5.1. Static credentials vs Default Credential Provider
4.5.2. Message headers evaluated by the Lambda producer
4.6. List of Avalaible Operations
4.7. Examples
4.7.1. Producer Example
4.7.2. Producer Examples
4.8. Using a POJO as body
4.9. Dependencies
4.10. Spring Boot Auto-Configuration
5. AWS S3 Storage Service
5.1. URI Format
5.2. Configuring Options
5.2.1. Configuring Component Options
5.2.2. Configuring Endpoint Options
5.3. Component Options
5.4. Endpoint Options
5.4.1. Path Parameters (1 parameters)
5.4.2. Query Parameters (68 parameters)
5.5. Batch Consumer
5.6. Usage
5.6.1. Message headers evaluated by the S3 producer
5.6.2. Message headers set by the S3 producer
5.6.3. Message headers set by the S3 consumer
5.6.4. S3 Producer operations
5.6.5. Advanced AmazonS3 configuration
5.6.6. Use KMS with the S3 component
5.6.7. Static credentials vs Default Credential Provider
5.6.8. S3 Producer Operation examples
5.7. Streaming Upload mode
5.8. Bucket Autocreation
5.9. Moving stuff between a bucket and another bucket
5.10. MoveAfterRead consumer option
5.11. Using customer key as encryption
5.12. Using a POJO as body
5.13. Create S3 client and add component to registry
5.14. Dependencies
5.15. Spring Boot Auto-Configuration
6. AWS Simple Notification System (SNS)
6.1. URI Format
6.2. URI Options
6.2.1. Configuring Options
6.2.1.1. Configuring Component Options
6.2.1.2. Configuring Endpoint Options
6.3. Component Options
6.4. Endpoint Options
6.4.1. Path Parameters (1 parameters)
6.4.2. Query Parameters (23 parameters)
6.5. Usage
6.5.1. Static credentials vs Default Credential Provider
6.5.2. Message headers evaluated by the SNS producer
6.5.3. Message headers set by the SNS producer
6.5.4. Advanced AmazonSNS configuration
6.5.5. Create a subscription between an AWS SNS Topic and an AWS SQS Queue
6.6. Topic Autocreation
6.7. SNS FIFO
6.7.1. SNS Fifo Topic Message group Id Strategy and message Deduplication Id Strategy
6.8. Examples
6.8.1. Producer Examples
6.9. Dependencies
6.10. Spring Boot Auto-Configuration
7. AWS Simple Queue Service (SQS)
7.1. URI Format
7.2. Configuring Options
7.2.1. Configuring Component Options
7.2.2. Configuring Endpoint Options
7.3. Component Options
7.4. Endpoint Options
7.4.1. Path Parameters (1 parameters)
7.4.2. Query Parameters (61 parameters)
7.5. Batch Consumer
7.6. Usage
7.6.1. Static credentials vs Default Credential Provider
7.6.2. Message headers set by the SQS producer
7.6.3. Message headers set by the SQS consumer
7.6.4. Advanced AmazonSQS configuration
7.6.5. Creating or updating an SQS Queue
7.6.6. DelayQueue VS Delay for Single message
7.6.7. Server Side Encryption
7.7. JMS-style Selectors
7.8. Available Producer Operations
7.9. Send Message
7.10. Send Batch Message
7.11. Delete single Message
7.12. List Queues
7.13. Purge Queue
7.14. Queue Autocreation
7.15. Send Batch Message and Message Deduplication Strategy
7.16. Dependencies
7.17. Spring Boot Auto-Configuration
8. Azure Storage Blob Service
8.1. URI Format
8.2. Configuring Options
8.2.1. Configuring Component Options
8.2.2. Configuring Endpoint Options
8.3. Component Options
8.4. Endpoint Options
8.4.1. Path Parameters (2 parameters)
8.4.2. Query Parameters (48 parameters)
8.5. Usage
8.5.1. Message headers evaluated by the component producer
8.5.2. Message headers set by either component producer or consumer
8.5.3. Advanced Azure Storage Blob configuration
8.5.4. Automatic detection of BlobServiceClient client in registry
8.5.5. Azure Storage Blob Producer operations
8.5.6. Consumer Examples
8.5.7. Producer Operations Examples
8.5.8. Development Notes (Important)
8.6. Spring Boot Auto-Configuration
9. Azure Storage Queue Service
9.1. URI Format
9.2. Configuring Options
9.2.1. Configuring Component Options
9.2.2. Configuring Endpoint Options
9.3. Component Options
9.4. Endpoint Options
9.4.1. Path Parameters (2 parameters)
9.4.2. Query Parameters (31 parameters)
9.5. Usage
9.5.1. Message headers evaluated by the component producer
9.5.2. Message headers set by either component producer or consumer
9.5.3. Advanced Azure Storage Queue configuration
9.5.4. Automatic detection of QueueServiceClient client in registry
9.5.5. Azure Storage Queue Producer operations
9.5.6. Consumer Examples
9.5.7. Producer Operations Examples
9.5.8. Development Notes (Important)
9.6. Spring Boot Auto-Configuration
10. Bean
10.1. URI format
10.2. Configuring Options
10.2.1. Configuring Component Options
10.2.2. Configuring Endpoint Options
10.3. Component Options
10.4. Endpoint Options
10.4.1. Path Parameters (1 parameters)
10.4.2. Query Parameters (5 parameters)
10.5. Using
10.6. Bean as endpoint
10.7. Java DSL bean syntax
10.8. Bean Binding
10.9. Spring Boot Auto-Configuration
11. Bean Validator
11.1. URI format
11.2. Configuring Options
11.2.1. Configuring Component Options
11.2.2. Configuring Endpoint Options
11.3. Component Options
11.4. Endpoint Options
11.4.1. Path Parameters (1 parameters)
11.4.2. Query Parameters (8 parameters)
11.5. OSGi deployment
11.6. Example
11.7. Spring Boot Auto-Configuration
12. Browse
12.1. URI format
12.2. Configuring Options
12.2.1. Configuring Component Options
12.2.2. Configuring Endpoint Options
12.3. Component Options
12.4. Endpoint Options
12.4.1. Path Parameters (1 parameters)
12.4.2. Query Parameters (4 parameters)
12.5. Sample
12.6. Spring Boot Auto-Configuration
13. Cassandra CQL
13.1. Configuring Options
13.1.1. Configuring Component Options
13.1.2. Configuring Endpoint Options
13.2. Component Options
13.3. Endpoint Options
13.3.1. Path Parameters (4 parameters)
13.3.2. Query Parameters (30 parameters)
13.4. Endpoint Connection Syntax
13.5. Messages
13.5.1. Incoming Message
13.5.2. Outgoing Message
13.6. Repositories
13.7. Idempotent repository
13.8. Aggregation repository
13.9. Examples
13.10. Spring Boot Auto-Configuration
14. Control Bus
14.1. Commands
14.2. Configuring Options
14.2.1. Configuring Component Options
14.2.2. Configuring Endpoint Options
14.3. Component Options
14.4. Endpoint Options
14.4.1. Path Parameters (2 parameters)
14.4.1.1. Query Parameters (6 parameters)
14.5. Using route command
14.6. Getting performance statistics
14.7. Using Simple language
14.8. Spring Boot Auto-Configuration
15. Cron
15.1. Configuring Options
15.1.1. Configuring Component Options
15.1.2. Configuring Endpoint Options
15.2. Component Options
15.3. Endpoint Options
15.3.1. Path Parameters (1 parameters)
15.3.2. Query Parameters (4 parameters)
15.4. Usage
15.5. Spring Boot Auto-Configuration
16. CXF
16.1. URI format
16.2. Configuring Options
16.2.1. Configuring Component Options
16.2.2. Configuring Endpoint Options
16.3. Component Options
16.4. Endpoint Options
16.4.1. Path Parameters (2 parameters)
16.4.2. Query Parameters (35 parameters)
16.4.3. Descriptions of the dataformats
16.4.4. How to enable CXF’s LoggingOutInterceptor in RAW mode
16.4.5. Description of relayHeaders option
16.4.6. Available only in POJO mode
16.5. Configure the CXF endpoints with Spring
16.6. How to make the camel-cxf component use log4j instead of java.util.logging
16.7. How to let camel-cxf response start with xml processing instruction
16.8. How to override the CXF producer address from message header
16.9. How to consume a message from a camel-cxf endpoint in POJO data format
16.10. How to prepare the message for the camel-cxf endpoint in POJO data format
16.11. How to deal with the message for a camel-cxf endpoint in PAYLOAD data format
16.12. How to get and set SOAP headers in POJO mode
16.13. How to get and set SOAP headers in PAYLOAD mode
16.14. SOAP headers are not available in RAW mode
16.15. How to throw a SOAP Fault from Camel
16.16. How to propagate a camel-cxf endpoint’s request and response context
16.17. Attachment Support
16.18. Streaming Support in PAYLOAD mode
16.19. Using the generic CXF Dispatch mode
16.20. Spring Boot Auto-Configuration
17. Data Format
17.1. URI format
17.2. DataFormat Options
17.2.1. Configuring Options
17.2.1.1. Configuring Component Options
17.2.1.2. Configuring Endpoint Options
17.3. Component Options
17.4. Endpoint Options
17.4.1. Path Parameters (2 parameters)
17.4.2. Query Parameters (1 parameters)
17.5. Samples
17.6. Spring Boot Auto-Configuration
18. Dataset
18.1. URI format
18.2. Configuring Options
18.2.1. Configuring Component Options
18.2.2. Configuring Endpoint Options
18.3. Component Options
18.4. Endpoint Options
18.4.1. Path Parameters (1 parameters)
18.4.2. Query Parameters (21 parameters)
18.5. Configuring DataSet
18.6. Example
18.7. DataSetSupport (abstract class)
18.7.1. Properties on DataSetSupport
18.8. SimpleDataSet
18.8.1. Additional Properties on SimpleDataSet
18.9. ListDataSet
18.9.1. Additional Properties on ListDataSet
18.10. FileDataSet
18.10.1. Additional Properties on FileDataSet
18.11. Spring Boot Auto-Configuration
19. Direct
19.1. URI format
19.2. Configuring Options
19.2.1. Configuring Component Options
19.2.2. Configuring Endpoint Options
19.3. Component Options
19.4. Endpoint Options
19.4.1. Path Parameters (1 parameters)
19.4.2. Query Parameters (8 parameters)
19.5. Samples
19.6. Spring Boot Auto-Configuration
20. FHIR
20.1. URI Format
20.2. Configuring Options
20.2.1. Configuring Component Options
20.2.2. Configuring Endpoint Options
20.3. Component Options
20.4. Endpoint Options
20.4.1. Path Parameters (2 parameters)
20.4.2. Query Parameters (44 parameters)
20.5. API Parameters (13 APIs)
20.5.1. API: capabilities
20.5.1.1. Method ofType
20.5.2. API: create
20.5.2.1. Method resource
20.5.3. API: delete
20.5.3.1. Method resource
20.5.3.2. Method resourceById
20.5.3.3. Method resourceConditionalByUrl
20.5.4. API: history
20.5.4.1. Method onInstance
20.5.4.2. Method onServer
20.5.4.3. Method onType
20.5.5. API: load-page
20.5.5.1. Method byUrl
20.5.5.2. Method next
20.5.5.3. Method previous
20.5.6. API: meta
20.5.6.1. Method add
20.5.6.2. Method delete
20.5.6.3. Method getFromResource
20.5.6.4. Method getFromServer
20.5.6.5. Method getFromType
20.5.7. API: operation
20.5.7.1. Method onInstance
20.5.7.2. Method onInstanceVersion
20.5.7.3. Method onServer
20.5.7.4. Method onType
20.5.7.5. Method processMessage
20.5.8. API: patch
20.5.8.1. Method patchById
20.5.8.2. Method patchByUrl
20.5.9. API: read
20.5.9.1. Method resourceById
20.5.9.2. Method resourceByUrl
20.5.10. API: search
20.5.10.1. Method searchByUrl
20.5.11. API: transaction
20.5.11.1. Method withBundle
20.5.11.2. Method withResources
20.5.12. API: update
20.5.12.1. Method resource
20.5.12.2. Method resourceBySearchUrl
20.5.13. API: validate
20.5.13.1. Method resource
20.6. Spring Boot Auto-Configuration
21. File
21.1. URI format
21.2. Configuring Options
21.2.1. Configuring Component Options
21.2.2. Configuring Endpoint Options
21.3. Component Options
21.4. Endpoint Options
21.4.1. Path Parameters (1 parameters)
21.4.2. Query Parameters (94 parameters)
21.5. Move and Delete operations
21.6. Fine grained control over Move and PreMove option
21.7. About moveFailed
21.8. Message Headers
21.8.1. File producer only
21.8.2. File consumer only
21.9. Batch Consumer
21.10. Exchange Properties, file consumer only
21.11. Using charset
21.12. Common gotchas with folder and filenames
21.13. Filename Expression
21.14. Consuming files from folders where others drop files directly
21.15. Using done files
21.16. Writing done files
21.17. Samples
21.17.1. Read from a directory and write to another directory
21.17.2. Read from a directory and write to another directory using a overrule dynamic name
21.17.3. Reading recursively from a directory and writing to another
21.18. Using flatten
21.19. Reading from a directory and the default move operation
21.20. Read from a directory and process the message in java
21.21. Writing to files
21.21.1. Write to subdirectory using Exchange.FILE_NAME
21.21.2. Writing file through the temporary directory relative to the final destination
21.22. Using expression for filenames
21.23. Avoiding reading the same file more than once (idempotent consumer)
21.24. Using a file based idempotent repository
21.25. Using a JPA based idempotent repository
21.26. Filter using org.apache.camel.component.file.GenericFileFilter
21.27. Filtering using ANT path matcher
21.27.1. Sorting using Comparator
21.27.2. Sorting using sortBy
21.28. Using GenericFileProcessStrategy
21.29. Using filter
21.30. Using bridgeErrorHandler
21.31. Debug logging
21.32. Spring Boot Auto-Configuration
22. FTP
22.1. URI format
22.2. Configuring Options
22.2.1. Configuring Component Options
22.2.2. Configuring Endpoint Options
22.3. Component Options
22.4. Endpoint Options
22.4.1. Path Parameters (3 parameters)
22.4.2. Query Parameters (111 parameters)
22.5. FTPS component default trust store
22.6. Examples
22.7. Concurrency
22.8. More information
22.9. Default when consuming files
22.9.1. limitations
22.10. Message Headers
22.10.1. Exchange Properties
22.11. About timeouts
22.12. Using Local Work Directory
22.13. Stepwise changing directories
22.14. Using stepwise=true (default mode)
22.15. Using stepwise=false
22.16. Samples
22.16.1. Consuming a remote FTPS server (implicit SSL) and client authentication
22.16.2. Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration
22.17. Custom filtering
22.18. Filtering using ANT path matcher
22.19. Using a proxy with SFTP
22.20. Setting preferred SFTP authentication method
22.21. Consuming a single file using a fixed name
22.22. Debug logging
22.23. Spring Boot Auto-Configuration
23. HTTP
23.1. URI format
23.2. Configuring Options
23.2.1. Configuring Component Options
23.2.2. Configuring Endpoint Options
23.3. Component Options
23.4. Endpoint Options
23.4.1. Path Parameters (1 parameters)
23.4.2. Query Parameters (51 parameters)
23.5. Message Headers
23.6. Message Body
23.7. Using System Properties
23.8. Response code
23.9. Exceptions
23.10. Which HTTP method will be used
23.11. How to get access to HttpServletRequest and HttpServletResponse
23.12. Configuring URI to call
23.13. Configuring URI Parameters
23.14. How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE) to the HTTP producer
23.15. Using client timeout - SO_TIMEOUT
23.16. Configuring a Proxy
23.16.1. Using proxy settings outside of URI
23.17. Configuring charset
23.17.1. Sample with scheduled poll
23.17.2. URI Parameters from the endpoint URI
23.17.3. URI Parameters from the Message
23.17.4. Getting the Response Code
23.18. Disabling Cookies
23.19. Basic auth with the streaming message body
23.20. Advanced Usage
23.20.1. Setting up SSL for HTTP Client
23.21. Spring Boot Auto-Configuration
24. Infinispan
24.1. URI format
24.2. Configuring Options
24.2.1. Configuring Component Options
24.2.2. Configuring Endpoint Options
24.3. Component Options
24.4. Endpoint Options
24.4.1. Path Parameters (1 parameters)
24.4.2. Query Parameters (26 parameters)
24.5. Camel Operations
24.6. Message Headers
24.7. Examples
24.8. Using the Infinispan based idempotent repository
24.9. Using the Infinispan based aggregation repository
24.10. Spring Boot Auto-Configuration
25. Jira
25.1. URI format
25.2. Configuring Options
25.2.1. Configuring Component Options
25.2.2. Configuring Endpoint Options
25.3. Component Options
25.4. Endpoint Options
25.4.1. Path Parameters (1 parameters)
25.4.2. Query Parameters (16 parameters)
25.5. Client Factory
25.6. Authentication
25.6.1. Basic authentication requirements:
25.6.2. OAuth authentication requirements:
25.7. JQL
25.8. Operations
25.9. AddIssue
25.10. AddComment
25.11. Attach
25.12. DeleteIssue
25.13. TransitionIssue
25.14. UpdateIssue
25.15. Watcher
25.16. WatchUpdates (consumer)
25.17. Spring Boot Auto-Configuration
26. JMS
26.1. URI format
26.1.1. Using ActiveMQ
26.1.2. Transactions and Cache Levels
26.1.3. Durable Subscriptions
26.1.4. Message Header Mapping
26.2. Configuring Options
26.2.1. Configuring Component Options
26.2.2. Configuring Endpoint Options
26.3. Component Options
26.4. Endpoint Options
26.4.1. Path Parameters (2 parameters)
26.4.2. Query Parameters (95 parameters)
26.5. Samples
26.5.1. Receiving from JMS
26.5.2. Sending to JMS
26.5.3. Using Annotations
26.5.4. Spring DSL sample
26.5.5. Other samples
26.5.6. Using JMS as a Dead Letter Queue storing Exchange
26.5.7. Using JMS as a Dead Letter Channel storing error only
26.6. Message Mapping between JMS and Camel
26.6.1. Disabling auto-mapping of JMS messages
26.6.2. Using a custom MessageConverter
26.6.3. Controlling the mapping strategy selected
26.7. Message format when sending
26.8. Message format when receiving
26.9. About using Camel to send and receive messages and JMSReplyTo
26.9.1. JmsProducer
26.9.2. JmsConsumer
26.10. Reuse endpoint and send to different destinations computed at runtime
26.11. Configuring different JMS providers
26.11.1. Using JNDI to find the ConnectionFactory
26.12. Concurrent Consuming
26.12.1. Concurrent Consuming with async consumer
26.13. Request-reply over JMS
26.13.1. Request-reply over JMS and using a shared fixed reply queue
26.13.2. Request-reply over JMS and using an exclusive fixed reply queue
26.14. Synchronizing clocks between senders and receivers
26.15. About time to live
26.16. Enabling Transacted Consumption
26.17. Using JMSReplyTo for late replies
26.18. Using a request timeout
26.19. Sending an InOnly message and keeping the JMSReplyTo header
26.20. Setting JMS provider options on the destination
26.21. Spring Boot Auto-Configuration
27. Kafka
27.1. URI format
27.2. Configuring Options
27.2.1. Configuring Component Options
27.2.2. Configuring Endpoint Options
27.3. Component Options
27.4. Endpoint Options
27.4.1. Path Parameters (1 parameters)
27.4.2. Query Parameters (102 parameters)
27.5. Message headers
27.5.1. Consumer headers
27.5.2. Producer headers
27.6. Consumer error handling
27.7. Samples
27.7.1. Consuming messages from Kafka
27.7.2. Producing messages to Kafka
27.8. SSL configuration
27.9. Using the Kafka idempotent repository
27.10. Using manual commit with Kafka consumer
27.11. Kafka Headers propagation
27.12. Spring Boot Auto-Configuration
28. Kamelet
28.1. URI format
28.2. Configuring Options
28.2.1. Configuring Component Options
28.2.2. Configuring Endpoint Options
28.3. Component Options
28.4. Endpoint Options
28.4.1. Path Parameters (2 parameters)
28.4.2. Query Parameters (8 parameters)
28.5. Discovery
28.6. Samples
28.7. Spring Boot Auto-Configuration
29. Language
29.1. URI format
29.2. Configuring Options
29.2.1. Configuring Component Options
29.2.2. Configuring Endpoint Options
29.3. Component Options
29.4. Endpoint Options
29.4.1. Path Parameters (2 parameters)
29.4.2. Query Parameters (7 parameters)
29.5. Message Headers
29.6. Examples
29.7. Loading scripts from resources
29.8. Spring Boot Auto-Configuration
30. Log
30.1. URI format
30.2. Configuring Options
30.2.1. Configuring Component Options
30.2.2. Configuring Endpoint Options
30.3. Component Options
30.4. Endpoint Options
30.4.1. Path Parameters (1 parameters)
30.4.2. Query Parameters (27 parameters)
30.5. Regular logger sample
30.6. Regular logger with formatter sample
30.7. Throughput logger with groupSize sample
30.8. Throughput logger with groupInterval sample
30.9. Masking sensitive information like password
30.10. Full customization of the logging output
30.10.1. Convention over configuration
30.11. Spring Boot Auto-Configuration
31. Mail
31.1. URI format
31.2. Configuring Options
31.2.1. Configuring Component Options
31.2.2. Configuring Endpoint Options
31.3. Component Options
31.4. Endpoint Options
31.4.1. Path Parameters (2 parameters)
31.4.2. Query Parameters (66 parameters)
31.4.3. Sample endpoints
31.4.4. Component alias names
31.4.5. Default ports
31.5. SSL support
31.5.1. Using the JSSE Configuration Utility
31.5.2. Configuring JavaMail Directly
31.6. Mail Message Content
31.7. Headers take precedence over pre-configured recipients
31.8. Multiple recipients for easier configuration
31.9. Setting sender name and email
31.10. JavaMail API (ex SUN JavaMail)
31.11. Samples
31.12. Sending mail with attachment sample
31.13. SSL sample
31.14. Consuming mails with attachment sample
31.15. How to split a mail message with attachments
31.16. Using custom SearchTerm
31.17. Polling Optimization
31.18. Using headers with additional Java Mail Sender properties
31.19. Spring Boot Auto-Configuration
32. Master
32.1. Using the master endpoint
32.2. URI format
32.3. Configuring Options
32.3.1. Configuring Component Options
32.3.2. Configuring Endpoint Options
32.4. Component Options
32.5. Endpoint Options
32.5.1. Path Parameters (2 parameters)
32.5.2. Query Parameters (3 parameters)
32.6. Example
32.7. Implementations
32.8. Spring Boot Auto-Configuration
33. MLLP
33.1. Configuring Options
33.1.1. Configuring Component Options
33.1.2. Configuring Endpoint Options
33.2. Component Options
33.3. Endpoint Options
33.3.1. Path Parameters (2 parameters)
33.3.2. Query Parameters (26 parameters)
33.4. MLLP Consumer
33.4.1. Message Headers
33.4.2. Exchange Properties
33.5. MLLP Producer
33.5.1. Message Headers
33.5.2. Exchange Properties
33.6. Spring Boot Auto-Configuration
34. Mock
34.1. URI format
34.2. Configuring Options
34.2.1. Configuring Component Options
34.2.2. Configuring Endpoint Options
34.3. Component Options
34.4. Endpoint Options
34.4.1. Path Parameters (1 parameters)
34.4.2. Query Parameters (12 parameters)
34.5. Simple Example
34.6. Using assertPeriod
34.7. Setting expectations
34.8. Adding expectations to specific messages
34.9. Mocking existing endpoints
34.10. Mocking existing endpoints using the camel-test component
34.11. Mocking existing endpoints with XML DSL
34.12. Mocking endpoints and skip sending to original endpoint
34.13. Limiting the number of messages to keep
34.14. Testing with arrival times
34.15. Spring Boot Auto-Configuration
35. MongoDB
35.1. URI format
35.2. Configuring Options
35.2.1. Configuring Component Options
35.2.2. Configuring Endpoint Options
35.3. Component Options
35.4. Endpoint Options
35.4.1. Path Parameters (1 parameters)
35.4.2. Query Parameters (27 parameters)
35.5. Configuration of database in Spring XML
35.6. Sample route
35.7. MongoDB operations - producer endpoints
35.7.1. Query operations
35.7.1.1. findById
35.7.1.2. findOneByQuery
35.7.1.3. Example without a query selector (returns the first document in a collection)
35.7.1.4. Example with a query selector (returns the first matching document in a collection):
35.7.1.5. findAll
35.7.1.5.1. Example without a query selector (returns all documents in a collection)
35.7.1.5.2. Example with a query selector (returns all matching documents in a collection)
35.7.1.5.3. Example with option outputType=MongoIterable and batch size
35.7.1.6. count
35.7.1.7. Specifying a fields filter (projection)
35.7.1.8. Specifying a sort clause
35.7.2. Create/update operations
35.7.2.1. insert
35.7.2.2. save
35.7.2.3. update
35.7.3. Delete operations
35.7.3.1. remove
35.7.4. Bulk Write Operations
35.7.4.1. bulkWrite
35.7.5. Other operations
35.7.5.1. aggregate
35.7.5.2. getDbStats
35.7.5.3. getColStats
35.7.5.4. command
35.7.6. Dynamic operations
35.8. Consumers
35.8.1. Tailable Cursor Consumer
35.9. How the tailable cursor consumer works
35.10. Persistent tail tracking
35.11. Enabling persistent tail tracking
35.11.1. Change Streams Consumer
35.12. Type conversions
35.13. Spring Boot Auto-Configuration
36. Netty
36.1. URI format
36.2. Configuring Options
36.2.1. Configuring Component Options
36.2.2. Configuring Endpoint Options
36.3. Component Options
36.4. Endpoint Options
36.4.1. Path Parameters (3 parameters)
36.4.2. Query Parameters (71 parameters)
36.5. Registry based Options
36.5.1. Using non shareable encoders or decoders
36.6. Sending Messages to/from a Netty endpoint
36.6.1. Netty Producer
36.6.2. Netty Consumer
36.7. Examples
36.7.1. A UDP Netty endpoint using Request-Reply and serialized object payload
36.7.2. A TCP based Netty consumer endpoint using One-way communication
36.7.3. An SSL/TCP based Netty consumer endpoint using Request-Reply communication
36.7.4. Using Multiple Codecs
36.8. Closing Channel When Complete
36.9. Custom pipeline
36.9.1. Using custom pipeline factory
36.10. Reusing Netty boss and worker thread pools
36.11. Multiplexing concurrent messages over a single connection with request/reply
36.12. Spring Boot Auto-Configuration
37. Paho
37.1. URI format
37.2. Configuring Options
37.2.1. Configuring Component Options
37.2.2. Configuring Endpoint Options
37.3. Component Options
37.4. Endpoint Options
37.4.1. Path Parameters (1 parameters)
37.4.2. Query Parameters (31 parameters)
37.5. Headers
37.6. Default payload type
37.7. Samples
37.8. Spring Boot Auto-Configuration
38. Paho MQTT 5
38.1. URI format
38.2. Configuring Options
38.2.1. Configuring Component Options
38.2.2. Configuring Endpoint Options
38.3. Component Options
38.4. Endpoint Options
38.4.1. Path Parameters (1 parameters)
38.4.2. Query Parameters (32 parameters)
38.5. Headers
38.6. Default payload type
38.7. Samples
38.8. Spring Boot Auto-Configuration
39. Quartz
39.1. URI format
39.2. Configuring Options
39.2.1. Configuring Component Options
39.2.2. Configuring Endpoint Options
39.3. Component Options
39.4. Endpoint Options
39.4.1. Path Parameters (2 parameters)
39.4.2. Query Parameters (17 parameters)
39.4.3. Configuring quartz.properties file
39.5. Enabling Quartz scheduler in JMX
39.6. Starting the Quartz scheduler
39.7. Clustering
39.8. Message Headers
39.9. Using Cron Triggers
39.10. Specifying time zone
39.11. Configuring misfire instructions
39.11.1. SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW = 1 (default)
39.11.2. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT = 2
39.11.3. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT = 3
39.11.4. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT = 4
39.11.5. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT = 5
39.11.6. CronTrigger.MISFIRE_INSTRUCTION_FIRE_ONCE_NOW = 1 (default)
39.11.7. CronTrigger.MISFIRE_INSTRUCTION_DO_NOTHING = 2
39.12. Using QuartzScheduledPollConsumerScheduler
39.13. Cron Component Support
39.14. Spring Boot Auto-Configuration
40. Ref
40.1. URI format
40.2. Configuring Options
40.2.1. Configuring Component Options
40.2.2. Configuring Endpoint Options
40.3. Component Options
40.4. Endpoint Options
40.4.1. Path Parameters (1 parameters)
40.4.2. Query Parameters (4 parameters)
40.5. Runtime lookup
40.6. Sample
40.7. Spring Boot Auto-Configuration
41. REST
41.1. URI format
41.2. Configuring Options
41.2.1. Configuring Component Options
41.2.2. Configuring Endpoint Options
41.3. Component Options
41.4. Endpoint Options
41.4.1. Path Parameters (3 parameters)
41.4.2. Query Parameters (16 parameters)
41.5. Supported rest components
41.6. Path and uriTemplate syntax
41.7. Rest producer examples
41.8. Rest producer binding
41.9. More examples
41.10. Spring Boot Auto-Configuration
42. Saga
42.1. URI format
42.2. Configuring Options
42.2.1. Configuring Component Options
42.2.2. Configuring Endpoint Options
42.3. Component Options
42.4. Endpoint Options
42.4.1. Path Parameters (1 parameters)
42.4.2. Query Parameters (1 parameters)
42.5. Spring Boot Auto-Configuration
43. Salesforce
43.1. Configuring Options
43.1.1. Configuring Component Options
43.1.2. Configuring Endpoint Options
43.2. Component Options
43.3. Endpoint Options
43.3.1. Path Parameters (2 parameters)
43.3.2. Query Parameters (57 parameters)
43.4. Authenticating to Salesforce
43.5. URI format
43.6. Passing in Salesforce headers and fetching Salesforce response headers
43.7. Supported Salesforce APIs
43.7.1. Rest API
43.7.2. Bulk 2.0 API
43.7.3. Rest Bulk (original) API
43.7.4. Rest Streaming API
43.7.5. Platform events
43.7.6. Change data capture events
43.8. Examples
43.8.1. Uploading a document to a ContentWorkspace
43.9. Using Salesforce Limits API
43.10. Working with approvals
43.11. Using Salesforce Recent Items API
43.12. Using Salesforce Composite API to submit SObject tree
43.13. Using Salesforce Composite API to submit multiple requests in a batch
43.14. Using Salesforce Composite API to submit multiple chained requests
43.15. Using "raw" Salesforce composite
43.16. Using Raw Operation
43.16.1. Query example
43.16.2. SObject example
43.17. Using Composite SObject Collections
43.17.1. compositeRetrieveSObjectCollections
43.17.2. compositeCreateSObjectCollections
43.17.3. compositeUpdateSObjectCollections
43.17.4. compositeUpsertSObjectCollections
43.17.5. compositeDeleteSObjectCollections
43.18. Sending null values to salesforce
43.19. Generating SOQL query strings
43.20. Camel Salesforce Maven Plugin
43.21. Spring Boot Auto-Configuration
44. Scheduler
44.1. URI format
44.2. Configuring Options
44.2.1. Configuring Component Options
44.2.2. Configuring Endpoint Options
44.3. Component Options
44.4. Endpoint Options
44.4.1. Path Parameters (1 parameters)
44.4.2. Query Parameters (21 parameters)
44.5. More information
44.6. Exchange Properties
44.7. Sample
44.8. Forcing the scheduler to trigger immediately when completed
44.9. Forcing the scheduler to be idle
44.10. Spring Boot Auto-Configuration
45. SEDA
45.1. URI format
45.2. Configuring Options
45.2.1. Configuring Component Options
45.2.2. Configuring Endpoint Options
45.3. Component Options
45.4. Endpoint Options
45.4.1. Path Parameters (1 parameters)
45.4.2. Query Parameters (18 parameters)
45.5. Choosing BlockingQueue implementation
45.6. Use of Request Reply
45.7. Concurrent consumers
45.8. Thread pools
45.9. Sample
45.10. Using multipleConsumers
45.11. Extracting queue information
45.12. Spring Boot Auto-Configuration
46. Servlet
46.1. URI format
46.2. Configuring Options
46.2.1. Configuring Component Options
46.2.2. Configuring Endpoint Options
46.3. Component Options
46.4. Endpoint Options
46.4.1. Path Parameters (1 parameters)
46.4.2. Query Parameters (22 parameters)
46.5. Message Headers
46.6. Usage
46.7. Spring Boot Auto-Configuration
47. Slack
47.1. URI format
47.2. Configuring Options
47.2.1. Configuring Component Options
47.2.2. Configuring Endpoint Options
47.3. Component Options
47.4. Endpoint Options
47.4.1. Path Parameters (1 parameters)
47.4.2. Query Parameters (29 parameters)
47.5. Configuring in Sprint XML
47.6. Example
47.7. Producer
47.8. Consumer
47.9. Spring Boot Auto-Configuration
48. SQL
48.1. URI format
48.2. Configuring Options
48.2.1. Configuring Component Options
48.2.2. Configuring Endpoint Options
48.3. Component Options
48.4. Endpoint Options
48.4.1. Path Parameters (1 parameters)
48.4.2. Query Parameters (45 parameters)
48.5. Treatment of the message body
48.6. Result of the query
48.7. Using StreamList
48.8. Header values
48.9. Generated keys
48.10. DataSource
48.11. Using named parameters
48.12. Using expression parameters in producers
48.12.1. Using expression parameters in consumers
48.13. Using IN queries with dynamic values
48.14. Using the JDBC based idempotent repository
48.14.1. Customize the JDBC idempotency repository
48.14.2. Orphan Lock aware Jdbc IdempotentRepository
48.14.3. Caching Jdbc IdempotentRepository
48.15. Using the JDBC based aggregation repository
48.15.1. Database
48.16. Storing body and headers as text
48.16.1. Codec (Serialization)
48.16.2. Transaction
48.16.2.1. Service (Start/Stop)
48.16.3. Aggregator configuration
48.16.4. Optimistic locking
48.16.5. Propagation behavior
48.16.6. PostgreSQL case
48.17. Camel Sql Starter
48.18. Spring Boot Auto-Configuration
49. Stub
49.1. URI format
49.2. Configuring Options
49.2.1. Configuring Component Options
49.2.1.1. Configuring Endpoint Options
49.3. Component Options
49.4. Endpoint Options
49.4.1. Path Parameters (1 parameters)
49.4.2. Query Parameters (18 parameters)
49.5. Examples
49.6. Spring Boot Auto-Configuration
50. Telegram
50.1. URI format
50.2. Configuring Options
50.2.1. Configuring Component Options
50.2.2. Configuring Endpoint Options
50.3. Component Options
50.4. Endpoint Options
50.4.1. Path Parameters (1 parameters)
50.4.2. Query Parameters (30 parameters)
50.4.3. Message Headers
50.5. Usage
50.6. Producer Example
50.7. Consumer Example
50.8. Reactive Chat-Bot Example
50.9. Getting the Chat ID
50.10. Customizing keyboard
50.11. Webhook Mode
50.12. Spring Boot Auto-Configuration
51. Timer
51.1. URI format
51.2. Configuring Options
51.2.1. Configuring Component Options
51.2.2. Configuring Endpoint Options
51.3. Component Options
51.4. Endpoint Options
51.4.1. Path Parameters (1 parameters)
51.4.2. Query Parameters (13 parameters)
51.5. Exchange Properties
51.6. Sample
51.7. Firing as soon as possible
51.8. Firing only once
51.9. Spring Boot Auto-Configuration
52. Validator
52.1. URI format
52.2. Configuring Options
52.2.1. Configuring Component Options
52.2.2. Configuring Endpoint Options
52.3. Component Options
52.4. Endpoint Options
52.4.1. Path Parameters (1 parameters)
52.4.2. Query Parameters (10 parameters)
52.5. Example
52.6. Advanced: JMX method clearCachedSchema
52.7. Spring Boot Auto-Configuration
53. Webhook
53.1. URI Format
53.2. Configuring Options
53.2.1. Configuring Component Options
53.2.2. Configuring Endpoint Options
53.3. Component Options
53.4. Endpoint Options
53.4.1. Path Parameters (1 parameters)
53.4.2. Query Parameters (8 parameters)
53.5. Examples
53.6. Spring Boot Auto-Configuration
54. XSLT
54.1. URI format
54.2. Configuring Options
54.2.1. Configuring Component Options
54.2.2. Configuring Endpoint Options
54.3. Component Options
54.4. Endpoint Options
54.4.1. Path Parameters (1 parameters)
54.4.2. Query Parameters (13 parameters)
54.5. Using XSLT endpoints
54.6. Getting Useable Parameters into the XSLT
54.7. Spring XML versions
54.8. Using xsl:include
54.9. Using xsl:include and default prefix
54.10. Dynamic stylesheets
54.11. Accessing warnings, errors and fatalErrors from XSLT ErrorListener
54.12. Spring Boot Auto-Configuration
55. Avro
55.1. Avro Dataformat Options
55.2. Avro Data Format usage
55.3. Spring Boot Auto-Configuration
56. Avro Jackson
56.1. Configuring the SchemaResolver
56.2. Avro Jackson Options
56.3. Using custom AvroMapper
56.4. Dependencies
56.5. Spring Boot Auto-Configuration
57. Bindy
57.1. Options
57.2. Annotations
57.2.1. 1. CsvRecord
57.2.2. 2. Link
57.2.3. 3. DataField
57.2.4. 4. FixedLengthRecord
57.2.5. 5. Message
57.2.6. 6. KeyValuePairField
57.2.7. 7. Section
57.2.8. 8. OneToMany
57.2.9. 9. BindyConverter
57.2.10. 10. FormatFactories
57.3. Supported Datatypes
57.4. Using the Java DSL
57.4.1. Setting locale
57.4.2. Unmarshaling
57.4.3. Marshaling
57.5. Using Spring XML
57.6. Dependencies
57.7. Spring Boot Auto-Configuration
58. HL7
58.1. HL7 MLLP protocol
58.1.1. Exposing an HL7 listener using Mina
58.1.2. Exposing an HL7 listener using Netty (available from Camel 2.15 onwards)
58.2. HL7 Model using java.lang.String or byte[]
58.3. HL7v2 Model using HAPI
58.4. HL7 DataFormat
58.4.1. Segment separators
58.4.2. Charset
58.5. Message Headers
58.6. Dependencies
58.7. Spring Boot Auto-Configuration
59. JacksonXML
59.1. JacksonXML Options
59.1.1. Using Jackson XML in Spring DSL
59.1.2. Excluding POJO fields from marshalling
59.2. Include/Exclude fields using the jsonView attribute with `JacksonXML`DataFormat
59.3. Setting serialization include option
59.4. Unmarshalling from XML to POJO with dynamic class name
59.5. Unmarshalling from XML to List
or List
59.6. Using custom Jackson modules
59.7. Enabling or disable features using Jackson
59.8. Converting Maps to POJO using Jackson
59.9. Formatted XML marshalling (pretty-printing)
59.10. Dependencies
59.11. Spring Boot Auto-Configuration
60. JAXB
60.1. Options
60.2. Using the Java DSL
60.3. Using Spring XML
60.4. Partial marshalling/unmarshalling
60.5. Fragment
60.6. Ignoring the NonXML Character
60.7. Working with the ObjectFactory
60.8. Setting encoding
60.9. Controlling namespace prefix mapping
60.10. Schema validation
60.11. Schema Location
60.12. Marshal data that is already XML
60.13. Dependencies
60.14. Spring Boot Auto-Configuration
61. JSON Gson
61.1. Gson Options
61.2. Dependencies
61.3. Spring Boot Auto-Configuration
62. JSON Jackson
62.1. Jackson Options
62.2. Using custom ObjectMapper
62.3. Using Jackson for automatic type conversion
62.4. Dependencies
62.5. Spring Boot Auto-Configuration
63. Protobuf Jackson
63.1. Configuring the SchemaResolver
63.2. Protobuf Jackson Options
63.3. Using custom ProtobufMapper
63.4. Dependencies
63.5. Spring Boot Auto-Configuration
64. SOAP
64.1. SOAP Options
64.2. ElementNameStrategy
64.3. Using the Java DSL
64.3.1. Using SOAP 1.2
64.4. Multi-part Messages
64.4.1. Holder Object mapping
64.5. Examples
64.5.1. Webservice client
64.5.2. Webservice Server
64.6. Dependencies
64.7. Spring Boot Auto-Configuration
65. Zip File
65.1. ZipFile Options
65.2. Marshal
65.3. Unmarshal
65.3.1. Aggregate
65.4. Dependencies
65.5. Spring Boot Auto-Configuration
66. Constant
66.1. Constant Options
66.2. Example
66.2.1. Specifying type of value
66.3. Loading constant from external resource
66.4. Dependencies
66.5. Spring Boot Auto-Configuration
67. CSimple
67.1. Different between CSimple and Simple
67.1.1. Additional CSimple functions
67.2. Compilation
67.2.1. Using camel-csimple-maven-plugin
67.2.2. Using camel-csimple-joor
67.3. CSimple Language options
67.4. Limitations
67.5. Auto imports
67.6. Configuration file
67.7. See Also
67.8. Spring Boot Auto-Configuration
68. ExchangeProperty
68.1. Exchange Property Options
68.2. Example
68.3. Dependencies
68.4. Spring Boot Auto-Configuration
69. File
69.1. File Language options
69.2. Syntax
69.3. File token example
69.3.1. Relative paths
69.3.2. Absolute paths
69.4. Samples
69.5. Dependencies
69.6. Spring Boot Auto-Configuration
70. Header
70.1. Header Options
70.2. Example usage
70.3. Dependencies
70.4. Spring Boot Auto-Configuration
71. JSONPath
71.1. JSONPath Options
71.2. Examples
71.3. JSONPath Syntax
71.3.1. Easy JSONPath Syntax
71.4. Supported message body types
71.5. Suppressing exceptions
71.6. Inline Simple expressions
71.7. JSonPath injection
71.8. Encoding Detection
71.9. Split JSON data into sub rows as JSON
71.10. Using header as input
71.11. Spring Boot Auto-Configuration
72. Ref
72.1. Ref Language options
72.2. Example usage
72.3. Dependencies
72.4. Spring Boot Auto-Configuration
73. XQuery
73.1. XQuery Language options
73.2. Variables
73.3. Example
73.3.1. Using namespaces
73.4. Using XQuery as transformation
73.5. Loading script from external resource
73.6. Learning XQuery
73.7. Dependencies
73.8. Spring Boot Auto-Configuration
74. Simple
74.1. Simple Language options
74.2. Variables
74.3. OGNL expression support
74.4. Operator support
74.4.1. Comparing with different types
74.4.2. Using and / or
74.5. Examples
74.6. Setting result type
74.7. Using new lines or tabs in XML DSLs
74.8. Leading and trailing whitespace handling
74.9. Loading script from external resource
74.10. Spring Boot Auto-Configuration
75. Tokenize
75.1. Tokenize Options
75.2. Example
75.3. See Also
75.4. Spring Boot Auto-Configuration
76. XML Tokenize
76.1. XML Tokenizer Options
76.2. Example
76.3. Spring Boot Auto-Configuration
77. XPath
77.1. XPath Language options
77.2. Namespaces
77.3. Variables
77.3.1. Namespace given
77.3.2. No namespace given
77.4. Functions
77.4.1. Functions example
77.5. Stream based message bodies
77.6. Setting result type
77.7. Using XPath on Headers
77.8. Example
77.9. Using namespaces
77.10. Using @XPath Annotation for Bean Integration
77.11. Using XPathBuilder without an Exchange
77.12. Using Saxon with XPathBuilder
77.12.1. Setting a custom XPathFactory using System Property
77.12.2. Enabling Saxon from XML DSL
77.13. Namespace auditing to aid debugging
77.13.1. Logging the Namespace Context of your XPath expression/predicate
77.13.2. Auditing namespaces
77.14. Loading script from external resource
77.15. Dependencies
77.16. Spring Boot Auto-Configuration
78. Openapi Java
78.1. Using OpenApi in rest-dsl
78.2. Options
78.3. Adding Security Definitions in API doc
78.4. JSon or Yaml
78.5. useXForwardHeaders and API URL resolution
78.6. Examples
78.7. Spring Boot Auto-Configuration
Legal Notice
Camel Spring Boot Reference 3.14
Red Hat Integration
2023.q1
Camel Spring Boot Reference
Red Hat Integration Documentation Team
This content is not included.
fuse-docs-support@redhat.com
Integration Support Team
http://access.redhat.com/support
Legal Notice
Abstract
This guide describes the settings for Camel Spring Boot components.
Next