Page History

Hazelcast Component

Available as of Camel 2.7

The hazelcast: component allows you to work with the Hazelcast distributed data grid / cache. Hazelcast is a in memory data grid, entirely written in Java (single jar). It offers a great palette of different data stores like map, multi map (same key, n values), queue, list and atomic number. The main reason to use Hazelcast is its simple cluster support. If you have enabled multicast on your network you can run a cluster with hundred nodes with no extra configuration. Hazelcast can simply configured to add additional features like n copies between nodes (default is 1), cache persistence, network configuration (if needed), near cache, enviction and so on. For more information consult the Hazelcast documentation on http://www.hazelcast.com/docs.jsp.

Maven users will need to add the following dependency to their pom.xml for this component:

Code Block

	xml
	xml

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

URI format

Code Block
hazelcast:[ map \| multimap \| queue \| seda \| set \| atomicvalue \| instance]:cachename[?options]

Warning
You have to use the second prefix to define which type of data store you want to use.

Sections

Usage of #map
Usage of #multimap
Usage of #queue
Usage of #list
Usage of #seda
Usage of atomic number
Usage of #cluster support (instance)

Anchor

	map
	map

Usage of Map

map cache producer - to("hazelcast:map:foo")

If you want to store a value in a map you can use the map cache producer. The map cache producer provides 5 operations (put, get, update, delete, query). For the first 4 you have to provide the operation inside the "hazelcast.operation.type" header variable. In Java DSL you can use the constants from org.apache.camel.component.hazelcast.HazelcastConstants.

Header Variables for the request message:

Name	Type	Description
`hazelcast.operation.type`	`String`	valid values are: put, delete, get, update, query
`hazelcast.objectId`	`String`	the object id to store / find your object inside the cache (not needed for the query operation)

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastOperationType`	`String`	valid values are: put, delete, get, update, query Version 2.8
`CamelHazelcastObjectId`	`String`	the object id to store / find your object inside the cache (not needed for the query operation) Version 2.8

You can call the samples with:

Code Block
template.sendBodyAndHeader("direct:[put\|get\|update\|delete\|query]", "my-foo", HazelcastConstants.OBJECT_ID, "4711");

Sample for put:

Java DSL:

Code Block
from("direct:put") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.PUT_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:put" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>put</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
</route>

Sample for get:

Java DSL:

Code Block
from("direct:get") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.GET_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX) .to("seda:out");

Spring DSL:

Code Block

<route>
	<from uri="direct:get" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>get</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
	<to uri="seda:out" />
</route>

Sample for update:

Java DSL:

Code Block
from("direct:update") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.UPDATE_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:update" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>update</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
</route>

Sample for delete:

Java DSL:

Code Block
from("direct:delete") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.DELETE_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:delete" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>delete</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
</route>

Sample for query

Java DSL:

Code Block
from("direct:query") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.QUERY_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX) .to("seda:out");

Spring DSL:

Code Block

<route>
	<from uri="direct:query" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>query</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
	<to uri="seda:out" />
</route>

For the query operation Hazelcast offers a SQL like syntax to query your distributed map.

Code Block
String q1 = "bar > 1000"; template.sendBodyAndHeader("direct:query", null, HazelcastConstants.QUERY, q1);

map cache consumer - from("hazelcast:map:foo")

Hazelcast provides event listeners on their data grid. If you want to be notified if a cache will be manipulated, you can use the map consumer. There're 4 events: put, update, delete and envict. The event type will be stored in the "hazelcast.listener.action" header variable. The map consumer provides some additional information inside these variables:

Header Variables inside the response message:

Name	Type	Description
`hazelcast.listener.time`	`Long`	time of the event in millis
`hazelcast.listener.type`	`String`	the map consumer sets here "cachelistener"
`hazelcast.listener.action`	`String`	type of event - here added, updated, envicted and removed
`hazelcast.objectId`	`String`	the oid of the object
`hazelcast.cache.name`	`String`	the name of the cache - e.g. "foo"
`hazelcast.cache.type`	`String`	the type of the cache - here map

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastListenerTime`	`Long`	time of the event in millis Version 2.8
`CamelHazelcastListenerType`	`String`	the map consumer sets here "cachelistener" Version 2.8
`CamelHazelcastListenerAction`	`String`	type of event - here added, updated, envicted and removed. Version 2.8
`CamelHazelcastObjectId`	`String`	the oid of the object Version 2.8
`CamelHazelcastCacheName`	`String`	the name of the cache - e.g. "foo" Version 2.8
`CamelHazelcastCacheType`	`String`	the type of the cache - here map Version 2.8

