Entaxy Docs

Atomix MultiMap

Since Camel 2.20

Only producer is supported

The camel Atomix-Multimap component allows you to work with Atomix’s Distributed MultiMap 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>

URI format

    atomix-multimap:multiMapName

The Atomix MultiMap component supports 17 options, which are listed below.

Name Description Default Type

atomix (producer)

The Atomix instance to use

Atomix

configuration (producer)

The shared component configuration

AtomixMultiMapConfiguration

configurationUri (producer)

The path to the AtomixClient configuration

String

defaultAction (producer)

The default action. The value can be one of: PUT, GET, CLEAR, SIZE, CONTAINS_KEY, IS_EMPTY, REMOVE, REMOVE_VALUE

PUT

Action

key (producer)

The key to use if none is set in the header or to listen for events for a specific key.

Object

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

nodes (producer)

The nodes the AtomixClient should connect to

List

resultHeader (producer)

The header that wil carry the result.

String

transportClassName (producer)

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

ttl (producer)

The resource ttl.

long

basicPropertyBinding (advanced)

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

defaultResourceConfig (advanced)

The cluster wide default resource configuration.

Properties

defaultResourceOptions (advanced)

The local default resource options.

Properties

ephemeral (advanced)

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

readConsistency (advanced)

The read consistency level. The value can be one of: ATOMIC, ATOMIC_LEASE, SEQUENTIAL, LOCAL

ReadConsistency

resourceConfigs (advanced)

Cluster wide resources configuration.

Map

resourceOptions (advanced)

Local resources configurations

Map

The Atomix MultiMap endpoint is configured using URI syntax:

atomix-multimap:resourceName

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

resourceName

Required The distributed resource name

String

Query Parameters (17 parameters):

Name Description Default Type

atomix (producer)

The Atomix instance to use

Atomix

configurationUri (producer)

The Atomix configuration uri.

String

defaultAction (producer)

The default action. The value can be one of: PUT, GET, CLEAR, SIZE, CONTAINS_KEY, IS_EMPTY, REMOVE, REMOVE_VALUE

PUT

Action

key (producer)

The key to use if none is set in the header or to listen for events for a specific key.

Object

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

nodes (producer)

The address of the nodes composing the cluster.

String

resultHeader (producer)

The header that wil carry the result.

String

transportClassName (producer)

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

ttl (producer)

The resource ttl.

long

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

defaultResourceConfig (advanced)

The cluster wide default resource configuration.

Properties

defaultResourceOptions (advanced)

The local default resource options.

Properties

ephemeral (advanced)

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

readConsistency (advanced)

The read consistency level. The value can be one of: ATOMIC, ATOMIC_LEASE, SEQUENTIAL, LOCAL

ReadConsistency

resourceConfigs (advanced)

Cluster wide resources configuration.

Map

resourceOptions (advanced)

Local resources configurations

Map

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean