Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAMEL-20410: more fixes #13227

Merged
merged 3 commits into from
Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ The URI syntax of the endpoint is:
iec60870-client:host:port/00-01-02-03-04
----

The information object address is encoded in the path in the syntax shows above. Please
note that always the full, 5 octet address format is being used. Unused octets have to be filled
with zero.
The information object address is encoded in the path in the syntax above.
Please note that always the full, 5-octet address format is being used.
Unused octets have to be filled with zero.

A connection instance if identified by the host and port part of the URI, plus all parameters in the "id" group.
If a new connection id is encountered the connection options will be evaluated and the connection instance
A connection instance if identified by the host and port part of the URI, plus all parameters in the _"id"_ group.
If a new connection id is encountered, the connection options will be evaluated and the connection instance
is created with those options.

[NOTE]
Expand All @@ -53,11 +53,11 @@ undefined which of those connection options will be used.

The final connection options will be evaluated in the following order:

* If present, the +connectionOptions+ parameter will be used
* Otherwise the +defaultConnectionOptions+ instance is copied and customized in the following steps
* Apply +protocolOptions+ if present
* Apply +dataModuleOptions+ if present
* Apply all explicit connection parameters (e.g. +timeZone+)
* If present, the `connectionOptions` parameter will be used
* Otherwise, the `defaultConnectionOptions` instance is copied and customized in the following steps
* Apply `protocolOptions` if present
* Apply `dataModuleOptions` if present
* Apply all explicit connection parameters (e.g. `timeZone`)

// component-configure options: START

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ The URI syntax of the endpoint is:
iec60870-server:host:port/00-01-02-03-04
----

The information object address is encoded in the path in the syntax shows above. Please
note that always the full, 5 octet address format is being used. Unused octets have to be filled
with zero.
The information object address is encoded in the path in the syntax above.
Please note that always the full, 5-octet address format is being used.
Unused octets have to be filled with zero.

// component-configure options: START

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

*{component-header}*

The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an https://apacheignite.readme.io/docs/data-grid[Ignite Cache].
The Ignite Cache endpoint is one of camel-ignite endpoints that allow you to interact with an https://apacheignite.readme.io/docs/data-grid[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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

The Ignite Events endpoint is one of camel-ignite endpoints which allows you to https://apacheignite.readme.io/docs/events[receive events] from the Ignite cluster by creating a local event listener.

The Exchanges created by this consumer put the received Event object into the body of the IN message.
The Exchanges created by this consumer put the received Event object into the body of the _IN_ message.

// component-configure options: START

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

*{component-header}*

The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/id-generator[Ignite Atomic Sequences and ID Generators].
The Ignite ID Generator endpoint is one of camel-ignite endpoints that allow you to interact with https://apacheignite.readme.io/docs/id-generator[Ignite Atomic Sequences and ID Generators].

// component-configure options: START

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

*{component-header}*

The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an https://apacheignite.readme.io/docs/messaging[Ignite topic].
The Ignite Messaging endpoint is one of camel-ignite endpoints that allow you to send and consume messages from an https://apacheignite.readme.io/docs/messaging[Ignite topic].

// component-configure options: START

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

*{component-header}*

The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Queue data structures].
The Ignite Queue endpoint is one of camel-ignite endpoints that allow you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Queue data structures].

// component-configure options: START

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

*{component-header}*

The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Set data structures].
The Ignite Sets endpoint is one of camel-ignite endpoints that allows you to interact with https://apacheignite.readme.io/docs/queue-and-set[Ignite Set data structures].

// component-configure options: START

Expand Down
27 changes: 15 additions & 12 deletions components/camel-ignite/src/main/docs/ignite-summary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

*Since Camel {since}*

