Hazelcast Instance Component

Available as of Camel version 2.7

The Hazelcast instance component is one of Camel Hazelcast Components which allows you to consume join/leave events of the cache instance in the cluster. Hazelcast makes sense in one single "server node", but it’s extremly powerful in a clustered environment.

This endpoint provides no producer!

Options

The Hazelcast Instance component supports 3 options, which are listed below.

Name Description Default Type

hazelcastInstance (advanced)

The hazelcast instance reference which can be used for hazelcast endpoint. If you don’t specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance.

HazelcastInstance

hazelcastMode (advanced)

The hazelcast mode reference which kind of instance should be used. If you don’t specify the mode, then the node mode will be the default.

node

String

basicPropertyBinding (advanced)

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

false

boolean

The Hazelcast Instance endpoint is configured using URI syntax:

hazelcast-instance:cacheName

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

cacheName

Required The name of the cache

String

Query Parameters (8 parameters):

Name Description Default Type

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

defaultOperation (consumer)

To specify a default operation to use, if no operation header has been provided.

HazelcastOperation

hazelcastInstance (consumer)

The hazelcast instance reference which can be used for hazelcast endpoint.

HazelcastInstance

hazelcastInstanceName (consumer)

The hazelcast instance reference name which can be used for hazelcast endpoint. If you don’t specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance.

String

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.

ExchangePattern

basicPropertyBinding (advanced)

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

false

boolean

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 Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-hazelcast-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 26 options, which are listed below.

Name Description Default Type

camel.component.hazelcast-atomicvalue.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-atomicvalue.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-instance.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.hazelcast-instance.enabled

Enable hazelcast-instance component

true

Boolean

camel.component.hazelcast-instance.hazelcast-instance

The hazelcast instance reference which can be used for hazelcast endpoint. If you don’t specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance. The option is a com.hazelcast.core.HazelcastInstance type.

String

camel.component.hazelcast-instance.hazelcast-mode

The hazelcast mode reference which kind of instance should be used. If you don’t specify the mode, then the node mode will be the default.

node

String

camel.component.hazelcast-list.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-list.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-map.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-map.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-multimap.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-multimap.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-queue.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-queue.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-replicatedmap.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-replicatedmap.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-ringbuffer.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-ringbuffer.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-seda.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-seda.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-set.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-set.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-topic.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-topic.customizer.hazelcast-instance.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.hazelcast-topic.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.hazelcast-topic.customizer.hazelcast-instance.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

instance consumer - from("hazelcast-instance:foo")

The instance consumer fires if a new cache instance will join or leave the cluster.

Here’s a sample:

fromF("hazelcast-%sfoo", HazelcastConstants.INSTANCE_PREFIX)
.log("instance...")
.choice()
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ADDED))
        .log("...added")
        .to("mock:added")
    .otherwise()
        .log("...removed")
        .to("mock:removed");

Each event provides the following information inside the message header:

Header Variables inside the response message:

Name Type Description

CamelHazelcastListenerTime

Long

time of the event in millis

CamelHazelcastListenerType

String

the map consumer sets here "instancelistener"

CamelHazelcastListenerAction

String

type of event - here added or removed.

CamelHazelcastInstanceHost

String

host name of the instance

CamelHazelcastInstancePort

Integer

port number of the instance