Atomix Set Component

Since Camel 2.20

Both producer and consumer is supported

The camel Atomix-Set component allows you to work with Atomix’s Distributed Set 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-set:setName

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

Name Description Default Type

atomix (common)

The Atomix instance to use

Atomix

configuration (common)

The shared component configuration

AtomixSetConfiguration

configurationUri (common)

The path to the AtomixClient configuration

String

defaultAction (common)

The default action. The value can be one of: ADD, CLEAR, CONTAINS, IS_EMPTY, REMOVE, SIZE

ADD

Action

nodes (common)

The nodes the AtomixClient should connect to

List

resultHeader (common)

The header that wil carry the result.

String

transportClassName (common)

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

ttl (common)

The resource ttl.

long

bridgeErrorHandler (consumer)

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

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

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 Set endpoint is configured using URI syntax:

atomix-set: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 (19 parameters):

Name Description Default Type

atomix (common)

The Atomix instance to use

Atomix

configurationUri (common)

The Atomix configuration uri.

String

defaultAction (common)

The default action. The value can be one of: ADD, CLEAR, CONTAINS, IS_EMPTY, REMOVE, SIZE

ADD

Action

nodes (common)

The address of the nodes composing the cluster.

String

resultHeader (common)

The header that wil carry the result.

String

transportClassName (common)

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

ttl (common)

The resource ttl.

long

bridgeErrorHandler (consumer)

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

exceptionHandler (consumer)

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

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut

ExchangePattern

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

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

Spring Boot Auto-Configuration

When using atomix 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

camel.component.atomix-map.atomix

The Atomix instance to use. The option is a io.atomix.Atomix type.

String

camel.component.atomix-map.basic-property-binding

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

false

Boolean

camel.component.atomix-map.bridge-error-handler

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

camel.component.atomix-map.configuration

The shared component configuration. The option is a org.apache.camel.component.atomix.client.map.AtomixMapConfiguration type.

String

camel.component.atomix-map.configuration-uri

The path to the AtomixClient configuration

String

camel.component.atomix-map.default-action

The default action.

AtomixMap$Action

camel.component.atomix-map.default-resource-config

The cluster wide default resource configuration. The option is a java.util.Properties type.

String

camel.component.atomix-map.default-resource-options

The local default resource options. The option is a java.util.Properties type.

String

camel.component.atomix-map.enabled

Whether to enable auto configuration of the atomix-map component. This is enabled by default.

Boolean

camel.component.atomix-map.ephemeral

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

camel.component.atomix-map.key

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.

String

camel.component.atomix-map.lazy-start-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

camel.component.atomix-map.nodes

The nodes the AtomixClient should connect to

List

camel.component.atomix-map.read-consistency

The read consistency level.

ReadConsistency

camel.component.atomix-map.resource-configs

Cluster wide resources configuration.

Map

camel.component.atomix-map.resource-options

Local resources configurations

Map

camel.component.atomix-map.result-header

The header that wil carry the result.

String

camel.component.atomix-map.transport-class-name

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

camel.component.atomix-map.ttl

The resource ttl.

Long

camel.component.atomix-messaging.atomix

The Atomix instance to use. The option is a io.atomix.Atomix type.

String

camel.component.atomix-messaging.basic-property-binding

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

false

Boolean

camel.component.atomix-messaging.bridge-error-handler

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

camel.component.atomix-messaging.broadcast-type

The broadcast type.

AtomixMessaging$BroadcastType

camel.component.atomix-messaging.channel-name

The messaging channel name

String

camel.component.atomix-messaging.configuration

The shared component configuration. The option is a org.apache.camel.component.atomix.client.messaging.AtomixMessagingConfiguration type.

String

camel.component.atomix-messaging.configuration-uri

The path to the AtomixClient configuration

String

camel.component.atomix-messaging.default-action

The default action.

AtomixMessaging$Action

camel.component.atomix-messaging.default-resource-config

The cluster wide default resource configuration. The option is a java.util.Properties type.

String

camel.component.atomix-messaging.default-resource-options