https://ignite.apache.org/[Apache Ignite] In-Memory Data Fabric is a high-performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies. It is designed to deliver uncompromised performance for a wide set of in-memory computing use cases from high performance computing, to the industry most advanced data grid, highly available service grid, and streaming. See all https://ignite.apache.org/features.html[features].
https://ignite.apache.org/[Apache Ignite] In-Memory Data Fabric is a high performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies. It is designed to deliver uncompromised performance for a wide set of in-memory computing use cases from high-performance computing, to the industry's most advanced data grid, highly available service grid, and streaming. See all https://ignite.apache.org/features.html[features].

image::apache-ignite.png[]

Expand All @@ -20,7 +20,7 @@ indexDescriptionList::[attributes='group={doctitle}',descriptionformat=descripti

== Installation

To use this component, add the following dependency to your pom.xml:
To use this component, add the following dependency to your `pom.xml`:

[source,xml]
----
Expand All @@ -37,9 +37,11 @@ IMPORTANT: If running in an OSGi container, please consult the <<Ignite-OsgiSupp

== Initializing the Ignite component

Each instance of the Ignite component is associated with an underlying org.apache.ignite.Ignite instance. You can interact with two Ignite clusters by initializing two instances of the Ignite component and binding them to different IgniteConfigurations. There are 3 ways to initialize the Ignite component:
Each instance of the Ignite component is associated with an underlying `org.apache.ignite.Ignite` instance.
You can interact with two Ignite clusters by initializing two instances of the Ignite component and binding them to different `IgniteConfigurations`.
There are three ways to initialize the Ignite component:

* By passing in an existing org.apache.ignite.Ignite instance. Here's an example using Spring config:
* By passing in an existing `org.apache.ignite.Ignite` instance. Here's an example using Spring config:

[source,xml]
------------------------------------------------------------
Expand All @@ -48,7 +50,8 @@ Each instance of the Ignite component is associated with an underlying org.apach
</bean>
------------------------------------------------------------

* By passing in an IgniteConfiguration, either constructed programmatically or through inversion of control (e.g. Spring, Blueprint, etc.). Here's an example using Spring config:
* By passing in an IgniteConfiguration, either constructed programmatically or through inversion of control (e.g., Spring, Blueprint, etc).
Here's an example using Spring config:

[source,xml]
-------------------------------------------------------------------
Expand All @@ -70,13 +73,13 @@ Each instance of the Ignite component is associated with an underlying org.apach
</bean>
-------------------------------------------------------------------

Additionally, if using Camel programmatically, there are several convenience static methods in IgniteComponent that return a component out of any of these configuration options:
Additionally, if using Camel programmatically, there are several convenience static methods in IgniteComponent that return a component out of these configuration options:

* IgniteComponent#fromIgnite(Ignite)
* IgniteComponent#fromConfiguration(IgniteConfiguration)
* IgniteComponent#fromInputStream(InputStream)
* IgniteComponent#fromUrl(URL)
* IgniteComponent#fromLocation(String)
* `IgniteComponent#fromIgnite(Ignite)`
* `IgniteComponent#fromConfiguration(IgniteConfiguration)`
* `IgniteComponent#fromInputStream(InputStream)`
* `IgniteComponent#fromUrl(URL)`
* `IgniteComponent#fromLocation(String)`

You may use those methods to quickly create an IgniteComponent with your chosen configuration technique.

Expand All @@ -87,7 +90,7 @@ All endpoints share the following options:
|=======================================================================
| Option | Type | Default value | Description
| propagateIncomingBodyIfNoReturnValue | boolean | true |
If the underlying Ignite operation returns void (no return type), this flag determines whether the producer will copy the IN body into the OUT body.
If the underlying Ignite operation returns void (no return type), this flag determines whether the producer will copy the _IN_ body into the _OUT_ body.

| treatCollectionsAsCacheObjects | boolean | false |
Some Ignite operations can deal with multiple elements at once, if passed a Collection. Enabling this option will treat Collections as a single object, invoking the operation variant for cardinality 1.
Expand Down
Loading
Loading