Ignite Queues

Since Camel 2.17

Only producer is supported

The Ignite Queue endpoint is one of camel-ignite endpoints that allow you to interact with Ignite Queue data structures.

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.

For example, a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

You can configure components using:

  • the Component DSL.

  • in a configuration file (application.properties, *.yaml files, etc).

  • directly in the Java code.

Configuring Endpoint Options

You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders.

Property placeholders provide a few benefits:

  • They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.

  • They allow externalizing the configuration from the code.

  • They help the code to become more flexible and reusable.

The following two sections list all the options, firstly for the component followed by the endpoint.

Component Options

The Ignite Queues component supports 5 options, which are listed below.

Name Description Default Type

configurationResource (producer)

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

Object

ignite (producer)

To use an existing Ignite instance.

Ignite

igniteConfiguration (producer)

Allows the user to set a programmatic ignite configuration.

IgniteConfiguration

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

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

Endpoint Options

The Ignite Queues endpoint is configured using URI syntax:

ignite-queue:name

With the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

name (producer)

Required The queue name.

String

Query Parameters (7 parameters)

Name Description Default Type

capacity (producer)

The queue capacity. Default: non-bounded.

int

configuration (producer)

The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options.

CollectionConfiguration

operation (producer)

The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY, DRAIN, ELEMENT, PEEK, OFFER, POLL, TAKE, PUT.

Enum values:

  • CONTAINS

  • ADD

  • SIZE

  • REMOVE

  • ITERATOR

  • CLEAR

  • RETAIN_ALL

  • ARRAY

  • DRAIN

  • ELEMENT

  • PEEK

  • OFFER

  • POLL

  • TAKE

  • PUT

IgniteQueueOperation

propagateIncomingBodyIfNoReturnValue (producer)

Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void.

true

boolean

timeoutMillis (producer)

The queue timeout in milliseconds. Default: no timeout.

Long

treatCollectionsAsCacheObjects (producer)

Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc.

false

boolean

lazyStartProducer (producer (advanced))

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

Message Headers

The Ignite Queues component supports 4 message header(s), which is/are listed below:

Name Description Default Type

CamelIgniteQueueOperation (producer)

Constant: IGNITE_QUEUE_OPERATION

Allows you to dynamically change the queue operation.

Enum values:

  • CONTAINS

  • ADD

  • SIZE

  • REMOVE

  • ITERATOR

  • CLEAR

  • RETAIN_ALL

  • ARRAY

  • DRAIN

  • ELEMENT

  • PEEK

  • OFFER

  • POLL

  • TAKE

  • PUT

IgniteQueueOperation

CamelIgniteQueueMaxElements (producer)

Constant: IGNITE_QUEUE_MAX_ELEMENTS

When invoking the DRAIN operation, the amount of items to drain.

Integer

CamelIgniteQueueTransferredCount (producer)

Constant: IGNITE_QUEUE_TRANSFERRED_COUNT

The amount of items transferred as the result of the DRAIN operation.

Integer

CamelIgniteQueueTimeoutMillis (producer)

Constant: IGNITE_QUEUE_TIMEOUT_MILLIS

Dynamically sets the timeout in milliseconds to use when invoking the OFFER or POLL operations.

Long

Spring Boot Auto-Configuration

When using ignite-queue 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 37 options, which are listed below.

Name Description Default Type

camel.component.ignite-cache.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

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

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.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.

Ignite

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.

IgniteConfiguration

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.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

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.

Ignite

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.

IgniteConfiguration

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.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

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

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.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.

Ignite

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.

IgniteConfiguration

camel.component.ignite-idgen.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

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.

Ignite

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.

IgniteConfiguration

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.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

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

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.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.

Ignite

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.

IgniteConfiguration

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.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

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.

Ignite

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.

IgniteConfiguration

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.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

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.

Ignite

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.

IgniteConfiguration

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