Ignite Messaging

Since Camel 2.17

Both producer and consumer are supported

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).

Options

The Ignite Messaging component supports 6 options, which are listed below.

Name Description Default Type

configurationResource (common)

The resource from where to load the configuration. It can be a: URL, String or InputStream type.

Object

ignite (common)

To use an existing Ignite instance.

Ignite

igniteConfiguration (common)

Allows the user to set a programmatic ignite configuration.

IgniteConfiguration

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

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

basicPropertyBinding (advanced)

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

The Ignite Messaging endpoint is configured using URI syntax:

ignite-messaging:topic

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

topic

Required The topic name.

String

Query Parameters (11 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

treatCollectionsAsCacheObjects (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. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut

ExchangePattern

clusterGroupExpression (producer)

The cluster group expression.

ClusterGroupExpression

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

sendMode (producer)

The send mode to use. Possible values: UNORDERED, ORDERED. There are 2 enums and the value can be one of: ORDERED, UNORDERED

UNORDERED

IgniteMessagingSendMode

timeout (producer)

The timeout for the send operation when using ordered messages.

Long

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

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).

Spring Boot Auto-Configuration

When using ignite with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-ignite-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 44 options, which are listed below.

Name Description Default Type

camel.component.ignite-cache.bridge-error-handler

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

camel.component.ignite-cache.configuration-resource

The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type.

String

camel.component.ignite-cache.enabled

Whether to enable auto configuration of the ignite-cache component. This is enabled by default.

Boolean

camel.component.ignite-cache.ignite

To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type.

String

camel.component.ignite-cache.ignite-configuration

Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type.

String

camel.component.ignite-cache.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.ignite-compute.configuration-resource

The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type.

String

camel.component.ignite-compute.enabled

Whether to enable auto configuration of the ignite-compute component. This is enabled by default.

Boolean

camel.component.ignite-compute.ignite

To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type.

String

camel.component.ignite-compute.ignite-configuration

Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type.

String

camel.component.ignite-compute.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.ignite-events.bridge-error-handler

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

camel.component.ignite-events.configuration-resource

The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type.

String

camel.component.ignite-events.enabled

Whether to enable auto configuration of the ignite-events component. This is enabled by default.

Boolean

camel.component.ignite-events.ignite

To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type.

String

camel.component.ignite-events.ignite-configuration

Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type.

String

camel.component.ignite-idgen.configuration-resource

The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type.

String

camel.component.ignite-idgen.enabled

Whether to enable auto configuration of the ignite-idgen component. This is enabled by default.

Boolean

camel.component.ignite-idgen.ignite

To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type.

String

camel.component.ignite-idgen.ignite-configuration

Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type.

String

camel.component.ignite-idgen.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.ignite-messaging.bridge-error-handler

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

camel.component.ignite-messaging.configuration-resource

The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type.

String

camel.component.ignite-messaging.enabled

Whether to enable auto configuration of the ignite-messaging component. This is enabled by default.

Boolean

camel.component.ignite-messaging.ignite

To use an existing 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 ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type.

String

camel.component.ignite-messaging.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.ignite-queue.configuration-resource

The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type.

String

camel.component.ignite-queue.enabled

Whether to enable auto configuration of the ignite-queue component. This is enabled by default.

Boolean

camel.component.ignite-queue.ignite

To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type.

String

camel.component.ignite-queue.ignite-configuration

Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type.

String

camel.component.ignite-queue.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.ignite-set.configuration-resource

The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type.

String

camel.component.ignite-set.enabled

Whether to enable auto configuration of the ignite-set component. This is enabled by default.

Boolean

camel.component.ignite-set.ignite

To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type.

String

camel.component.ignite-set.ignite-configuration

Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type.

String

camel.component.ignite-set.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.ignite-cache.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.ignite-compute.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.ignite-events.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.ignite-idgen.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.ignite-messaging.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.ignite-queue.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.ignite-set.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean