Ignite

Camel Ignite component

Available as of Camel 2.17

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.

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:

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

Table of contents

CACHE: Ignite Cache endpoint

This endpoint allows you to interact with an Ignite Cache:

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

Headers used

This endpoint uses the following headers:

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. 

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:

CALL

BROADCAST

APPLY

EXECUTE

RUN

AFFINITY_CALL

AFFINITY_RUN

Options

Headers used

This endpoint uses the following headers:

MESSAGING: Ignite Messaging endpoint

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

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

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

Options

Headers used

This endpoint uses the following headers:

EVENTS: Ignite Events endpoint

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

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

SETS: Ignite Sets endpoint

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

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

This endpoint only supports producers.

Options

Headers used

This endpoint uses the following headers:

QUEUE: Ignite Queue endpoint

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

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

This endpoint only supports producers.

Options

---

CollectionConfiguration

Headers used

This endpoint uses the following headers:

IDGEN: Ignite ID Generator endpoint

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

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

This endpoint only supports producers.

Options

---

CollectionConfiguration

Initializing the Ignite component

Each instance of the Ignite component is associated with an underlying org.apache.ignite.Ignite instance. You can interact with two Ignite clusters by initializing two instances of the Ignite component and binding them to different IgniteConfigurations. There are 3 ways to initialize the Ignite component:

• By passing in an existing org.apache.ignite.Ignite instance. Here's an example using Spring config:

<bean name="ignite" class="org.apache.camel.component.ignite.IgniteComponent">
   <property name="ignite" ref="ignite" />
</bean>

• By passing in an IgniteConfiguration, either constructed programmatically or through inversion of control (e.g. Spring, Blueprint, etc.). Here's an example using Spring config:

<bean name="ignite" class="org.apache.camel.component.ignite.IgniteComponent">
   <property name="igniteConfiguration">
      <bean class="org.apache.ignite.configuration.IgniteConfiguration">
         [...]
      </bean>
   </property>
</bean>

• By passing in a URL, InputStream or String URL to a Spring-based configuration file. In all three cases, you inject them in the same property called configurationResource. Here's an example using Spring config:

<bean name="ignite" class="org.apache.camel.component.ignite.IgniteComponent">
   <property name="configurationResource" value="file:[...]/ignite-config.xml" />
</bean>

Additionally, if using Camel programmatically, there are several convenience static methods in IgniteComponent that return a component out of any of these configuration options:

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

General options

All endpoints share the following options:

OSGi Support

NOTES when installing on Apache Karaf:

1. Installing the camel-ignite feature will require the Ignite feature repository to be present.
2. 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.