Page History

...

Apache Ignite In-Memory Data Fabric is a high-performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies. It is designed to deliver uncompromised performance for a wide set of in-memory computing use cases from high performance computing, to the industry most advanced data grid, highly available service grid, and streaming. See all features.

Image Added

This component offers seven endpoints to cover much of Ignite's functionality:

Ignite Cache.
Ignite Compute.
Ignite Messaging.
Ignite Events.
Ignite Sets.
Ignite Queues.
Ignite ID Generator.

To use this component, add the following dependency to your pom.xml:

Code Block

	xml
	xml

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-ignite</artifactId>
    <version>${camel.version}</version> <!-- use the same version as your Camel core version -->
</dependency>

URI formats and options

Warning

title	Running in OSGi

If running in an OSGi container, please don't miss the OSGi Support section below.

CACHE: Ignite Cache endpoint

This endpoint allows you to interact with an IgniteCache Ignite Cache:

Code Block
ignite:cache:cacheName?option1=value1&option2=value2...

Offers both a Producer (to invoke cache operations on an Ignite cache) and a Consumer (to consume changes from a continuous query).

The cache value is always the body of the message, whereas the cache key is always stored in the IgniteConstants.IGNITE_CACHE_KEY message header.

Even if you configure a fixed operation in the endpoint URI, you can vary it per-exchange by setting the IgniteConstants.IGNITE_CACHE_OPERATION message header.

Options

Option	Type	Default value	Description	Compulsory	Consumer/producer
`operation`	IgniteCacheOperation enum	---	Cache operation to perform. Possible values: GET, PUT, REMOVE, SIZE, REBALANCE, QUERY, CLEAR.	N	Producer
`failIfInexistentCache`	boolean	false	Whether to fail the initialization if the cache doesn't exist.	N	Producer
`cachePeekMode`	CachePeekMode (Ignite) enum	ALL	The cache peek mode used for SIZE operations.	N	Producer
`query`	Query	---	The query used for QUERY operations (as a producer) or to launch the continuous query (as a consumer). You can use a reference to a registry bean with a syntax like: ?query=#myQuery.	Y for the consumer / N for the producer	Producer (for QUERY operation) and Consumer
`remoteFilter`	CacheEntryEventSerializableFilter	---	An optional remote filter for the continuous query consumer. You can use a reference to a registry bean with a syntax like: ?remoteFilter=#myRemoteFilter#myRemoteFilter.	N	Consumer
`oneExchangePerUpdate`	boolean	true	Whether to send one exchange per cache update, even if multiple changes arrive in a group.	N	Consumer
`fireExistingQueryResults`	boolean	false	When starting the continuous query consumer, whether to fire existing cache results.	N	Consumer
`autoUnsubscribe`	boolean	ContinuousQuery.DFLT_AUTO_UNSUBSCRIBE	Auto-unsubscribe flag on the Continuous Query (see Ignite docs).	N	Consumer
`pageSize`	int	ContinuousQuery.DFLT_PAGE_SIZE	Page size on the Continuous Query (see Ignite docs).	N	Consumer
`timeInterval`	long	ContinuousQuery.DFLT_TIME_INTERVAL	Time interval in millis on the Continuous Query (see Ignite docs).	N	Consumer

...

Headers used

This endpoint allows you to run compute operations on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary.

Code Block
ignite:compute:endpointId?option1=value1&option2=value2...

This endpoint only supports producers.

...

uses the following headers:

CamelIgniteComputeExecutionType_COMPUTE_EXECUTION_TYPEIgniteComputeExecutionType compute performCamelIgniteComputeParameters COMPUTEPARAMSCamelIgniteComputeReducerCOMPUTEREDUCER

