Ignite Compute
Since Camel 2.17
Only producer is supported
The Ignite Compute endpoint is one of camel-ignite endpoints which 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.
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.
Options
The Ignite Compute 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 |
The Ignite Compute endpoint is configured using URI syntax:
ignite-compute:endpointId
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
endpointId |
Required The endpoint ID (not used). |
String |
Query Parameters (8 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
clusterGroupExpression (producer) |
An expression that returns the Cluster Group for the IgniteCompute instance. |
ClusterGroupExpression |
|
computeName (producer) |
The name of the compute job, which will be set via IgniteCompute#withName(String). |
String |
|
executionType (producer) |
Required The compute operation to perform. Possible values: CALL, BROADCAST, APPLY, EXECUTE, RUN, AFFINITY_CALL, AFFINITY_RUN. The component expects different payload types depending on the operation. There are 7 enums and the value can be one of: CALL, BROADCAST, APPLY, EXECUTE, RUN, AFFINITY_CALL, AFFINITY_RUN |
IgniteComputeExecutionType |
|
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 |
propagateIncomingBodyIfNoReturnValue (producer) |
Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. |
true |
boolean |
taskName (producer) |
The task name, only applicable if using the IgniteComputeExecutionType#EXECUTE execution type. |
String |
|
timeoutMillis (producer) |
The timeout interval for triggered jobs, in milliseconds, which will be set via IgniteCompute#withTimeout(long). |
Long |
|
treatCollectionsAsCacheObjects (producer) |
Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc. |
false |
boolean |
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. |
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. |
Spring Boot Auto-Configuration
When using ignite-compute with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-ignite-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 44 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
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 |
|
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
Boolean |
|
The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type. |
Object |
||
Whether to enable auto configuration of the ignite-cache component. This is enabled by default. |
Boolean |
||
To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type. |
Ignite |
||
Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. |
IgniteConfiguration |
||
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 |
|
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 |
|
The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type. |
Object |
||
Whether to enable auto configuration of the ignite-compute component. This is enabled by default. |
Boolean |
||
To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type. |
Ignite |
||
Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. |
IgniteConfiguration |
||
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 |
|
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 |
|
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
Boolean |
|
The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type. |
Object |
||
Whether to enable auto configuration of the ignite-events component. This is enabled by default. |
Boolean |
||
To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type. |
Ignite |
||
Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. |
IgniteConfiguration |
||
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 |
|
The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type. |
Object |
||
Whether to enable auto configuration of the ignite-idgen component. This is enabled by default. |
Boolean |
||
To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type. |
Ignite |
||
Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. |
IgniteConfiguration |
||
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 |
|
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 |
|
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
Boolean |
|
The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type. |
Object |
||
Whether to enable auto configuration of the ignite-messaging component. This is enabled by default. |
Boolean |
||
To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type. |
Ignite |
||
Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. |
IgniteConfiguration |
||
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 |
|
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 |
|
The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type. |
Object |
||
Whether to enable auto configuration of the ignite-queue component. This is enabled by default. |
Boolean |
||
To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type. |
Ignite |
||
Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. |
IgniteConfiguration |
||
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 |
|
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 |
|
The resource from where to load the configuration. It can be a: URL, String or InputStream type. The option is a java.lang.Object type. |
Object |
||
Whether to enable auto configuration of the ignite-set component. This is enabled by default. |
Boolean |
||
To use an existing Ignite instance. The option is a org.apache.ignite.Ignite type. |
Ignite |
||
Allows the user to set a programmatic ignite configuration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. |
IgniteConfiguration |
||
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 |