File Cluster Service

JVM since3.10.0 Native since3.10.0

Provides a FileLock implementation of the Camel Cluster Service SPI

Maven coordinates

Create a new project with this extension on code.quarkus.io

Or add the coordinates to your existing project:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-file-cluster-service</artifactId>
</dependency>

Check the User guide for more information about writing Camel Quarkus applications.

Additional Camel Quarkus configuration

Having only a single consumer in a cluster consuming from a given endpoint

When the same route is deployed on multiple JVMs, it could be interesting to use this extension in conjunction with the Master one. In such a setup, a single consumer will be active at a time across the whole camel master namespace.

For instance, having the route below deployed on multiple JVMs:

from("master:ns:timer:test?period=100")
    .log("Timer invoked on a single JVM at a time");

It’s possible to configure the file cluster service with a property like below in application.properties:

quarkus.camel.cluster.file.root = target/cluster-folder-where-lock-file-will-be-held

As a result, a single consumer will be active across the ns camel master namespace. It means that, at a given time, only a single timer will generate exchanges across all JVMs. In other words, messages will be logged every 100ms on a single JVM at a time.

The file cluster service could further be tuned by tweaking quarkus.camel.cluster.file.* properties.

Configuration property Type Default

quarkus.camel.cluster.file.enabled

Whether a File Lock Cluster Service should be automatically configured according to 'quarkus.camel.cluster.file.*' configurations.

boolean

true

quarkus.camel.cluster.file.id

The cluster service ID (defaults to null).

string

quarkus.camel.cluster.file.root

The root path (defaults to null).

string

quarkus.camel.cluster.file.order

The service lookup order/priority (defaults to 2147482647).

int

quarkus.camel.cluster.file.attributes."attributes"

The custom attributes associated to the service (defaults to empty map).

Map<String,String>

quarkus.camel.cluster.file.acquire-lock-delay

The time to wait before starting to try to acquire lock (defaults to 1000ms).

string

quarkus.camel.cluster.file.acquire-lock-interval

The time to wait between attempts to try to acquire lock (defaults to 10000ms).

string

quarkus.camel.cluster.file.heartbeat-timeout-multiplier

Multiplier applied to the cluster leader acquireLockInterval to determine how long followers should wait before considering the leader "stale".

For example, if the leader updates its heartbeat every 2 seconds and the heartbeatTimeoutMultiplier is 3, followers will tolerate up to 2s * 3 = 6s of silence before declaring the leader unavailable.

int

Configuration property fixed at build time. All other configuration properties are overridable at runtime.

Back to top