Chapter 156. Ignite Cache Component Available as of Camel version 2.17 The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an Ignite Cache . This offers both a Producer (to invoke cache operations on an Ignite cache) and a Consumer (to consume changes from a continuous query). The cache value is always the body of the message, whereas the cache key is always stored in the IgniteConstants.IGNITE_CACHE_KEY message header. Even if you configure a fixed operation in the endpoint URI, you can vary it per-exchange by setting the IgniteConstants.IGNITE_CACHE_OPERATION message header. 156.1. Options The Ignite Cache component supports 4 options, which are listed below. Name Description Default Type ignite (common) Sets the Ignite instance. Ignite configurationResource (common) Sets the resource from where to load the configuration. It can be a: URI, String (URI) or an InputStream. Object igniteConfiguration (common) Allows the user to set a programmatic IgniteConfiguration. IgniteConfiguration resolveProperty Placeholders (advanced) Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. true boolean The Ignite Cache endpoint is configured using URI syntax: with the following path and query parameters: 156.1.1. Path Parameters (1 parameters): Name Description Default Type cacheName Required The cache name. String 156.1.2. Query Parameters (16 parameters): Name Description Default Type propagateIncomingBodyIfNo ReturnValue (common) Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. true boolean treatCollectionsAsCache Objects (common) Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc. false boolean autoUnsubscribe (consumer) Whether auto unsubscribe is enabled in the Continuous Query Consumer. true boolean 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 fireExistingQueryResults (consumer) Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer. false boolean oneExchangePerUpdate (consumer) Whether to pack each update in an individual Exchange, even if multiple updates are received in one batch. Only used by the Continuous Query Consumer. true boolean pageSize (consumer) The page size. Only used by the Continuous Query Consumer. 1 int query (consumer) The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer. Query remoteFilter (consumer) The remote filter, only used by the Continuous Query Consumer. CacheEntryEvent SerializableFilter timeInterval (consumer) The time interval for the Continuous Query Consumer. 0 long 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 cachePeekMode (producer) The CachePeekMode, only needed for operations that require it (IgniteCacheOperation#SIZE). ALL CachePeekMode failIfInexistentCache (producer) Whether to fail the initialization if the cache doesn't exist. false boolean operation (producer) The cache operation to invoke. Possible values: GET, PUT, REMOVE, SIZE, REBALANCE, QUERY, CLEAR. IgniteCacheOperation synchronous (advanced) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). false boolean 156.2. Spring Boot Auto-Configuration The component supports 5 options, which are listed below. Name Description Default Type camel.component.ignite-cache.configuration-resource Sets the resource from where to load the configuration. It can be a: URI, String (URI) or an InputStream. The option is a java.lang.Object type. String camel.component.ignite-cache.enabled Enable ignite-cache component true Boolean camel.component.ignite-cache.ignite Sets the Ignite instance. The option is a org.apache.ignite.Ignite type. String camel.component.ignite-cache.ignite-configuration Allows the user to set a programmatic IgniteConfiguration. The option is a org.apache.ignite.configuration.IgniteConfiguration type. String camel.component.ignite-cache.resolve-property-placeholders Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. true Boolean 156.2.1. Headers used This endpoint uses the following headers: Header name Constant Expected type Description CamelIgniteCacheKey IgniteConstants.IGNITE_CACHE_KEY String The cache key for the entry value in the message body. CamelIgniteCacheQuery IgniteConstants.IGNITE_CACHE_QUERY Query The query to run (producer) when invoking the QUERY operation. CamelIgniteCacheOperation IgniteConstants.IGNITE_CACHE_OPERATION IgniteCacheOperation enum Allows you to dynamically change the cache operation to execute (producer). CamelIgniteCachePeekMode IgniteConstants.IGNITE_CACHE_PEEK_MODE CachePeekMode enum Allows you to dynamically change the cache peek mode when running the SIZE operation. CamelIgniteCacheEventType IgniteConstants.IGNITE_CACHE_EVENT_TYPE int (EventType constants) This header carries the received event type when using the continuous query consumer. CamelIgniteCacheName IgniteConstants.IGNITE_CACHE_NAME String This header carries the cache name for which a continuous query event was received (consumer). It does not allow you to dynamically change the cache against which a producer operation is performed. Use EIPs for that (e.g. recipient list, dynamic router). CamelIgniteCacheOldValue IgniteConstants.IGNITE_CACHE_OLD_VALUE Object This header carries the old cache value when passed in the incoming cache event (consumer).

Commands:
ignite-cache:cacheName