The local default resource options. The option is a java.util.Properties type.

String

camel.component.atomix-messaging.enabled

Whether to enable auto configuration of the atomix-messaging component. This is enabled by default.

Boolean

camel.component.atomix-messaging.ephemeral

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

camel.component.atomix-messaging.lazy-start-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

camel.component.atomix-messaging.member-name

The Atomix Group member name

String

camel.component.atomix-messaging.nodes

The nodes the AtomixClient should connect to

List

camel.component.atomix-messaging.read-consistency

The read consistency level.

ReadConsistency

camel.component.atomix-messaging.resource-configs

Cluster wide resources configuration.

Map

camel.component.atomix-messaging.resource-options

Local resources configurations

Map

camel.component.atomix-messaging.result-header

The header that wil carry the result.

String

camel.component.atomix-messaging.transport-class-name

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

camel.component.atomix-multimap.atomix

The Atomix instance to use. The option is a io.atomix.Atomix type.

String

camel.component.atomix-multimap.basic-property-binding

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

false

Boolean

camel.component.atomix-multimap.configuration

The shared component configuration. The option is a org.apache.camel.component.atomix.client.multimap.AtomixMultiMapConfiguration type.

String

camel.component.atomix-multimap.configuration-uri

The path to the AtomixClient configuration

String

camel.component.atomix-multimap.default-action

The default action.

AtomixMultiMap$Action

camel.component.atomix-multimap.default-resource-config

The cluster wide default resource configuration. The option is a java.util.Properties type.

String

camel.component.atomix-multimap.default-resource-options

The local default resource options. The option is a java.util.Properties type.

String

camel.component.atomix-multimap.enabled

Whether to enable auto configuration of the atomix-multimap component. This is enabled by default.

Boolean

camel.component.atomix-multimap.ephemeral

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

camel.component.atomix-multimap.key

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.

String

camel.component.atomix-multimap.lazy-start-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

camel.component.atomix-multimap.nodes

The nodes the AtomixClient should connect to

List

camel.component.atomix-multimap.read-consistency

The read consistency level.

ReadConsistency

camel.component.atomix-multimap.resource-configs

Cluster wide resources configuration.

Map

camel.component.atomix-multimap.resource-options

Local resources configurations

Map

camel.component.atomix-multimap.result-header

The header that wil carry the result.

String

camel.component.atomix-multimap.transport-class-name

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

camel.component.atomix-multimap.ttl

The resource ttl.

Long

camel.component.atomix-queue.atomix

The Atomix instance to use. The option is a io.atomix.Atomix type.

String

camel.component.atomix-queue.basic-property-binding

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

false

Boolean

camel.component.atomix-queue.bridge-error-handler

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

camel.component.atomix-queue.configuration

The shared component configuration. The option is a org.apache.camel.component.atomix.client.queue.AtomixQueueConfiguration type.

String

camel.component.atomix-queue.configuration-uri

The path to the AtomixClient configuration

String

camel.component.atomix-queue.default-action

The default action.

AtomixQueue$Action

camel.component.atomix-queue.default-resource-config

The cluster wide default resource configuration. The option is a java.util.Properties type.

String

camel.component.atomix-queue.default-resource-options

The local default resource options. The option is a java.util.Properties type.

String

camel.component.atomix-queue.enabled

Whether to enable auto configuration of the atomix-queue component. This is enabled by default.

Boolean

camel.component.atomix-queue.ephemeral

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

camel.component.atomix-queue.lazy-start-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

camel.component.atomix-queue.nodes

The nodes the AtomixClient should connect to

List

camel.component.atomix-queue.read-consistency

The read consistency level.

ReadConsistency

camel.component.atomix-queue.resource-configs

Cluster wide resources configuration.

Map

camel.component.atomix-queue.resource-options

Local resources configurations

Map

camel.component.atomix-queue.result-header

The header that wil carry the result.

String

camel.component.atomix-queue.transport-class-name

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

camel.component.atomix-set.atomix

The Atomix instance to use. The option is a io.atomix.Atomix type.

String

camel.component.atomix-set.basic-property-binding

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

false

Boolean

camel.component.atomix-set.bridge-error-handler

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

camel.component.atomix-set.configuration

The shared component configuration. The option is a org.apache.camel.component.atomix.client.set.AtomixSetConfiguration type.

String

camel.component.atomix-set.configuration-uri

The path to the AtomixClient configuration

String

camel.component.atomix-set.default-action

The default action.

AtomixSet$Action

camel.component.atomix-set.default-resource-config

The cluster wide default resource configuration. The option is a java.util.Properties type.

String

camel.component.atomix-set.default-resource-options

The local default resource options. The option is a java.util.Properties type.

String

camel.component.atomix-set.enabled

Whether to enable auto configuration of the atomix-set component. This is enabled by default.

Boolean

camel.component.atomix-set.ephemeral

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

camel.component.atomix-set.lazy-start-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

camel.component.atomix-set.nodes

The nodes the AtomixClient should connect to

List

camel.component.atomix-set.read-consistency

The read consistency level.

ReadConsistency

camel.component.atomix-set.resource-configs

Cluster wide resources configuration.

Map

camel.component.atomix-set.resource-options

Local resources configurations

Map

camel.component.atomix-set.result-header

The header that wil carry the result.

String

camel.component.atomix-set.transport-class-name

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

camel.component.atomix-set.ttl

The resource ttl.

Long

camel.component.atomix-value.atomix

The Atomix instance to use. The option is a io.atomix.Atomix type.

String

camel.component.atomix-value.basic-property-binding

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

false

Boolean

camel.component.atomix-value.bridge-error-handler

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

camel.component.atomix-value.configuration

The shared component configuration. The option is a org.apache.camel.component.atomix.client.value.AtomixValueConfiguration type.

String

camel.component.atomix-value.configuration-uri

The path to the AtomixClient configuration

String

camel.component.atomix-value.default-action

The default action.

AtomixValue$Action

camel.component.atomix-value.default-resource-config

The cluster wide default resource configuration. The option is a java.util.Properties type.

String

camel.component.atomix-value.default-resource-options

The local default resource options. The option is a java.util.Properties type.

String

camel.component.atomix-value.enabled

Whether to enable auto configuration of the atomix-value component. This is enabled by default.

Boolean

camel.component.atomix-value.ephemeral

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

camel.component.atomix-value.lazy-start-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

camel.component.atomix-value.nodes

The nodes the AtomixClient should connect to

List

camel.component.atomix-value.read-consistency

The read consistency level.

ReadConsistency

camel.component.atomix-value.resource-configs

Cluster wide resources configuration.

Map

camel.component.atomix-value.resource-options

Local resources configurations

Map

camel.component.atomix-value.result-header

The header that wil carry the result.

String

camel.component.atomix-value.transport-class-name

The class name (fqn) of the Atomix transport

io.atomix.catalyst.transport.netty.NettyTransport

String

camel.component.atomix-value.ttl

The resource ttl.

Long

camel.component.atomix.cluster.service.address

The address of the node - node only.

String

camel.component.atomix.cluster.service.attributes

Custom service attributes.

Map

camel.component.atomix.cluster.service.configuration-uri

The Atomix configuration uri.

String

camel.component.atomix.cluster.service.enabled

Sets if the atomix cluster service should be enabled or not, default is false.

false

Boolean

camel.component.atomix.cluster.service.ephemeral

Sets if the local member should join groups as PersistentMember or not (node only).

Boolean

camel.component.atomix.cluster.service.id

The cluster id.

String

camel.component.atomix.cluster.service.mode

Sets the cluster mode.

AtomixClusterServiceConfiguration$Mode

camel.component.atomix.cluster.service.nodes

The address of the nodes composing the cluster.

Set

camel.component.atomix.cluster.service.order

Service lookup order/priority.

Integer

camel.component.atomix.cluster.service.storage-level

The storage mode - node only.

StorageLevel

camel.component.atomix.cluster.service.storage-path

The storage directory - node only.

String