Chapter 152. Ignite Queues Component

Available as of Camel version 2.17

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

This endpoint only supports producers.

152.1. Options

The Ignite Queues component supports 4 options which are listed below.

NameDescriptionDefaultType

ignite (producer)

Sets the Ignite instance.

 

Ignite

configurationResource (producer)

Sets the resource from where to load the configuration. It can be a: URI, String (URI) or an InputStream.

 

Object

igniteConfiguration (producer)

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 Queues endpoint is configured using URI syntax:

ignite-queue:name

with the following path and query parameters:

152.1.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

name

Required The queue name.

 

String

152.1.2. Query Parameters (7 parameters):

NameDescriptionDefaultType

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.

 

IgniteQueueOperation

propagateIncomingBodyIfNo ReturnValue (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

treatCollectionsAsCache Objects (producer)

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

false

boolean

synchronous (advanced)

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

false

boolean

152.1.3. Headers used

This endpoint uses the following headers:

Header nameConstantExpected typeDescription

CamelIgniteQueueOperation

IgniteConstants.IGNITE_QUEUE_OPERATION

IgniteQueueOperation enum

Allows you to dynamically change the queue operation.

CamelIgniteQueueMaxElements

IgniteConstants.IGNITE_QUEUE_MAX_ELEMENTS

Integer or int

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

CamelIgniteQueueTransferredCount

IgniteConstants.IGNITE_QUEUE_TRANSFERRED_COUNT

Integer or int

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

CamelIgniteQueueTimeoutMillis

IgniteConstants.IGNITE_QUEUE_TIMEOUT_MILLIS

Long or long

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