Header name	Constant	Expected type	Description
`CamelIgniteCacheKey`	`IgniteConstants.IGNITE_CACHE_KEY`	`String`	The cache key for the entry value in the message body.
`CamelIgniteCacheQuery`	`IgniteConstants.IGNITE`	`_CACHE_QUERY`	`Query`	The query to run (producer) when invoking the QUERY operation.
`CamelIgniteCacheOperation`	`IgniteConstants.IGNITE_CACHE_OPERATION`	`IgniteCacheOperation`	`enum`	Allows you to dynamically change the	cache operation to	execute (producer).
`CamelIgniteCachePeekMode`	`IgniteConstants.IGNITE_CACHE_`	`PEEK_`	Any object or Collection of objects.	Parameters for APPLY, BROADCAST and EXECUTE operations.	`MODE`	`CachePeekMode enum`	Allows you to dynamically change the cache peek mode when running the SIZE operation.
`CamelIgniteCacheEventType`		`IgniteConstants.IGNITE_CACHE_`	`EVENT_`	IgniteReducer	Reducer for the APPLY and CALL operations.	`TYPE`	`int (EventType constants)`	This header carries the received event type when using the continuous query consumer.
`CamelIgniteCacheNameCamelIgniteComputeAffinityCacheName`	`IgniteConstants.IGNITE_COMPUTE_AFFINITY_CACHE_NAME`	`String`Affinity	This header carries the cache name for the AFFINITY_CALL and AFFINITY_RUN operations. which a continuous query event was received (consumer). It does not allow you to dynamically change the cache against which a producer operation is performed. Use EIPs for that (e.g. recipient list, dynamic router).
`CamelIgniteCacheOldValueCamelIgniteComputeAffinityKey`	`IgniteConstants.IGNITE_COMPUTECACHE_AFFINITYOLD_KEY`	Object	Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations.

...

VALUE Object This header carries the old cache value when passed in the incoming cache event (consumer).

COMPUTE: Ignite Compute endpoint

This endpoint allows you to run compute operations on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary.

Code Block
ignite:compute:endpointId?executionType=...&option1=value1&option2=value2...

This endpoint only supports producers.

The host part of the endpoint URI is a symbolic endpoint ID, it is not used for any purposes.

The endpoint tries to run the object passed in the body of the IN message as the compute job. It expects different payload types depending on the execution type.

Expected payload types

Each operation expects the indicated types:

Operation	Expected payloads
CALL	Collection of IgniteCallable, or a single IgniteCallable.
BROADCAST	IgniteCallable, IgniteRunnable, IgniteClosure.
APPLY	IgniteClosure.
EXECUTE	ComputeTask, Class<? extends ComputeTask> or an object representing parameters if the taskName option is not null.
RUN	A Collection of IgniteRunnables, or a single IgniteRunnable.
AFFINITY_CALL	IgniteCallable.
AFFINITY_RUN	IgniteRunnable.

...

Option	Type	Default value	Description	Compulsory	Consumer/producer
`executionType`	`IgniteComputeExecutionType enum`	`---`	The compute operation to perform. Possible values: CALL, BROADCAST, APPLY APPLY, EXECUTE EXECUTE, RUN RUN, AFFINITY AFFINITY_CALL, AFFINITY AFFINITY_RUN. The component expects different payload types depending on the operation. See above.	Y	Producer
`clusterGroupExpression`	`ClusterGroupExpression`	`---`	An expression that returns the Cluster Group for the IgniteCompute instance.	N	Producer
`taskName`	`String`	`---`	The task name, only used when performing the EXECUTE if a ComputeTask is not passed in the payload.	N	Producer
`computeName`	`String`	`---`	The name for the IgniteCompute instances produced by this endpoint.	N	Producer
`timeoutMillis`	`Long`	`---`	The timeout for the compute job.	N	Producer

Options

Headers used

This endpoint uses the following headers:

