Infinispan Component

Available as of Camel 2.13.0

This component allows you to interact with Infinispan distributed data grid / cache. Infinispan is an extremely scalable, highly available key/value data store and data grid platform written in Java.

From Camel 2.17 onwards Infinispan requires Java 8.

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

URI format

URI Options

The producer allows sending messages to a local infinispan cache configured in the registry, or to a remote cache using the HotRod protocol.
The consumer allows listening for events from local infinispan cache accessible from the registry.

Name

Default Value

Type

Context

Description

cacheContainer

null

CacheContainer

Shared

Reference to a org.infinispan.manager.CacheContainer in the Registry.

cacheName

null

String

Shared

The cache name to use. If not specified, default cache is used.

command

PUT

String

Producer

The operation to perform. Currently supports the following values: PUT, GET, REMOVE, CLEAR.

From Camel 2.16: PUT ALL, PUT IF ABSENT, REPLACE, SIZE.

From Camel 2.17: PUT ASYNC, PUT ALL ASYNC, PUT IF ABSENT ASYNC, CONTAINS KEY, CONTAINS VALUE, REMOVE ASYNC, REPLACE ASYNC, CLEAR ASYNC, QUERY

From Camel 2.18: STATS

eventTypes

null

Set<String>

Consumer

The event types to register. By default will listen for all event types. Possible values defined in org.infinispan.notifications.cachelistener.event.Event.Type

sync

true

Boolean

Consumer

By default the consumer will receive notifications synchronously, by the same thread that process the cache operation.

queryBuildernullInfinispanQueryBuilderSharedFrom Camel 2.17: the QueryBuilder to be used by QUERY command if CamelInfinispanQueryBuilder header is not set
customListenernullInfinispanCustomListenerConsumerFrom Camel 2.17: a custom event listener
clusteredListenerfalseBooleanConsumerFrom Camel 2.17: if ture the listener will be installed for entiere cluster

Message Headers

Name

Default Value

Type

Context

Description

CamelInfinispanCacheName

null

String

Shared

The cache participating in the operation or event.

CamelInfinispanOperation

PUT

String

Producer

The operation to perform: CamelInfinispanOperationPut, CamelInfinispanOperationGet, CamelInfinispanOperationRemove, CamelInfinispanOperationClear.

From Camel 2.16: CamelInfinispanOperationPutAll, CamelInfinispanOperationPutIfAbsent, CamelInfinispanOperationReplace, CamelInfinispanOperationSize.

CamelInfinispanMap

null

Map

Producer

A Map to use in case of CamelInfinispanOperationPutAll operation

CamelInfinispanKey

null

Object

Shared

The key to perform the operation to or the key generating the event.

CamelInfinispanValue

null

Object

Producer

The value to use for the operation.

CamelInfinispanOperationResult

null

Object

Producer

The result of the operation.

CamelInfinispanEventType

null

String

Consumer

The type of the received event. Possible values defined here org.infinispan.notifications.cachelistener.event.Event.Type

CamelInfinispanIsPre

null

Boolean

Consumer

Infinispan fires two events for each operation: one before and one after the operation.

CamelInfinispanLifespanTime

null

long

Producer

The Lifespan time of a value inside the cache. Negative values are interpreted as infinity.

CamelInfinispanTimeUnit

null

String

Producer

The Time Unit of an entry Lifespan Time.

CamelInfinispanMaxIdleTime

null

long

Producer

The maximum amount of time an entry is allowed to be idle for before it is considered as expired.

CamelInfinispanMaxIdleTimeUnit

null

String

Producer

The Time Unit of an entry Max Idle Time.

CamelInfinispanQueryBuilder

nullInfinispanQueryBuilderProducerFrom Camel 2.17: The QueryBuilde to use for QUERY command, if not present the command defaults to InifinispanConfiguration's one
CamelInfinispanIgnoreReturnValuesnullBooleanProducerFrom Camel 2.17: If this header is set, the return value for cache operation returning something is ignored by the client application

Example

Below is an example route that retrieves a value from the cache for a specific key:

Using the Infinispan based idempotent repository

In this section we will use the Infinispan based idempotent repository.

First, we need to create a cacheManager and then configure our org.apache.camel.component.infinispan.processor.idempotent.InfinispanIdempotentRepository:

Then we can create our Infinispan idempotent repository in the spring XML file as well:

 

If you plan to use a RemoteCacheManager instead of DefaultcacheManager please note that you need to force the cache to return values for Map oeprations:

Spring XML

 

 

For more information, see these resources...

See Also

© 2004-2015 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram