Atomix Map
Since Camel 2.20
Both producer and consumer are supported
The camel Atomix-Map component allows you to work with Atomix’s Distributed Map collection.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-atomix</artifactId>
<version>${camel-version}</version>
</dependency>
Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The Atomix Map component supports 18 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
The Atomix instance to use. |
Atomix |
||
The shared component configuration. |
AtomixMapConfiguration |
||
The path to the AtomixClient configuration. |
String |
||
The default action. Enum values:
|
PUT |
Action |
|
The key to use if none is set in the header or to listen for events for a specific key. |
Object |
||
The nodes the AtomixClient should connect to. |
List |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The resource ttl. |
long |
||
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 |
|
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 cluster wide default resource configuration. |
Properties |
||
The local default resource options. |
Properties |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
boolean |
|
The read consistency level. Enum values:
|
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
Endpoint Options
The Atomix Map endpoint is configured using URI syntax:
atomix-map:resourceName
with the following path and query parameters:
Query Parameters (18 parameters)
Name | Description | Default | Type |
---|---|---|---|
The Atomix instance to use. |
Atomix |
||
The Atomix configuration uri. |
String |
||
The default action. Enum values:
|
PUT |
Action |
|
The key to use if none is set in the header or to listen for events for a specific key. |
Object |
||
The address of the nodes composing the cluster. |
String |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The resource ttl. |
long |
||
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 |
|
To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
ExceptionHandler |
||
Sets the exchange pattern when the consumer creates an exchange. Enum values:
|
ExchangePattern |
||
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 |
|
The cluster wide default resource configuration. |
Properties |
||
The local default resource options. |
Properties |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
boolean |
|
The read consistency level. Enum values:
|
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
Headers
Name | Type | Values | Description |
---|---|---|---|
CamelAtomixResourceAction |
AtomixMap.Action |
|
The action to perform |
CamelAtomixResourceKey |
Object |
- |
The key to operate on |
CamelAtomixResourceValue |
Object |
- |
The value, if missing In Body is used |
CamelAtomixResourceOldValue |
Object |
- |
The old value |
CamelAtomixResourceTTL |
String / long |
- |
The entry TTL |
CamelAtomixResourceReadConsistency |
ReadConsistency |
|
The read consistency level |
Configuring the component to connect to an Atomix cluster
The nodes of the Atomix cluster you want to join can be se at Endpoint or component level (recommended), below some examples:
-
Endpoint:
<beans xmlns="..."> <camelContext xmlns="http://camel.apache.org/schema/spring"> <route> <from uri="direct:start"/> <to uri="atomix-map:myMap?nodes=node-1.atomix.cluster:8700,node-2.atomix.cluster:8700"/> </route> </camelContext> </beans>
-
Component:
<beans xmlns="..."> <bean id="atomix-map" class="org.apache.camel.component.atomix.client.map.AtomixMapComponent"> <property name="nodes" value="nodes=node-1.atomix.cluster:8700,node-2.atomix.cluster:8700"/> </bean> <camelContext xmlns="http://camel.apache.org/schema/spring"> <route> <from uri="direct:start"/> <to uri="atomix-map:myMap"/> </route> </camelContext> </beans>
Examples
Producer Example
PUT an element with TTL of 1 second:
FluentProducerTemplate.on(context)
.withHeader(AtomixClientConstants.RESOURCE_ACTION, AtomixMap.Action.PUT)
.withHeader(AtomixClientConstants.RESOURCE_KEY, key)
.withHeader(AtomixClientConstants.RESOURCE_TTL, "1s")
.withBody(val)
.to("atomix-map:map")
.send();
Spring Boot Auto-Configuration
When using atomix-map 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-atomix-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 121 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
The address of the node - node only. |
String |
||
Custom service attributes. |
Map |
||
The Atomix configuration uri. |
String |
||
Sets if the atomix cluster service should be enabled or not, default is false. |
false |
Boolean |
|
Sets if the local member should join groups as PersistentMember or not (node only). |
Boolean |
||
The cluster id. |
String |
||
Sets the cluster mode. |
AtomixClusterServiceConfiguration$Mode |
||
The address of the nodes composing the cluster. |
Set |
||
Service lookup order/priority. |
Integer |
||
The storage mode - node only. |
StorageLevel |
||
The storage directory - node only. |
String |
||
The Atomix instance to use. The option is a io.atomix.Atomix type. |
Atomix |
||
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 shared component configuration. The option is a org.apache.camel.component.atomix.client.map.AtomixMapConfiguration type. |
AtomixMapConfiguration |
||
The path to the AtomixClient configuration. |
String |
||
The default action. |
AtomixMap$Action |
||
The cluster wide default resource configuration. The option is a java.util.Properties type. |
Properties |
||
The local default resource options. The option is a java.util.Properties type. |
Properties |
||
Whether to enable auto configuration of the atomix-map component. This is enabled by default. |
Boolean |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
Boolean |
|
The key to use if none is set in the header or to listen for events for a specific key. The option is a java.lang.Object type. |
Object |
||
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 |
|
The nodes the AtomixClient should connect to. |
List |
||
The read consistency level. |
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The resource ttl. The option is a long type. |
Long |
||
The Atomix instance to use. The option is a io.atomix.Atomix type. |
Atomix |
||
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 broadcast type. |
AtomixMessaging$BroadcastType |
||
The messaging channel name. |
String |
||
The shared component configuration. The option is a org.apache.camel.component.atomix.client.messaging.AtomixMessagingConfiguration type. |
AtomixMessagingConfiguration |
||
The path to the AtomixClient configuration. |
String |
||
The default action. |
AtomixMessaging$Action |
||
The cluster wide default resource configuration. The option is a java.util.Properties type. |
Properties |
||
The local default resource options. The option is a java.util.Properties type. |
Properties |
||
Whether to enable auto configuration of the atomix-messaging component. This is enabled by default. |
Boolean |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
Boolean |
|
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 |
|
The Atomix Group member name. |
String |
||
The nodes the AtomixClient should connect to. |
List |
||
The read consistency level. |
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The Atomix instance to use. The option is a io.atomix.Atomix type. |
Atomix |
||
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 shared component configuration. The option is a org.apache.camel.component.atomix.client.multimap.AtomixMultiMapConfiguration type. |
AtomixMultiMapConfiguration |
||
The path to the AtomixClient configuration. |
String |
||
The default action. |
AtomixMultiMap$Action |
||
The cluster wide default resource configuration. The option is a java.util.Properties type. |
Properties |
||
The local default resource options. The option is a java.util.Properties type. |
Properties |
||
Whether to enable auto configuration of the atomix-multimap component. This is enabled by default. |
Boolean |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
Boolean |
|
The key to use if none is set in the header or to listen for events for a specific key. The option is a java.lang.Object type. |
Object |
||
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 |
|
The nodes the AtomixClient should connect to. |
List |
||
The read consistency level. |
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The resource ttl. The option is a long type. |
Long |
||
The Atomix instance to use. The option is a io.atomix.Atomix type. |
Atomix |
||
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 shared component configuration. The option is a org.apache.camel.component.atomix.client.queue.AtomixQueueConfiguration type. |
AtomixQueueConfiguration |
||
The path to the AtomixClient configuration. |
String |
||
The default action. |
AtomixQueue$Action |
||
The cluster wide default resource configuration. The option is a java.util.Properties type. |
Properties |
||
The local default resource options. The option is a java.util.Properties type. |
Properties |
||
Whether to enable auto configuration of the atomix-queue component. This is enabled by default. |
Boolean |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
Boolean |
|
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 |
|
The nodes the AtomixClient should connect to. |
List |
||
The read consistency level. |
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The Atomix instance to use. The option is a io.atomix.Atomix type. |
Atomix |
||
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 shared component configuration. The option is a org.apache.camel.component.atomix.client.set.AtomixSetConfiguration type. |
AtomixSetConfiguration |
||
The path to the AtomixClient configuration. |
String |
||
The default action. |
AtomixSet$Action |
||
The cluster wide default resource configuration. The option is a java.util.Properties type. |
Properties |
||
The local default resource options. The option is a java.util.Properties type. |
Properties |
||
Whether to enable auto configuration of the atomix-set component. This is enabled by default. |
Boolean |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
Boolean |
|
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 |
|
The nodes the AtomixClient should connect to. |
List |
||
The read consistency level. |
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The resource ttl. The option is a long type. |
Long |
||
The Atomix instance to use. The option is a io.atomix.Atomix type. |
Atomix |
||
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 shared component configuration. The option is a org.apache.camel.component.atomix.client.value.AtomixValueConfiguration type. |
AtomixValueConfiguration |
||
The path to the AtomixClient configuration. |
String |
||
The default action. |
AtomixValue$Action |
||
The cluster wide default resource configuration. The option is a java.util.Properties type. |
Properties |
||
The local default resource options. The option is a java.util.Properties type. |
Properties |
||
Whether to enable auto configuration of the atomix-value component. This is enabled by default. |
Boolean |
||
Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored. |
false |
Boolean |
|
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 |
|
The nodes the AtomixClient should connect to. |
List |
||
The read consistency level. |
ReadConsistency |
||
Cluster wide resources configuration. |
Map |
||
Local resources configurations. |
Map |
||
The header that wil carry the result. |
String |
||
The class name (fqn) of the Atomix transport. |
io.atomix.catalyst.transport.netty.NettyTransport |
String |
|
The resource ttl. The option is a long type. |
Long |