The object value will be stored within put and update actions inside the message body.

Here's a sample:

Code Block

fromF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX)
.log("object...")
.choice()
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ADDED))
         .log("...added")
         .to("mock:added")
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ENVICTED))
         .log("...envicted")
         .to("mock:envicted")
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.UPDATED))
         .log("...updated")
         .to("mock:updated")
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.REMOVED))
         .log("...removed")
         .to("mock:removed")
    .otherwise()
         .log("fail!");

Anchor

	multimap
	multimap

Usage of Multi Map

multimap cache producer - to("hazelcast:multimap:foo")

A multimap is a cache where you can store n values to one key. The multimap producer provides 4 operations (put, get, removevalue, delete).

Header Variables for the request message:

Name	Type	Description
`hazelcast.operation.type`	`String`	valid values are: put, get, removevalue, delete
`hazelcast.objectId`	`String`	the object id to store / find your object inside the cache

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastOperationType`	`String`	valid values are: put, delete, get, update, query Available as of Camel 2.8
`CamelHazelcastObjectId`	`String`	the object id to store / find your object inside the cache (not needed for the query operation) Version 2.8

You can call the samples with:

Code Block
template.sendBodyAndHeader("direct:[put\|get\|update\|delete\|query]", "my-foo", HazelcastConstants.OBJECT_ID, "4711");

Sample for put:

Java DSL:

Code Block
from("direct:put") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.PUT_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:put" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>put</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
</route>

Sample for get:

Java DSL:

Code Block
from("direct:get") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.GET_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX) .to("seda:out");

Spring DSL:

Code Block

<route>
	<from uri="direct:get" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>get</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
	<to uri="seda:out" />
</route>

Sample for update:

Java DSL:

Code Block
from("direct:update") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.UPDATE_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:update" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>update</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
</route>

Sample for delete:

Java DSL:

Code Block
from("direct:delete") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.DELETE_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:delete" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>delete</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
</route>

Sample for query

Java DSL:

Code Block
from("direct:query") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.QUERY_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX) .to("seda:out");

Spring DSL:

Code Block

<route>
	<from uri="direct:query" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>query</constant>
	</setHeader>
	<to uri="hazelcast:map:foo" />
	<to uri="seda:out" />
</route>

For the query operation Hazelcast offers a SQL like syntax to query your distributed map.

Code Block
String q1 = "bar > 1000"; template.sendBodyAndHeader("direct:query", null, HazelcastConstants.QUERY, q1);

map cache consumer - from("hazelcast:map:foo")

Hazelcast provides event listeners on their data grid. If you want to be notified if a cache will be manipulated, you can use the map consumer. There're 4 events: put, update, delete and envict. The event type will be stored in the "hazelcast.listener.action" header variable. The map consumer provides some additional information inside these variables:

Header Variables inside the response message:

Name	Type	Description
`hazelcast.listener.time`	`Long`	time of the event in millis
`hazelcast.listener.type`	`String`	the map consumer sets here "cachelistener"
`hazelcast.listener.action`	`String`	type of event - here added, updated, envicted and removed
`hazelcast.objectId`	`String`	the oid of the object
`hazelcast.cache.name`	`String`	the name of the cache - e.g. "foo"
`hazelcast.cache.type`	`String`	the type of the cache - here map

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastListenerTime`	`Long`	time of the event in millis Version 2.8
`CamelHazelcastListenerType`	`String`	the map consumer sets here "cachelistener" Version 2.8
`CamelHazelcastListenerAction`	`String`	type of event - here added, updated, envicted and removed. Version 2.8
`CamelHazelcastObjectId`	`String`	the oid of the object Version 2.8
`CamelHazelcastCacheName`	`String`	the name of the cache - e.g. "foo" Version 2.8
`CamelHazelcastCacheType`	`String`	the type of the cache - here map Version 2.8

The object value will be stored within put and update actions inside the message body.

Here's a sample:

Code Block

fromF("hazelcast:%sfoo", HazelcastConstants.MAP_PREFIX)
.log("object...")
.choice()
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ADDED))
         .log("...added")
         .to("mock:added")
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ENVICTED))
         .log("...envicted")
         .to("mock:envicted")
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.UPDATED))
         .log("...updated")
         .to("mock:updated")
    .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.REMOVED))
         .log("...removed")
         .to("mock:removed")
    .otherwise()
         .log("fail!");

Anchor

	multimap
	multimap

Usage of Multi Map

multimap cache producer - to("hazelcast:multimap:foo")

A multimap is a cache where you can store n values to one key. The multimap producer provides 4 operations (put, get, removevalue, delete).

Header Variables for the request message:

Name	Type	Description
`hazelcast.operation.type`	`String`	valid values are: put, get, removevalue, delete
`hazelcast.objectId`	`String`	the object id to store / find your object inside the cache

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastOperationType`	`String`	valid values are: put, get, removevalue, delete Version 2.8
`CamelHazelcastObjectId`	`String`	the object id to store / find your object inside the cache Version 2.8

Sample for put:

Java DSL:

Code Block
from("direct:put") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.PUT_OPERATION)) .to(String.format("hazelcast:%sbar", HazelcastConstants.MULTIMAP_PREFIX));

Spring DSL:

Code Block

<route>
	<from uri="direct:put" />
	<log message="put.."/>
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>put</constant>
	</setHeader>
	<to uri="hazelcast:multimap:foo" />
</route>

Sample for removevalue:

Java DSL:

Code Block
from("direct:removevalue") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.REMOVEVALUE_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.MULTIMAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:removevalue" />
	<log message="removevalue..."/>
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>removevalue</constant>
	</setHeader>
	<to uri="hazelcast:multimap:foo" />
</route>

To remove a value you have to provide the value you want to remove inside the message body. If you have a multimap object {key: "4711" values: { "my-foo", "my-bar"}} you have to put "my-foo" inside the message body to remove the "my-foo" value.

Sample for get:

Java DSL:

Code Block
from("direct:get") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.GET_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.MULTIMAP_PREFIX) .to("seda:out");

Spring DSL:

Code Block

<route>
	<from uri="direct:get" />
	<log message="get.."/>
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>get</constant>
	</setHeader>
	<to uri="hazelcast:multimap:foo" />
	<to uri="seda:out" />
</route>

Sample for delete:

Java DSL:

Code Block
from("direct:delete") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.DELETE_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.MULTIMAP_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:delete" />
	<log message="delete.."/>
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>delete</constant>
	</setHeader>
	<to uri="hazelcast:multimap:foo" />
</route>

you can call them in your test class with:

Code Block
template.sendBodyAndHeader("direct:[put\|get\|removevalue\|delete]", "my-foo", HazelcastConstants.OBJECT_ID, "4711");

multimap cache consumer - from("hazelcast:multimap:foo")

For the multimap cache this component provides the same listeners / variables as for the map cache consumer (except the update and enviction listener). The only difference is the multimap prefix inside the URI. Here is a sample:

Code Block

fromF("hazelcast:%sbar", HazelcastConstants.MULTIMAP_PREFIX)
.log("object...")
.choice()
	.when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ADDED))
		.log("...added")
                .to("mock:added")
        //.when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ENVICTED))
        //        .log("...envicted")
        //        .to("mock:envicted")
        .when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.REMOVED))
                .log("...removed")
                .to("mock:removed")
        .otherwise()
                .log("fail!");

Header Variables inside the response message:

Name	Type	Description
`hazelcast.listener.time`	`Long`	time of the event in millis
`hazelcast.listener.type`	`String`	the map consumer sets here "cachelistener"
`hazelcast.listener.action`	`String`	type of event - here added and removed (and soon envicted)
`hazelcast.objectId`	`String`	the oid of the object
`hazelcast.cache.name`	`String`	the name of the cache - e.g. "foo"
`hazelcast.cache.type`	`String`	the type of the cache - here multimap

Eviction will be added as feature, soon (this is a Hazelcast issue).

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastListenerTime`	`Long`	time of the event in millis Version 2.8
`CamelHazelcastListenerType`	`String`	the map consumer sets here "cachelistener" Version 2.8
`CamelHazelcastListenerAction`	`String`	type of event - here added and removed (and soon envicted) Version 2.8
`CamelHazelcastObjectId`	`String`	the oid of the object Version 2.8
`CamelHazelcastCacheName`	`String`	the name of the cache - e.g. "foo" Version 2.8
`CamelHazelcastCacheType`	`String`	the type of the cache - here multimap Version 2.8

Anchor

	queue
	queue

Usage of Queue

Queue producer – to(“hazelcast:queue:foo”)

The queue producer provides 6 operations (add, put, poll, peek, offer, removevalue).

