Ignite Queues

Since Camel 2.17

Only producer is supported

The Ignite Queue endpoint is one of camel-ignite endpoints which allows 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

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. 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.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for 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, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists 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