Skip to navigation
Skip to main content
Search
Content extracted on:
2026-04-09
Home
Product Documentation
Red Hat Integration
2022.Q3
Camel Spring Boot Reference
Camel Spring Boot Reference
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. Data Format
16.1. URI format
16.2. DataFormat Options
16.2.1. Configuring Options
16.2.1.1. Configuring Component Options
16.2.1.2. Configuring Endpoint Options
16.3. Component Options
16.4. Endpoint Options
16.4.1. Path Parameters (2 parameters)
16.4.2. Query Parameters (1 parameters)
16.5. Samples
16.6. Spring Boot Auto-Configuration
17. Dataset
17.1. URI format
17.2. Configuring Options
17.2.1. Configuring Component Options
17.2.2. Configuring Endpoint Options
17.3. Component Options
17.4. Endpoint Options
17.4.1. Path Parameters (1 parameters)
17.4.2. Query Parameters (21 parameters)
17.5. Configuring DataSet
17.6. Example
17.7. DataSetSupport (abstract class)
17.7.1. Properties on DataSetSupport
17.8. SimpleDataSet
17.8.1. Additional Properties on SimpleDataSet
17.9. ListDataSet
17.9.1. Additional Properties on ListDataSet
17.10. FileDataSet
17.10.1. Additional Properties on FileDataSet
17.11. Spring Boot Auto-Configuration
18. Direct
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 (8 parameters)
18.5. Samples
18.6. Spring Boot Auto-Configuration
19. FHIR
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 (2 parameters)
19.4.2. Query Parameters (44 parameters)
19.5. API Parameters (13 APIs)
19.5.1. API: capabilities
19.5.1.1. Method ofType
19.5.2. API: create
19.5.2.1. Method resource
19.5.3. API: delete
19.5.3.1. Method resource
19.5.3.2. Method resourceById
19.5.3.3. Method resourceConditionalByUrl
19.5.4. API: history
19.5.4.1. Method onInstance
19.5.4.2. Method onServer
19.5.4.3. Method onType
19.5.5. API: load-page
19.5.5.1. Method byUrl
19.5.5.2. Method next
19.5.5.3. Method previous
19.5.6. API: meta
19.5.6.1. Method add
19.5.6.2. Method delete
19.5.6.3. Method getFromResource
19.5.6.4. Method getFromServer
19.5.6.5. Method getFromType
19.5.7. API: operation
19.5.7.1. Method onInstance
19.5.7.2. Method onInstanceVersion
19.5.7.3. Method onServer
19.5.7.4. Method onType
19.5.7.5. Method processMessage
19.5.8. API: patch
19.5.8.1. Method patchById
19.5.8.2. Method patchByUrl
19.5.9. API: read
19.5.9.1. Method resourceById
19.5.9.2. Method resourceByUrl
19.5.10. API: search
19.5.10.1. Method searchByUrl
19.5.11. API: transaction
19.5.11.1. Method withBundle
19.5.11.2. Method withResources
19.5.12. API: update
19.5.12.1. Method resource
19.5.12.2. Method resourceBySearchUrl
19.5.13. API: validate
19.5.13.1. Method resource
19.6. Spring Boot Auto-Configuration
20. File
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 (1 parameters)
20.4.2. Query Parameters (94 parameters)
20.5. Move and Delete operations
20.6. Fine grained control over Move and PreMove option
20.7. About moveFailed
20.8. Message Headers
20.8.1. File producer only
20.8.2. File consumer only
20.9. Batch Consumer
20.10. Exchange Properties, file consumer only
20.11. Using charset
20.12. Common gotchas with folder and filenames
20.13. Filename Expression
20.14. Consuming files from folders where others drop files directly
20.15. Using done files
20.16. Writing done files
20.17. Samples
20.17.1. Read from a directory and write to another directory
20.17.2. Read from a directory and write to another directory using a overrule dynamic name
20.17.3. Reading recursively from a directory and writing to another
20.18. Using flatten
20.19. Reading from a directory and the default move operation
20.20. Read from a directory and process the message in java
20.21. Writing to files
20.21.1. Write to subdirectory using Exchange.FILE_NAME
20.21.2. Writing file through the temporary directory relative to the final destination
20.22. Using expression for filenames
20.23. Avoiding reading the same file more than once (idempotent consumer)
20.24. Using a file based idempotent repository
20.25. Using a JPA based idempotent repository
20.26. Filter using org.apache.camel.component.file.GenericFileFilter
20.27. Filtering using ANT path matcher
20.27.1. Sorting using Comparator
20.27.2. Sorting using sortBy
20.28. Using GenericFileProcessStrategy
20.29. Using filter
20.30. Using bridgeErrorHandler
20.31. Debug logging
20.32. Spring Boot Auto-Configuration
21. FTP
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 (3 parameters)
21.4.2. Query Parameters (111 parameters)
21.5. FTPS component default trust store
21.6. Examples
21.7. Concurrency
21.8. More information
21.9. Default when consuming files
21.9.1. limitations
21.10. Message Headers
21.10.1. Exchange Properties
21.11. About timeouts
21.12. Using Local Work Directory
21.13. Stepwise changing directories
21.14. Using stepwise=true (default mode)
21.15. Using stepwise=false
21.16. Samples
21.16.1. Consuming a remote FTPS server (implicit SSL) and client authentication
21.16.2. Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration
21.17. Custom filtering
21.18. Filtering using ANT path matcher
21.19. Using a proxy with SFTP
21.20. Setting preferred SFTP authentication method
21.21. Consuming a single file using a fixed name
21.22. Debug logging
21.23. Spring Boot Auto-Configuration
22. HTTP
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 (1 parameters)
22.4.2. Query Parameters (51 parameters)
22.5. Message Headers
22.6. Message Body
22.7. Using System Properties
22.8. Response code
22.9. Exceptions
22.10. Which HTTP method will be used
22.11. How to get access to HttpServletRequest and HttpServletResponse
22.12. Configuring URI to call
22.13. Configuring URI Parameters
22.14. How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE) to the HTTP producer
22.15. Using client timeout - SO_TIMEOUT
22.16. Configuring a Proxy
22.16.1. Using proxy settings outside of URI
22.17. Configuring charset
22.17.1. Sample with scheduled poll
22.17.2. URI Parameters from the endpoint URI
22.17.3. URI Parameters from the Message
22.17.4. Getting the Response Code
22.18. Disabling Cookies
22.19. Basic auth with the streaming message body
22.20. Advanced Usage
22.20.1. Setting up SSL for HTTP Client
22.21. Spring Boot Auto-Configuration
23. Infinispan
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 (26 parameters)
23.5. Camel Operations
23.6. Message Headers
23.7. Examples
23.8. Using the Infinispan based idempotent repository
23.9. Using the Infinispan based aggregation repository
23.10. Spring Boot Auto-Configuration
24. Jira
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 (16 parameters)
24.5. Client Factory
24.6. Authentication
24.6.1. Basic authentication requirements:
24.6.2. OAuth authentication requirements:
24.7. JQL
24.8. Operations
24.9. AddIssue
24.10. AddComment
24.11. Attach
24.12. DeleteIssue
24.13. TransitionIssue
24.14. UpdateIssue
24.15. Watcher
24.16. WatchUpdates (consumer)
24.17. Spring Boot Auto-Configuration
25. JMS
25.1. URI format
25.1.1. Using ActiveMQ
25.1.2. Transactions and Cache Levels
25.1.3. Durable Subscriptions
25.1.4. Message Header Mapping
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 (2 parameters)
25.4.2. Query Parameters (95 parameters)
25.5. Samples
25.5.1. Receiving from JMS
25.5.2. Sending to JMS
25.5.3. Using Annotations
25.5.4. Spring DSL sample
25.5.5. Other samples
25.5.6. Using JMS as a Dead Letter Queue storing Exchange
25.5.7. Using JMS as a Dead Letter Channel storing error only
25.6. Message Mapping between JMS and Camel
25.6.1. Disabling auto-mapping of JMS messages
25.6.2. Using a custom MessageConverter
25.6.3. Controlling the mapping strategy selected
25.7. Message format when sending
25.8. Message format when receiving
25.9. About using Camel to send and receive messages and JMSReplyTo
25.9.1. JmsProducer
25.9.2. JmsConsumer
25.10. Reuse endpoint and send to different destinations computed at runtime
25.11. Configuring different JMS providers
25.11.1. Using JNDI to find the ConnectionFactory
25.12. Concurrent Consuming
25.12.1. Concurrent Consuming with async consumer
25.13. Request-reply over JMS
25.13.1. Request-reply over JMS and using a shared fixed reply queue
25.13.2. Request-reply over JMS and using an exclusive fixed reply queue
25.14. Synchronizing clocks between senders and receivers
25.15. About time to live
25.16. Enabling Transacted Consumption
25.17. Using JMSReplyTo for late replies
25.18. Using a request timeout
25.19. Sending an InOnly message and keeping the JMSReplyTo header
25.20. Setting JMS provider options on the destination
25.21. Spring Boot Auto-Configuration
26. Kafka
26.1. URI format
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 (1 parameters)
26.4.2. Query Parameters (102 parameters)
26.5. Message headers
26.5.1. Consumer headers
26.5.2. Producer headers
26.6. Consumer error handling
26.7. Samples
26.7.1. Consuming messages from Kafka
26.7.2. Producing messages to Kafka
26.8. SSL configuration
26.9. Using the Kafka idempotent repository
26.10. Using manual commit with Kafka consumer
26.11. Kafka Headers propagation
26.12. Spring Boot Auto-Configuration
27. Kamelet
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 (2 parameters)
27.4.2. Query Parameters (8 parameters)
27.5. Discovery
27.6. Samples
27.7. Spring Boot Auto-Configuration
28. Language
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 (7 parameters)
28.5. Message Headers
28.6. Examples
28.7. Loading scripts from resources
28.8. Spring Boot Auto-Configuration
29. Log
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 (1 parameters)
29.4.2. Query Parameters (27 parameters)
29.5. Regular logger sample
29.6. Regular logger with formatter sample
29.7. Throughput logger with groupSize sample
29.8. Throughput logger with groupInterval sample
29.9. Masking sensitive information like password
29.10. Full customization of the logging output
29.10.1. Convention over configuration
29.11. Spring Boot Auto-Configuration
30. Mail
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 (2 parameters)
30.4.2. Query Parameters (66 parameters)
30.4.3. Sample endpoints
30.4.4. Component alias names
30.4.5. Default ports
30.5. SSL support
30.5.1. Using the JSSE Configuration Utility
30.5.2. Configuring JavaMail Directly
30.6. Mail Message Content
30.7. Headers take precedence over pre-configured recipients
30.8. Multiple recipients for easier configuration
30.9. Setting sender name and email
30.10. JavaMail API (ex SUN JavaMail)
30.11. Samples
30.12. Sending mail with attachment sample
30.13. SSL sample
30.14. Consuming mails with attachment sample
30.15. How to split a mail message with attachments
30.16. Using custom SearchTerm
30.17. Polling Optimization
30.18. Using headers with additional Java Mail Sender properties
30.19. Spring Boot Auto-Configuration
31. Master
31.1. Using the master endpoint
31.2. URI format
31.3. Configuring Options
31.3.1. Configuring Component Options
31.3.2. Configuring Endpoint Options
31.4. Component Options
31.5. Endpoint Options
31.5.1. Path Parameters (2 parameters)
31.5.2. Query Parameters (3 parameters)
31.6. Example
31.7. Implementations
31.8. Spring Boot Auto-Configuration
32. MLLP
32.1. Configuring Options
32.1.1. Configuring Component Options
32.1.2. Configuring Endpoint Options
32.2. Component Options
32.3. Endpoint Options
32.3.1. Path Parameters (2 parameters)
32.3.2. Query Parameters (26 parameters)
32.4. MLLP Consumer
32.4.1. Message Headers
32.4.2. Exchange Properties
32.5. MLLP Producer
32.5.1. Message Headers
32.5.2. Exchange Properties
32.6. Spring Boot Auto-Configuration
33. Mock
33.1. URI format
33.2. Configuring Options
33.2.1. Configuring Component Options
33.2.2. Configuring Endpoint Options
33.3. Component Options
33.4. Endpoint Options
33.4.1. Path Parameters (1 parameters)
33.4.2. Query Parameters (12 parameters)
33.5. Simple Example
33.6. Using assertPeriod
33.7. Setting expectations
33.8. Adding expectations to specific messages
33.9. Mocking existing endpoints
33.10. Mocking existing endpoints using the camel-test component
33.11. Mocking existing endpoints with XML DSL
33.12. Mocking endpoints and skip sending to original endpoint
33.13. Limiting the number of messages to keep
33.14. Testing with arrival times
33.15. Spring Boot Auto-Configuration
34. MongoDB
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 (27 parameters)
34.5. Configuration of database in Spring XML
34.6. Sample route
34.7. MongoDB operations - producer endpoints
34.7.1. Query operations
34.7.1.1. findById
34.7.1.2. findOneByQuery
34.7.1.3. Example without a query selector (returns the first document in a collection)
34.7.1.4. Example with a query selector (returns the first matching document in a collection):
34.7.1.5. findAll
34.7.1.5.1. Example without a query selector (returns all documents in a collection)
34.7.1.5.2. Example with a query selector (returns all matching documents in a collection)
34.7.1.5.3. Example with option outputType=MongoIterable and batch size
34.7.1.6. count
34.7.1.7. Specifying a fields filter (projection)
34.7.1.8. Specifying a sort clause
34.7.2. Create/update operations
34.7.2.1. insert
34.7.2.2. save
34.7.2.3. update
34.7.3. Delete operations
34.7.3.1. remove
34.7.4. Bulk Write Operations
34.7.4.1. bulkWrite
34.7.5. Other operations
34.7.5.1. aggregate
34.7.5.2. getDbStats
34.7.5.3. getColStats
34.7.5.4. command
34.7.6. Dynamic operations
34.8. Consumers
34.8.1. Tailable Cursor Consumer
34.9. How the tailable cursor consumer works
34.10. Persistent tail tracking
34.11. Enabling persistent tail tracking
34.11.1. Change Streams Consumer
34.12. Type conversions
34.13. Spring Boot Auto-Configuration
35. Netty
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 (3 parameters)
35.4.2. Query Parameters (71 parameters)
35.5. Registry based Options
35.5.1. Using non shareable encoders or decoders
35.6. Sending Messages to/from a Netty endpoint
35.6.1. Netty Producer
35.6.2. Netty Consumer
35.7. Examples
35.7.1. A UDP Netty endpoint using Request-Reply and serialized object payload
35.7.2. A TCP based Netty consumer endpoint using One-way communication
35.7.3. An SSL/TCP based Netty consumer endpoint using Request-Reply communication
35.7.4. Using Multiple Codecs
35.8. Closing Channel When Complete
35.9. Custom pipeline
35.9.1. Using custom pipeline factory
35.10. Reusing Netty boss and worker thread pools
35.11. Multiplexing concurrent messages over a single connection with request/reply
35.12. Spring Boot Auto-Configuration
36. Paho
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 (1 parameters)
36.4.2. Query Parameters (31 parameters)
36.5. Headers
36.6. Default payload type
36.7. Samples
36.8. Spring Boot Auto-Configuration
37. Paho MQTT 5
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 (32 parameters)
37.5. Headers
37.6. Default payload type
37.7. Samples
37.8. Spring Boot Auto-Configuration
38. Quartz
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 (2 parameters)
38.4.2. Query Parameters (17 parameters)
38.4.3. Configuring quartz.properties file
38.5. Enabling Quartz scheduler in JMX
38.6. Starting the Quartz scheduler
38.7. Clustering
38.8. Message Headers
38.9. Using Cron Triggers
38.10. Specifying time zone
38.11. Configuring misfire instructions
38.11.1. SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW = 1 (default)
38.11.2. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT = 2
38.11.3. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT = 3
38.11.4. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT = 4
38.11.5. SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT = 5
38.11.6. CronTrigger.MISFIRE_INSTRUCTION_FIRE_ONCE_NOW = 1 (default)
38.11.7. CronTrigger.MISFIRE_INSTRUCTION_DO_NOTHING = 2
38.12. Using QuartzScheduledPollConsumerScheduler
38.13. Cron Component Support
38.14. Spring Boot Auto-Configuration
39. Ref
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 (1 parameters)
39.4.2. Query Parameters (4 parameters)
39.5. Runtime lookup
39.6. Sample
39.7. Spring Boot Auto-Configuration
40. REST
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 (3 parameters)
40.4.2. Query Parameters (16 parameters)
40.5. Supported rest components
40.6. Path and uriTemplate syntax
40.7. Rest producer examples
40.8. Rest producer binding
40.9. More examples
40.10. Spring Boot Auto-Configuration
41. Saga
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 (1 parameters)
41.4.2. Query Parameters (1 parameters)
41.5. Spring Boot Auto-Configuration
42. Salesforce
42.1. Configuring Options
42.1.1. Configuring Component Options
42.1.2. Configuring Endpoint Options
42.2. Component Options
42.3. Endpoint Options
42.3.1. Path Parameters (2 parameters)
42.3.2. Query Parameters (57 parameters)
42.4. Authenticating to Salesforce
42.5. URI format
42.6. Passing in Salesforce headers and fetching Salesforce response headers
42.7. Supported Salesforce APIs
42.7.1. Rest API
42.7.2. Bulk 2.0 API
42.7.3. Rest Bulk (original) API
42.7.4. Rest Streaming API
42.7.5. Platform events
42.7.6. Change data capture events
42.8. Examples
42.8.1. Uploading a document to a ContentWorkspace
42.9. Using Salesforce Limits API
42.10. Working with approvals
42.11. Using Salesforce Recent Items API
42.12. Using Salesforce Composite API to submit SObject tree
42.13. Using Salesforce Composite API to submit multiple requests in a batch
42.14. Using Salesforce Composite API to submit multiple chained requests
42.15. Using "raw" Salesforce composite
42.16. Using Raw Operation
42.16.1. Query example
42.16.2. SObject example
42.17. Using Composite SObject Collections
42.17.1. compositeRetrieveSObjectCollections
42.17.2. compositeCreateSObjectCollections
42.17.3. compositeUpdateSObjectCollections
42.17.4. compositeUpsertSObjectCollections
42.17.5. compositeDeleteSObjectCollections
42.18. Sending null values to salesforce
42.19. Generating SOQL query strings
42.20. Camel Salesforce Maven Plugin
42.21. Spring Boot Auto-Configuration
43. Scheduler
43.1. URI format
43.2. Configuring Options
43.2.1. Configuring Component Options
43.2.2. Configuring Endpoint Options
43.3. Component Options
43.4. Endpoint Options
43.4.1. Path Parameters (1 parameters)
43.4.2. Query Parameters (21 parameters)
43.5. More information
43.6. Exchange Properties
43.7. Sample
43.8. Forcing the scheduler to trigger immediately when completed
43.9. Forcing the scheduler to be idle
43.10. Spring Boot Auto-Configuration
44. SEDA
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 (18 parameters)
44.5. Choosing BlockingQueue implementation
44.6. Use of Request Reply
44.7. Concurrent consumers
44.8. Thread pools
44.9. Sample
44.10. Using multipleConsumers
44.11. Extracting queue information
44.12. Spring Boot Auto-Configuration
45. Slack
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 (29 parameters)
45.5. Configuring in Sprint XML
45.6. Example
45.7. Producer
45.8. Consumer
45.9. Spring Boot Auto-Configuration
46. SQL
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 (45 parameters)
46.5. Treatment of the message body
46.6. Result of the query
46.7. Using StreamList
46.8. Header values
46.9. Generated keys
46.10. DataSource
46.11. Using named parameters
46.12. Using expression parameters in producers
46.12.1. Using expression parameters in consumers
46.13. Using IN queries with dynamic values
46.14. Using the JDBC based idempotent repository
46.14.1. Customize the JDBC idempotency repository
46.14.2. Orphan Lock aware Jdbc IdempotentRepository
46.14.3. Caching Jdbc IdempotentRepository
46.15. Using the JDBC based aggregation repository
46.15.1. Database
46.16. Storing body and headers as text
46.16.1. Codec (Serialization)
46.16.2. Transaction
46.16.2.1. Service (Start/Stop)
46.16.3. Aggregator configuration
46.16.4. Optimistic locking
46.16.5. Propagation behavior
46.16.6. PostgreSQL case
46.17. Camel Sql Starter
46.18. Spring Boot Auto-Configuration
47. Stub
47.1. URI format
47.2. Configuring Options
47.2.1. Configuring Component Options
47.2.1.1. Configuring Endpoint Options
47.3. Component Options
47.4. Endpoint Options
47.4.1. Path Parameters (1 parameters)
47.4.2. Query Parameters (18 parameters)
47.5. Examples
47.6. Spring Boot Auto-Configuration
48. Telegram
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 (30 parameters)
48.4.3. Message Headers
48.5. Usage
48.6. Producer Example
48.7. Consumer Example
48.8. Reactive Chat-Bot Example
48.9. Getting the Chat ID
48.10. Customizing keyboard
48.11. Webhook Mode
48.12. Spring Boot Auto-Configuration
49. Timer
49.1. URI format
49.2. Configuring Options
49.2.1. Configuring Component Options
49.2.2. Configuring Endpoint Options
49.3. Component Options
49.4. Endpoint Options
49.4.1. Path Parameters (1 parameters)
49.4.2. Query Parameters (13 parameters)
49.5. Exchange Properties
49.6. Sample
49.7. Firing as soon as possible
49.8. Firing only once
49.9. Spring Boot Auto-Configuration
50. Validator
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 (10 parameters)
50.5. Example
50.6. Advanced: JMX method clearCachedSchema
50.7. Spring Boot Auto-Configuration
51. Webhook
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 (8 parameters)
51.5. Examples
51.6. Spring Boot Auto-Configuration
52. XSLT
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 (13 parameters)
52.5. Using XSLT endpoints
52.6. Getting Useable Parameters into the XSLT
52.7. Spring XML versions
52.8. Using xsl:include
52.9. Using xsl:include and default prefix
52.10. Dynamic stylesheets
52.11. Accessing warnings, errors and fatalErrors from XSLT ErrorListener
52.12. Spring Boot Auto-Configuration
53. Avro
53.1. Avro Dataformat Options
53.2. Avro Data Format usage
53.3. Spring Boot Auto-Configuration
54. Avro Jackson
54.1. Configuring the SchemaResolver
54.2. Avro Jackson Options
54.3. Using custom AvroMapper
54.4. Dependencies
54.5. Spring Boot Auto-Configuration
55. Bindy
55.1. Options
55.2. Annotations
55.2.1. 1. CsvRecord
55.2.2. 2. Link
55.2.3. 3. DataField
55.2.4. 4. FixedLengthRecord
55.2.5. 5. Message
55.2.6. 6. KeyValuePairField
55.2.7. 7. Section
55.2.8. 8. OneToMany
55.2.9. 9. BindyConverter
55.2.10. 10. FormatFactories
55.3. Supported Datatypes
55.4. Using the Java DSL
55.4.1. Setting locale
55.4.2. Unmarshaling
55.4.3. Marshaling
55.5. Using Spring XML
55.6. Dependencies
55.7. Spring Boot Auto-Configuration
56. HL7
56.1. HL7 MLLP protocol
56.1.1. Exposing an HL7 listener using Mina
56.1.2. Exposing an HL7 listener using Netty (available from Camel 2.15 onwards)
56.2. HL7 Model using java.lang.String or byte[]
56.3. HL7v2 Model using HAPI
56.4. HL7 DataFormat
56.4.1. Segment separators
56.4.2. Charset
56.5. Message Headers
56.6. Dependencies
56.7. Spring Boot Auto-Configuration
57. JacksonXML
57.1. JacksonXML Options
57.1.1. Using Jackson XML in Spring DSL
57.1.2. Excluding POJO fields from marshalling
57.2. Include/Exclude fields using the jsonView attribute with `JacksonXML`DataFormat
57.3. Setting serialization include option
57.4. Unmarshalling from XML to POJO with dynamic class name
57.5. Unmarshalling from XML to List
or List
57.6. Using custom Jackson modules
57.7. Enabling or disable features using Jackson
57.8. Converting Maps to POJO using Jackson
57.9. Formatted XML marshalling (pretty-printing)
57.10. Dependencies
57.11. Spring Boot Auto-Configuration
58. JAXB
58.1. Options
58.2. Using the Java DSL
58.3. Using Spring XML
58.4. Partial marshalling/unmarshalling
58.5. Fragment
58.6. Ignoring the NonXML Character
58.7. Working with the ObjectFactory
58.8. Setting encoding
58.9. Controlling namespace prefix mapping
58.10. Schema validation
58.11. Schema Location
58.12. Marshal data that is already XML
58.13. Dependencies
58.14. Spring Boot Auto-Configuration
59. JSON Gson
59.1. Gson Options
59.2. Dependencies
59.3. Spring Boot Auto-Configuration
60. Protobuf Jackson
60.1. Configuring the SchemaResolver
60.2. Protobuf Jackson Options
60.3. Using custom ProtobufMapper
60.4. Dependencies
60.5. Spring Boot Auto-Configuration
61. SOAP
61.1. SOAP Options
61.2. ElementNameStrategy
61.3. Using the Java DSL
61.3.1. Using SOAP 1.2
61.4. Multi-part Messages
61.4.1. Holder Object mapping
61.5. Examples
61.5.1. Webservice client
61.5.2. Webservice Server
61.6. Dependencies
61.7. Spring Boot Auto-Configuration
62. Zip File
62.1. ZipFile Options
62.2. Marshal
62.3. Unmarshal
62.3.1. Aggregate
62.4. Dependencies
62.5. Spring Boot Auto-Configuration
63. Constant
63.1. Constant Options
63.2. Example
63.2.1. Specifying type of value
63.3. Loading constant from external resource
63.4. Dependencies
63.5. Spring Boot Auto-Configuration
64. CSimple
64.1. Different between CSimple and Simple
64.1.1. Additional CSimple functions
64.2. Compilation
64.2.1. Using camel-csimple-maven-plugin
64.2.2. Using camel-csimple-joor
64.3. CSimple Language options
64.4. Limitations
64.5. Auto imports
64.6. Configuration file
64.7. See Also
64.8. Spring Boot Auto-Configuration
65. ExchangeProperty
65.1. Exchange Property Options
65.2. Example
65.3. Dependencies
65.4. Spring Boot Auto-Configuration
66. File
66.1. File Language options
66.2. Syntax
66.3. File token example
66.3.1. Relative paths
66.3.2. Absolute paths
66.4. Samples
66.5. Dependencies
66.6. Spring Boot Auto-Configuration
67. Header
67.1. Header Options
67.2. Example usage
67.3. Dependencies
67.4. Spring Boot Auto-Configuration
68. JSONPath
68.1. JSONPath Options
68.2. Examples
68.3. JSONPath Syntax
68.3.1. Easy JSONPath Syntax
68.4. Supported message body types
68.5. Suppressing exceptions
68.6. Inline Simple expressions
68.7. JSonPath injection
68.8. Encoding Detection
68.9. Split JSON data into sub rows as JSON
68.10. Using header as input
68.11. Spring Boot Auto-Configuration
69. Ref
69.1. Ref Language options
69.2. Example usage
69.3. Dependencies
69.4. Spring Boot Auto-Configuration
70. XQuery
70.1. XQuery Language options
70.2. Variables
70.3. Example
70.3.1. Using namespaces
70.4. Using XQuery as transformation
70.5. Loading script from external resource
70.6. Learning XQuery
70.7. Dependencies
70.8. Spring Boot Auto-Configuration
71. Simple
71.1. Simple Language options
71.2. Variables
71.3. OGNL expression support
71.4. Operator support
71.4.1. Comparing with different types
71.4.2. Using and / or
71.5. Examples
71.6. Setting result type
71.7. Using new lines or tabs in XML DSLs
71.8. Leading and trailing whitespace handling
71.9. Loading script from external resource
71.10. Spring Boot Auto-Configuration
72. Tokenize
72.1. Tokenize Options
72.2. Example
72.3. See Also
72.4. Spring Boot Auto-Configuration
73. XML Tokenize
73.1. XML Tokenizer Options
73.2. Example
73.3. Spring Boot Auto-Configuration
74. XPath
74.1. XPath Language options
74.2. Namespaces
74.3. Variables
74.3.1. Namespace given
74.3.2. No namespace given
74.4. Functions
74.4.1. Functions example
74.5. Stream based message bodies
74.6. Setting result type
74.7. Using XPath on Headers
74.8. Example
74.9. Using namespaces
74.10. Using @XPath Annotation for Bean Integration
74.11. Using XPathBuilder without an Exchange
74.12. Using Saxon with XPathBuilder
74.12.1. Setting a custom XPathFactory using System Property
74.12.2. Enabling Saxon from XML DSL
74.13. Namespace auditing to aid debugging
74.13.1. Logging the Namespace Context of your XPath expression/predicate
74.13.2. Auditing namespaces
74.14. Loading script from external resource
74.15. Dependencies
74.16. Spring Boot Auto-Configuration
75. Openapi Java
75.1. Using OpenApi in rest-dsl
75.2. Options
75.3. Adding Security Definitions in API doc
75.4. JSon or Yaml
75.5. useXForwardHeaders and API URL resolution
75.6. Examples
75.7. Spring Boot Auto-Configuration
Legal Notice
Camel Spring Boot Reference
Red Hat Integration
2022.q3
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