Chapter 159. Ignite Messaging Component
Available as of Camel version 2.17
The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an Ignite topic.
This endpoint supports producers (to send messages) and consumers (to receive messages).
159.1. Options
The Ignite Messaging component supports 4 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| ignite (common) | Sets the Ignite instance. | Ignite | |
| configurationResource (common) | Sets the resource from where to load the configuration. It can be a: URI, String (URI) or an InputStream. | Object | |
| igniteConfiguration (common) | Allows the user to set a programmatic IgniteConfiguration. | IgniteConfiguration | |
| resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The Ignite Messaging endpoint is configured using URI syntax:
ignite-messaging:topic
with the following path and query parameters:
159.1.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| topic | Required The topic name. | String |
159.1.2. Query Parameters (9 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| propagateIncomingBodyIfNo ReturnValue (common) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean |
| treatCollectionsAsCache Objects (common) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc. | false | boolean |
| bridgeErrorHandler (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
| exceptionHandler (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | ExceptionHandler | |
| exchangePattern (consumer) | Sets the exchange pattern when the consumer creates an exchange. | ExchangePattern | |
| clusterGroupExpression (producer) | The cluster group expression. | ClusterGroupExpression | |
| sendMode (producer) | The send mode to use. Possible values: UNORDERED, ORDERED. | UNORDERED | IgniteMessagingSend Mode |
| timeout (producer) | The timeout for the send operation when using ordered messages. | Long | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
159.2. Spring Boot Auto-Configuration
The component supports 5 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.ignite-messaging.configuration-resource | Sets the resource from where to load the configuration. It can be a: URI, String (URI) or an InputStream. The option is a java.lang.Object type. | String | |
| camel.component.ignite-messaging.enabled | Enable ignite-messaging component | true | Boolean |
| camel.component.ignite-messaging.ignite | Sets the Ignite instance. The option is a org.apache.ignite.Ignite type. | String | |
| camel.component.ignite-messaging.ignite-configuration | Allows the user to set a programmatic IgniteConfiguration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. | String | |
| camel.component.ignite-messaging.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
159.2.1. Headers used
This endpoint uses the following headers:
| Header name | Constant | Expected type | Description |
|---|---|---|---|
| CamelIgniteMessagingTopic | IgniteConstants.IGNITE_MESSAGING_TOPIC | String | Allows you to dynamically change the topic to send messages to (producer). It also carries the topic on which a message was received (consumer). |
| CamelIgniteMessagingUUID | IgniteConstants.IGNITE_MESSAGING_UUID | UUID | This header is filled in with the UUID of the subscription when a message arrives (consumer). |
