This is an automated email from the ASF dual-hosted git repository. orpiske pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit d0d01ba634d6a71b43f30ec9261419bb72c6fe77 Author: Otavio Rodolfo Piske <[email protected]> AuthorDate: Mon Feb 26 10:59:28 2024 +0100 CAMEL-20459: documentation fixes for the poll enricher EIP. --- .../docs/modules/eips/pages/pollEnrich-eip.adoc | 34 ++++++++++++---------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc index 6648d93e415..a0a13bce497 100644 --- a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc +++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc @@ -23,13 +23,13 @@ In Camel the Content Enricher can be done in several ways: The most natural Camel approach is using xref:enrich-eip.adoc[Enrich] EIP, which comes as two kinds: -* xref:enrich-eip.adoc[Enrich] EIP - This is the most common content enricher that uses a `Producer` to obtain the data. -It is usually used for xref:requestReply-eip.adoc[Request Reply] messaging, for instance to invoke an external web service. +* xref:enrich-eip.adoc[Enrich] EIP: This is the most common content enricher that uses a `Producer` to obtain the data. +It is usually used for xref:requestReply-eip.adoc[Request Reply] messaging, for instance, to invoke an external web service. -* xref:pollEnrich-eip.adoc[Poll Enrich] EIP - Uses a xref:polling-consumer.adoc[Polling +* xref:pollEnrich-eip.adoc[Poll Enrich] EIP: Uses a xref:polling-consumer.adoc[Polling Consumer] to obtain the additional data. It is usually used for -xref:event-message.adoc[Event Message] messaging, for instance to read a -file or download a xref:ROOT:ftp-component.adoc[FTP] file. +xref:event-message.adoc[Event Message] messaging, for instance, to read a +file or download a file using xref:ROOT:ftp-component.adoc[FTP]. NOTE: This page documents the Poll Enrich EIP. @@ -48,21 +48,23 @@ include::partial$eip-exchangeProperties.adoc[] == Content enrichment using Poll Enrich EIP `pollEnrich` uses a xref:polling-consumer.adoc[Polling Consumer] to obtain the additional data. -It is usually used for xref:event-message.adoc[Event Message] messaging, for instance to read a file or download a FTP file. +It is usually used for xref:event-message.adoc[Event Message] messaging, +for instance, to read a file or download a file using FTP. The `pollEnrich` works just the same as `enrich`, -however as it uses a xref:polling-consumer.adoc[Polling Consumer] we have three methods when polling: +however, as it uses a xref:polling-consumer.adoc[Polling Consumer], we have three methods when polling: -* `receive` - Waits until a message is available and then returns it. *Warning* that this method could block indefinitely if no messages are available. -* `receiveNoWait` - Attempts to receive a message exchange immediately without waiting and returning `null` if a message exchange is not available yet. -* `receive(timeout)` - Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns the message or `null` if the timeout expired. +* `receive`: Waits until a message is available and then returns it. *Warning* that this method could block indefinitely if no messages are available. +* `receiveNoWait`: Attempts to receive a message exchange immediately without waiting and returning `null` if a message exchange is not available yet. +* `receive(timeout)`: Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns the message or `null` if the timeout expired. === Poll Enrich with timeout It is good practice to use timeout value. By default, Camel will use the `receive` which may block until there is a message available. -It is therefore recommended to always provide a timeout value, to make this clear that we may wait for a message, until the timeout is hit. +It is therefore recommended to always provide a timeout value, +to make this clear that we may wait for a message until the timeout is hit. You can pass in a timeout value that determines which method to use: @@ -70,7 +72,7 @@ You can pass in a timeout value that determines which method to use: * if timeout is `0` then `receiveNoWait` is selected * otherwise, `receive(timeout)` is selected -The timeout values is in millis. +The timeout values are in milliseconds. === Using Poll Enrich @@ -112,7 +114,7 @@ from("direct:start") .to("mock:result"); ---- -In the example Camel will poll a file (timeout 10 seconds). +In the example, Camel will poll a file (timeout 10 seconds). The `AggregationStrategy` is then used to merge the file with the existing `Exchange`. In XML DSL you use `pollEnrich` as follows: @@ -134,8 +136,8 @@ In XML DSL you use `pollEnrich` as follows: === Using Poll Enrich with Rest DSL -You can also use `pollEnrich` with xref:manual::rest-dsl.adoc[Rest DSL] to -for example download a file from xref:ROOT:aws2-s3-component.adoc[AWS S3] as the response of an API call. +You can also use `pollEnrich` with xref:manual::rest-dsl.adoc[Rest DSL] to, +for example, download a file from xref:ROOT:aws2-s3-component.adoc[AWS S3] as the response of an API call. [source,xml] ---- @@ -151,7 +153,7 @@ for example download a file from xref:ROOT:aws2-s3-component.adoc[AWS S3] as the </rest> ---- -Notice that the enriched endpoint is a constant, however Camel also supports dynamic endpoints which is covered next. +Notice that the enriched endpoint is a constant, however, Camel also supports dynamic endpoints which is covered next. === Poll Enrich with Dynamic Endpoints