Header name	Constant	Expected type	Description
`CamelIgniteComputeExecutionType`	`IgniteConstants.IGNITE_COMPUTE_EXECUTION_TYPE`	IgniteComputeExecutionType enum	Allows you to dynamically change the compute operation to perform.
`CamelIgniteComputeParameters`	`IgniteConstants.IGNITE_COMPUTE_PARAMS`	Any object or Collection of objects.	Parameters for APPLY, BROADCAST and EXECUTE operations.
`CamelIgniteComputeReducer`	`IgniteConstants.IGNITE_COMPUTE_REDUCER`	IgniteReducer	Reducer for the APPLY and CALL operations.
`CamelIgniteComputeAffinityCacheName`	`IgniteConstants.IGNITE_COMPUTE_AFFINITY_CACHE_NAME`	String	Affinity cache name for the AFFINITY_CALL and AFFINITY_RUN operations.
`CamelIgniteComputeAffinityKey`	`IgniteConstants.IGNITE_COMPUTE_AFFINITY_KEY`	Object	Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations.

MESSAGING: Ignite Messaging endpoint

The Ignite Messaging endpoint allows you to send and consume messages from an Ignite topic.

...

Code Block
ignite:messaging:topicName?option1=value1&option2=value2...

This endpoint supports producers (to send messages) and consumers (to receive messages).

Options

Option Type Default value Description Compulsory Consumer/producer

clusterGroupExpression

ClusterGroupExpression

---

An expression that returns the Cluster Group for the IgniteMessaging instance.

N

Consumer and Producer

sendMode

IgniteMessagingSendMode enum

UNORDERED

The send mode to use.

Possible values: UNORDERED, ORDERED.

N

Producer

timeout

Long

---

The timeout for the send operation when using ordered messages.

N

Producer

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

EVENTS: Ignite Events endpoint

The Ignite Events endpoint allows you to receive events from the Ignite cluster by creating a local event listener.

Code Block
ignite:events:endpointId?option1=value1&option2=value2...

This endpoint only supports consumers.

The Exchanges created by this consumer put the received Event object into the body of the IN message.

Options

Option	Type	Default value	Description	Compulsory	Consumer/producer
`events`	`Set<Integer> or String`	`EventType.EVTS_ALL`	The event IDs to subscribe to. You can set a `Set<Integer>` directly where the IDs are the different constants in `org.apache.ignite.events.EventType`, or you can specify a comma-separated list of constant names. For example: `EVT_CACHE_ENTRY_CREATED,EVT_CACHE_OBJECT_REMOVED,EVT_IGFS_DIR_CREATED`.	N	Consumer
`clusterGroupExpression`	`ClusterGroupExpression`	`---`	An expression that returns the Cluster Group to be used by the IgniteEvents instance.	N	Consumer

SETS: Ignite Sets endpoint

The Ignite Sets endpoint allows you to interact with Ignite Set data structures.

Code Block
ignite:sets:setName?option1=value1&option2=value2...

This endpoint only supports producers.

Options

Option Type Default value Description Compulsory Consumer/producer

operation

IgniteSetOperation enum

---

The operation to invoke on the Ignite Set.
Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message.
Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY.

N

Producer

configuration

CollectionConfiguration

empty CollectionConfiguration

The configuration for this data structure. You can also specify inner properties by using the config. prefix.

For example: ?config.backups=4

N

Producer

Headers used

This endpoint uses the following headers:

Header name	Constant	Expected type	Description
`CamelIgniteSetsOperation`	`IgniteConstants.IGNITE_SETS_OPERATION`	`IgniteSetOperation` enum	Allows you to dynamically change the set operation.

QUEUE: Ignite Queue endpoint

The Ignite Queue endpoint allows you to interact with Ignite Queue data structures.

Code Block
ignite:queue:queueName?option1=value1&option2=value2...

This endpoint only supports producers.

Options

