Camel Components

Ignite Sets

Since Camel 2.17

Only producer is supported

The Ignite Sets endpoint is one of camel-ignite endpoints that allows you to interact with Ignite Set data structures.

Configuring Options

Camel components are configured on two separate levels:

component level
endpoint level

Configuring Component Options

At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.

For example, a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

You can configure components using:

the Component DSL.
in a configuration file (application.properties, *.yaml files, etc).
directly in the Java code.

Configuring Endpoint Options

You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders.

Property placeholders provide a few benefits:

They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.
They allow externalizing the configuration from the code.
They help the code to become more flexible and reusable.

The following two sections list all the options, firstly for the component followed by the endpoint.

Component Options

The Ignite Sets component supports the following options which are listed below.

Name	Description	Default	Type
configurationResource (producer)	The resource from where to load the configuration. It can be a: URL, String or InputStream type.		Object
ignite (producer)	To use an existing Ignite instance.		Ignite
igniteConfiguration (producer)	Allows the user to set a programmatic ignite configuration.		IgniteConfiguration
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
autowiredEnabled (advanced)	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	boolean

Name

Description

Default

Type

configurationResource (producer)

The resource from where to load the configuration. It can be a: URL, String or InputStream type.

Object

ignite (producer)

To use an existing Ignite instance.

Ignite

igniteConfiguration (producer)

Allows the user to set a programmatic ignite configuration.

IgniteConfiguration

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

Endpoint Options

The Ignite Sets endpoint is configured using URI syntax:

ignite-set:name

With the following path and query parameters:

Path Parameters

Name	Description	Default	Type
name (producer)	Required The set name.		String

Name

Description

Default

Type

name (producer)

Required The set name.

String

Query Parameters

Name	Description	Default	Type
configuration (producer)	The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options.		CollectionConfiguration
operation (producer)	The operation to invoke on the Ignite Set. Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY.The set operation to perform. Enum values: CONTAINS ADD SIZE REMOVE ITERATOR CLEAR RETAIN_ALL ARRAY		IgniteSetOperation
propagateIncomingBodyIfNoReturnValue (producer)	Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void.	true	boolean
treatCollectionsAsCacheObjects (producer)	Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc.	false	boolean
lazyStartProducer (producer (advanced))	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean

Name

Description

Default

Type

configuration (producer)

The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options.

CollectionConfiguration

operation (producer)

The operation to invoke on the Ignite Set. Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY.The set operation to perform.

Enum values:

CONTAINS
ADD
SIZE
REMOVE
ITERATOR
CLEAR
RETAIN_ALL
ARRAY

IgniteSetOperation

propagateIncomingBodyIfNoReturnValue (producer)

Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void.

true

boolean

treatCollectionsAsCacheObjects (producer)

Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc.

false

boolean

lazyStartProducer (producer (advanced))

false

boolean

Message Headers

The Ignite Sets component supports the following message header(s), which is/are listed below:

Name Description Default Type

Name	Description	Default	Type
CamelIgniteSetsOperation (producer) Constant: `IGNITE_SETS_OPERATION`	Allows you to dynamically change the set operation. Enum values: CONTAINS ADD SIZE REMOVE ITERATOR CLEAR RETAIN_ALL ARRAY		IgniteSetOperation

CamelIgniteSetsOperation (producer)

Constant: IGNITE_SETS_OPERATION

Allows you to dynamically change the set operation.

Enum values:

CONTAINS
ADD
SIZE
REMOVE
ITERATOR
CLEAR
RETAIN_ALL
ARRAY

IgniteSetOperation

Message Body

The message body at each side of the Ignite Sets component: Consumer is the body of the messages the consumer creates, Consumer reply the bodies a consumer that answers its caller can reply with, Producer input the bodies the producer can send or write, and Producer output the body after the producer.

Side Body Description

Side	Body	Description
Producer input	`any`	ADD, CONTAINS, REMOVE and RETAIN_ALL use the body as the element, and a Collection as several elements unless treatCollectionsAsCacheObjects=true; no body fails them. SIZE, ITERATOR, ARRAY and CLEAR do not use the body. The operation is the operation option or the CamelIgniteSetsOperation header; with neither the producer fails.
Producer output	`value`, `iterator`, `list` or `unchanged`	true or false for ADD, CONTAINS, REMOVE and RETAIN_ALL (whether the set changed, or holds the element), the number of elements for SIZE, an Iterator for ITERATOR and an Object array for ARRAY. CLEAR leaves the body. With `operation=ADD`: `value` (`java.lang.Boolean`) With `operation=CONTAINS`: `value` (`java.lang.Boolean`) With `operation=REMOVE`: `value` (`java.lang.Boolean`) With `operation=RETAIN_ALL`: `value` (`java.lang.Boolean`) With `operation=SIZE`: `value` (`java.lang.Integer`) With `operation=ITERATOR`: `iterator` With `operation=ARRAY`: `list` With `operation=CLEAR`: `unchanged` Not known when `propagateIncomingBodyIfNoReturnValue` is set.

Producer input

any

ADD, CONTAINS, REMOVE and RETAIN_ALL use the body as the element, and a Collection as several elements unless treatCollectionsAsCacheObjects=true; no body fails them. SIZE, ITERATOR, ARRAY and CLEAR do not use the body. The operation is the operation option or the CamelIgniteSetsOperation header; with neither the producer fails.

Producer output

value, iterator, list or unchanged

true or false for ADD, CONTAINS, REMOVE and RETAIN_ALL (whether the set changed, or holds the element), the number of elements for SIZE, an Iterator for ITERATOR and an Object array for ARRAY. CLEAR leaves the body.

With operation=ADD: value (java.lang.Boolean)
With operation=CONTAINS: value (java.lang.Boolean)
With operation=REMOVE: value (java.lang.Boolean)
With operation=RETAIN_ALL: value (java.lang.Boolean)
With operation=SIZE: value (java.lang.Integer)
With operation=ITERATOR: iterator
With operation=ARRAY: list
With operation=CLEAR: unchanged

Not known when propagateIncomingBodyIfNoReturnValue is set.

The bodies are the ones with the default options. A side that is not listed is not known, and tooling does not guess it. The carriers are described in the Camel Catalog.

Usage

The component needs an Ignite node: Ignite describes the ways to give it one. A node of its own with the default configuration takes one line in application.properties. On Java 17 and later, Ignite also needs the --add-opens JVM options that its documentation lists.

camel.component.ignite-set.ignite-configuration = #class:org.apache.ignite.configuration.IgniteConfiguration

ADD adds the body to the set, and sets the body to true when the item was not in the set yet. SIZE then sets the number of items as the body:

- route:
    from:
      uri: direct:visit
      steps:
        - to:
            uri: ignite-set:visitedPages
            parameters:
              operation: ADD
        - to:
            uri: ignite-set:visitedPages
            parameters:
              operation: SIZE
        - log:
            message: "Pages visited: ${body}"