Sample for add:

Code Block
from("direct:add") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.ADD_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.QUEUE_PREFIX);

Sample for put:

Code Block
from("direct:put") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.PUT_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.QUEUE_PREFIX);

Sample for poll:

Code Block
from("direct:poll") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.POLL_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.QUEUE_PREFIX);

Sample for peek:

Code Block
from("direct:peek") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.PEEK_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.QUEUE_PREFIX);

Sample for offer:

Code Block
from("direct:offer") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.OFFER_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.QUEUE_PREFIX);

Sample for removevalue:

Code Block
from("direct:removevalue") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.REMOVEVALUE_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.QUEUE_PREFIX);

Queue consumer – from(“hazelcast:queue:foo”)

The queue consumer provides 2 operations (add, remove).

Code Block

fromF("hazelcast:%smm", HazelcastConstants.QUEUE_PREFIX)
   .log("object...")
   .choice()
	.when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ADDED))
        	.log("...added")
		.to("mock:added")
	.when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.REMOVED))
		.log("...removed")
		.to("mock:removed")
	.otherwise()
		.log("fail!");

Anchor

	list
	list

Usage of List

List producer – to(“hazelcast:list:foo”)

The list producer provides 4 operations (add, set, get, removevalue).

Sample for add:

Code Block
from("direct:add") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.ADD_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.LIST_PREFIX);

Sample for get:

Code Block
from("direct:get") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.GET_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.LIST_PREFIX) .to("seda:out");

Sample for setvalue:

Code Block
from("direct:set") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.SETVALUE_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.LIST_PREFIX);

Sample for removevalue:

Code Block
from("direct:removevalue") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.REMOVEVALUE_OPERATION)) .toF("hazelcast:%sbar", HazelcastConstants.LIST_PREFIX);

Warning
Please note that set,get and removevalue and not yet supported by hazelcast, will be added in the future..

List consumer – from(“hazelcast:list:foo”)

The list consumer provides 2 operations (add, remove).

Code Block

fromF("hazelcast:%smm", HazelcastConstants.LIST_PREFIX)
	.log("object...")
	.choice()
		.when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.ADDED))
			.log("...added")
                        .to("mock:added")
		.when(header(HazelcastConstants.LISTENER_ACTION).isEqualTo(HazelcastConstants.REMOVED))
			.log("...removed")
                        .to("mock:removed")
                .otherwise()
                        .log("fail!");

Anchor

	seda
	seda

Usage of SEDA

SEDA component differs from the rest components provided. It implements a work-queue in order to support asynchronous SEDA architectures, similar to the core "SEDA" component.

SEDA producer – to(“hazelcast:seda:foo”)

The SEDA producer provides no operations. You only send data to the specified queue.

Name	default value	Description
`transferExchange`	`false`	Camel 2.8.0: if set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped.

Java DSL :

Code Block
from("direct:foo") .to("hazelcast:seda:foo");

Spring DSL :

Code Block
<route> <from uri="direct:start" /> <to uri="hazelcast:seda:foo" /> </route>

SEDA consumer – from(“hazelcast:seda:foo”)

The SEDA consumer provides no operations. You only retrieve data from the specified queue.

Name	default value	Description
`pollInterval`	`1000`	How frequent to poll from the SEDA queue
`concurrentConsumers`	`1`	To use concurrent consumers polling from the SEDA queue.
`transferExchange`	`false`	Camel 2.8.0: if set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped.
`transacted`	`false`	Camel 2.10.4: if set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete.

Java DSL :

Code Block
from("hazelcast:seda:foo") .to("mock:result");

Spring DSL:

Code Block
<route> <from uri="hazelcast:seda:foo" /> <to uri="mock:result" /> </route>

Anchor

	atomicnumber
	atomicnumber

Usage of Atomic Number

Warning
There is no consumer for this endpoint!

atomic number producer - to("hazelcast:atomicnumber:foo")

An atomic number is an object that simply provides a grid wide number (long). The operations for this producer are setvalue (set the number with a given value), get, increase (+1), decrease (-1) and destroy.

Header Variables for the request message:

Name	Type	Description
`hazelcast.operation.type`	`String`	valid values are: setvalue, get, increase, decrease, destroy

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastOperationType`	`String`	valid values are: setvalue, get, increase, decrease, destroy Available as of Camel version 2.8

Sample for set:

Java DSL:

Code Block
from("direct:set") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.SETVALUE_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:set" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>setvalue</constant>
	</setHeader>
	<to uri="hazelcast:atomicvalue:foo" />
</route>

Provide the value to set inside the message body (here the value is 10): template.sendBody("direct:set", 10);

Sample for get:

Java DSL:

Code Block
from("direct:get") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.GET_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:get" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>get</constant>
	</setHeader>
	<to uri="hazelcast:atomicvalue:foo" />
</route>

You can get the number with long body = template.requestBody("direct:get", null, Long.class);.

Sample for increment:

Java DSL:

Code Block
from("direct:increment") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.INCREMENT_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:increment" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>increment</constant>
	</setHeader>
	<to uri="hazelcast:atomicvalue:foo" />
</route>

The actual value (after increment) will be provided inside the message body.

Sample for decrement:

Java DSL:

Code Block
from("direct:decrement") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.DECREMENT_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:decrement" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>decrement</constant>
	</setHeader>
	<to uri="hazelcast:atomicvalue:foo" />
</route>

The actual value (after decrement) will be provided inside the message body.

Sample for destroy

Warning
There's a bug inside Hazelcast. So this feature may not work properly. Will be fixed in 1.9.3.

Java DSL:

Code Block
from("direct:destroy") .setHeader(HazelcastConstants.OPERATION, constant(HazelcastConstants.DESTROY_OPERATION)) .toF("hazelcast:%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);

Spring DSL:

Code Block

<route>
	<from uri="direct:destroy" />
        <!-- If using version 2.8 and above set headerName to "CamelHazelcastOperationType" -->
	<setHeader headerName="hazelcast.operation.type">
		<constant>destroy</constant>
	</setHeader>
	<to uri="hazelcast:atomicvalue:foo" />
</route>

Anchor

	cluster
	cluster

cluster support

Warning
This endpoint provides no producer!

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

Hazelcast makes sense in one single "server node", but it's extremly powerful in a clustered environment. The instance consumer fires if a new cache instance will join or leave the cluster.

Here's a sample:

Code Block

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
`hazelcast.listener.time`	`Long`	time of the event in millis
`hazelcast.listener.type`	`String`	the map consumer sets here "instancelistener"
`hazelcast.listener.action`	`String`	type of event - here added or removed
`hazelcast.instance.host`	`String`	host name of the instance
`hazelcast.instance.port`	`Integer`	port number of the instance

Warning
Header variables have changed in Camel 2.8

Name	Type	Description
`CamelHazelcastListenerTime`	`Long`	time of the event in millis Version 2.8
`CamelHazelcastListenerType`	`String`	the map consumer sets here "instancelistener" Version 2.8
`CamelHazelcastListenerActionn`	`String`	type of event - here added or removed. Version 2.8
`CamelHazelcastInstanceHost`	`String`	host name of the instance Version 2.8
`CamelHazelcastInstancePort`	`Integer`	port number of the instance Version 2.8

Child pages

Page History

Versions Compared

Old Version 12

New Version 13

Key

Hazelcast Component

URI format

Sections

Usage of Map

map cache producer - to("hazelcast:map:foo")

Sample for put:

Sample for get:

Sample for update:

Sample for delete:

Sample for query

map cache consumer - from("hazelcast:map:foo")

Usage of Multi Map

multimap cache producer - to("hazelcast:multimap:foo")

Sample for put:

Sample for get:

Sample for update:

Sample for delete:

Sample for query

map cache consumer - from("hazelcast:map:foo")

Usage of Multi Map

multimap cache producer - to("hazelcast:multimap:foo")

Sample for put:

Sample for removevalue:

Sample for get:

Sample for delete:

multimap cache consumer - from("hazelcast:multimap:foo")

Usage of Queue

Queue producer – to(“hazelcast:queue:foo”)

Sample for add:

Sample for put:

Sample for poll:

Sample for peek:

Sample for offer:

Sample for removevalue:

Queue consumer – from(“hazelcast:queue:foo”)

Usage of List

List producer – to(“hazelcast:list:foo”)

Sample for add:

Sample for get:

Sample for setvalue:

Sample for removevalue:

List consumer – from(“hazelcast:list:foo”)

Usage of SEDA

SEDA producer – to(“hazelcast:seda:foo”)

SEDA consumer – from(“hazelcast:seda:foo”)

Usage of Atomic Number

atomic number producer - to("hazelcast:atomicnumber:foo")

Sample for set:

Sample for get:

Sample for increment:

Sample for decrement:

Sample for destroy

cluster support

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