Option	Type	Default value	Description	Compulsory	Consumer/producer
`operation`	`IgniteQueueOperation` enum	---	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`.	N	Producer
`configuration`	CollectionConfiguration	empty `CollectionConfiguration`	The configuration for this data structure. You can also specify inner properties by using the `config.` prefix. For example: `?config.backups=4`	N	Producer
`timeoutMillis`	`Long`	---	The timeout in milliseconds to use when invoking the OFFER or POLL operations.	N	Producer
`capacity`	`int`	--- (unbounded)	The queue capacity if you'd like to use a bounded queue.	N	Producer

Headers used

This endpoint uses the following headers:

Header name	Constant	Expected type	Description
`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.

IDGEN: Ignite ID Generator endpoint

The Ignite ID Generator endpoint allows you to interact with Ignite Atomic Sequences and ID Generators.

Code Block
ignite:idgen:sequenceName?option1=value1&option2=value2...

This endpoint only supports producers.

Options

Option Type Default value Description Compulsory Consumer/producer

operation

IgniteIdGenOperation enum

---

The operation to invoke on the Ignite ID Generator.

Superseded by the IgniteConstants.IGNITE_IDGEN_OPERATION header in the IN message.

Possible values: ADD_AND_GET, GET, GET_AND_ADD, GET_AND_INCREMENT, INCREMENT_AND_GET.

N

Producer

configuration

CollectionConfiguration

empty CollectionConfiguration

The configuration for this data structure. You can also specify inner properties by using the config. prefix.

For example: ?config.backups=4

N

Producer

Initializing the Ignite component

...

IgniteComponent#fromIgnite(Ignite)
IgniteComponent#fromConfiguration(IgniteConfiguration)
IgniteComponent#fromInputStream(InputStream)
IgniteComponent#fromUrl(URL)
IgniteComponent#fromLocation(String)

You may use those methods to quickly create an IgniteComponent with your chosen configuration technique.

General options

All endpoints share the following options:

Option	Type	Default value	Description
`propagateIncomingBodyIfNoReturnValue`	`boolean`	`true`	If the underlying Ignite operation returns void (no return type), this flag determines whether the producer will copy the IN body into the OUT body.
`treatCollectionsAsCacheObjects`	`boolean`	`false`		Some Ignite operations can deal with multiple elements at once, if passed a Collection. Enabling this option will treat Collections as a single object, invoking the operation variant for cardinality 1.

OSGi Support
Anchor
osgi-support
osgi-support

Info
Apache Ignite supports OSGi from version 1.5.0.final onwards.

NOTES when installing on Apache Karaf:

Installing the camel-ignite feature will require the Ignite feature repository to be present.
You must have exported from the JRE (system bundle) some low-level, non-standard packages that Ignite requires.

Please refer to the OSGi section in the Ignite documentation for more information.

Include Page

	Endpoint See Also
	Endpoint See Also

Child pages

Versions Compared

Old Version 3

New Version Current

Key

URI formats and options

Table of contents

CACHE: Ignite Cache endpoint

Options

Headers used

COMPUTE: Ignite Compute endpoint

Expected payload types

Options

Headers used

MESSAGING: Ignite Messaging endpoint

Options

Headers used

EVENTS: Ignite Events endpoint

Options

SETS: Ignite Sets endpoint

Options

Headers used

QUEUE: Ignite Queue endpoint

Options

Headers used

IDGEN: Ignite ID Generator endpoint

Options

Initializing the Ignite component

General options

OSGi Support
Anchor
osgi-support
osgi-support

Child pages

Page History

Versions Compared

Old Version 3

New Version Current

Key

URI formats and options

Table of contents

CACHE: Ignite Cache endpoint

Options

Headers used

COMPUTE: Ignite Compute endpoint

Expected payload types

Options

Headers used

MESSAGING: Ignite Messaging endpoint

Options

Headers used

EVENTS: Ignite Events endpoint

Options

SETS: Ignite Sets endpoint

Options

Headers used

QUEUE: Ignite Queue endpoint

Options

Headers used

IDGEN: Ignite ID Generator endpoint

Options

Initializing the Ignite component

General options

OSGi Support Anchorosgi-supportosgi-support

OSGi Support
Anchor
osgi-support
osgi-support