...
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:
...
Code Block | ||||
---|---|---|---|---|
| ||||
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-ignite</artifactId> <version>${camel.version}</version> <!-- use the same version as your Camel core version --> </dependency> |
Warning | ||
---|---|---|
| ||
If running in an OSGi container, please don't miss the OSGi Support section below. |
Table of contents
Table of Contents | ||||
---|---|---|---|---|
|
CACHE: Ignite Cache endpoint
...
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. | 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 uses the following headers:
...
Code Block |
---|
ignite:compute:endpointId?executionType=...&option1=value1&option2=value2... |
...
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. See below for expected payload types per operation.
Options
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. |
Options
Option | Type | Default value | Description | Compulsory | Consumer/producer | ||||
---|---|---|---|---|---|---|---|---|---|
|
| - | |||||||
Option | Type | Default value | Description | Compulsory | Consumer/producer | ||||
|
| --- | The compute operation to perform. Possible values: CALL, BROADCAST, APPLY, EXECUTE, RUN, AFFINITY_CALL, AFFINITY_RUN. | Y | Producer | ||||
| ClusterGroupExpression | --- | An expression that returns the Cluster Group for the IgniteCompute instance. | N | Producer | ||||
| String | --- | The task name, only used when performing the EXECUTE if a ComputeTask is not passed in the payload. | N | Producer | ||||
| String | --- | The name for the IgniteCompute instances produced by this endpoint. | N | Producer | ||||
, AFFINITY_CALL, AFFINITY_RUN. The component expects different payload types depending on the operation. See above. | Y | Producer | |||||||
| ClusterGroupExpression | --- | An expression that returns the Cluster Group for the IgniteCompute instance |
| Long |
| The timeout for the compute job. | N | Producer |
|
Headers used
This endpoint uses the following headers:
String | --- | The task name, only used when performing the EXECUTE if a ComputeTask is not passed in the payload. | N | Producer | |
| String | --- | The name for the IgniteCompute instances produced by this endpoint. | N | Producer |
| Long |
| The timeout for the compute job. | N | Producer |
Headers used
This endpoint uses the following headers:
Header name | Constant | Expected type | Description | ||
---|---|---|---|---|---|
| |||||
Header name | Constant | Expected type | Description | ||
| IgniteConstants.IGNITE_COMPUTE_EXECUTION_TYPE | IgniteComputeExecutionType enum | Allows you to dynamically change the compute operation to perform. | ||
| IgniteConstants.IGNITE_COMPUTE_PARAMS | Any object or Collection of objects. | Parameters for APPLY, BROADCAST and EXECUTE operations. | ||
| 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. | ||
IgniteConstants.IGNITE_COMPUTE_ | AFFINITYEXECUTION_ | KEYTYPE | Object | Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations. |
Expected payload types
Each operation expects the indicated types:
IgniteComputeExecutionType enum | Allows you to dynamically change the compute operation to perform. | ||
| IgniteConstants.IGNITE_COMPUTE_PARAMS | Any object or Collection of objects. | Parameters for APPLY, BROADCAST and EXECUTE operations. |
| 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. |
| IgniteConstants.IGNITE_COMPUTE_AFFINITY_KEY | Object | Affinity key for the AFFINITY_CALL and AFFINITY_RUN operations |
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. |
MESSAGING: Ignite Messaging endpoint
The Ignite Messaging endpoint allows you to send and consume messages from an Ignite topic.
...
This endpoint supports producers (to send messages) and consumers (to receive messages).
Options
Option | Type | Default value | Description | Compulsory | Consumer/producer |
---|---|---|---|---|---|
clusterGroupExpression |
| --- | An expression that returns the Cluster Group for the IgniteMessaging instance. | N | Consumer and Producer |
sendMode |
| UNORDERED | The send mode to use. Possible values: | N | Producer |
timeout |
|
| The timeout for the send operation when using ordered messages. | N | Producer |
Headers used
This endpoint uses the following headers:
...
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 |
---|---|---|---|---|---|
| Set<Integer> or String |
| The event IDs to subscribe to. You can set a | N | Consumer |
| ClusterGroupExpression |
| An expression that returns the Cluster Group to be used by the IgniteEvents instance. | N | Consumer |
SETS: Ignite Sets endpoint
...
This endpoint only supports producers.
Options
Option | Type | Default value | Description | Compulsory | Consumer/producer |
---|---|---|---|---|---|
|
| --- | The operation to invoke on the Ignite Set. | N | Producer |
| CollectionConfiguration | empty CollectionConfiguration | The configuration for this data structure. You can also specify inner properties by using the For example: | N | Producer |
Headers used
This endpoint uses the following headers:
...
This endpoint only supports producers.
Options
Option | Type | Default value | Description | Compulsory | Consumer/producer |
---|---|---|---|---|---|
|
| --- | The operation to invoke on the Ignite Queue. Superseded by the Possible values: | N | Producer |
| CollectionConfiguration | empty CollectionConfiguration | The configuration for this data structure. You can also specify inner properties by using the For example: | 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:
...
This endpoint only supports producers.
Options
Option | Type | Default value | Description | Compulsory | Consumer/producer |
---|---|---|---|---|---|
|
|
| The operation to invoke on the Ignite ID Generator. Superseded by the Possible values: | N | Producer |
| CollectionConfiguration | empty CollectionConfiguration | The configuration for this data structure. You can also specify inner properties by using the For example: | N | Producer |
Initializing the Ignite component
...
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 | ||||
---|---|---|---|---|
|
Info |
---|
Apache Ignite supports OSGi as of 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 | ||||
---|---|---|---|---|
|