This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch camel-2.21.x in repository https://gitbox.apache.org/repos/asf/camel.git
commit 1fd2d3328e141ef76d1e02ae4e9f5620134498d0 Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Sat Mar 17 10:37:19 2018 +0100 Polished --- camel-core/src/main/docs/eips/saga-eip.adoc | 16 ++++++++-------- .../apache/camel/impl/{cluster => cloud}/package.html | 2 +- .../main/java/org/apache/camel/impl/cluster/package.html | 2 +- .../org/apache/camel/impl/{cluster => saga}/package.html | 2 +- .../apache/camel/{spi => impl/transformer}/package.html | 2 +- .../apache/camel/{spi => impl/validator}/package.html | 2 +- .../apache/camel/{spi => processor/saga}/package.html | 2 +- .../org/apache/camel/processor/validation/package.html | 3 +-- .../java/org/apache/camel/saga/CamelSagaCoordinator.java | 4 ++-- .../main/java/org/apache/camel/saga/CamelSagaStep.java | 3 ++- .../java/org/apache/camel/{spi => saga}/package.html | 2 +- .../src/main/java/org/apache/camel/spi/package.html | 2 +- .../org/apache/camel/{spi => util/function}/package.html | 2 +- 13 files changed, 22 insertions(+), 22 deletions(-) diff --git a/camel-core/src/main/docs/eips/saga-eip.adoc b/camel-core/src/main/docs/eips/saga-eip.adoc index 2529c6d..1dbb0d1 100644 --- a/camel-core/src/main/docs/eips/saga-eip.adoc +++ b/camel-core/src/main/docs/eips/saga-eip.adoc @@ -41,10 +41,10 @@ The Saga EIP supports 6 options which are listed below: The following properties are set on each Exchange that is participating to a Saga (normal actions, compensating actions and completions): [width="100%",cols="4m,2m,5",options="header"] -|======================================================================= +|=== | Property | Type | Description | `Long-Running-Action` | `String` | A globally unique identifier for the Saga that can be propagated to remote systems using transport-level headers (e.g. HTTP). -|======================================================================= +|=== === Saga Service Configuration The Saga EIP requires that a service implementing the interface `org.apache.camel.saga.CamelSagaService` is added to the Camel context. @@ -120,9 +120,9 @@ sagaService.setLocalParticipantUrl("http://my-host-as-seen-by-lra-service:8080/c context.addService(sagaService); ---- -===== Using the LRA Saga Service in Spring-Boot +===== Using the LRA Saga Service in Spring Boot -Spring-Boot users can use a simplified configuration model for the LRA Saga Service. Maven users can +Spring Boot users can use a simplified configuration model for the LRA Saga Service. Maven users can include the *camel-lra-starter* module in their project: [source,xml] @@ -142,7 +142,7 @@ include the *camel-lra-starter* module in their project: </dependency> ---- -Configuration can be done in the Spring-Boot `application.yaml` file: +Configuration can be done in the Spring Boot `application.yaml` file: .application.yaml [source,yaml] @@ -333,7 +333,7 @@ Since the _direct:creditReservation_ endpoint can be now called also from outsid Sagas are long running actions, but this does not mean that they should not have a bounded timeframe to execute. *Setting timeouts on Sagas is always a good practice* as it guarantees that a Saga does not remain stuck forever in the case of machine failure. -NOTE: the Saga EIP implementation may have a default timeout set on all Sagas that don't specify it explicitly +NOTE: The Saga EIP implementation may have a default timeout set on all Sagas that don't specify it explicitly When the timeout expires, the Saga EIP will decide to *cancel the Saga* (and compensate all participants), unless a different decision has been taken before. @@ -371,7 +371,7 @@ that is the default propagation used when nothing else is specified. These propagation modes map 1:1 the equivalent modes used in transactional contexts. Here's a summary of their meaning: [width="100%",cols="2m,8",options="header"] -|======================================================================= +|=== | Propagation | Description | `REQUIRED` | Join the existing saga or create a new one if it does not exist. | `REQUIRES_NEW` | Always create a new saga. Suspend the old saga and resume it when the new one terminates. @@ -379,7 +379,7 @@ These propagation modes map 1:1 the equivalent modes used in transactional conte | `SUPPORTS` | If a saga already exists, then join it. | `NOT_SUPPORTED` | If a saga already exists, it is suspended and resumed when the current block completes. | `NEVER` | The current block must never be invoked within a saga. -|======================================================================= +|=== ==== Using Manual Completion (Advanced) When a Saga cannot be all executed in a synchronous way, but it requires e.g. communication with external services using asynchronous communication channels, diff --git a/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html b/camel-core/src/main/java/org/apache/camel/impl/cloud/package.html similarity index 94% copy from camel-core/src/main/java/org/apache/camel/impl/cluster/package.html copy to camel-core/src/main/java/org/apache/camel/impl/cloud/package.html index a5e4586..0cb155c 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html +++ b/camel-core/src/main/java/org/apache/camel/impl/cloud/package.html @@ -19,7 +19,7 @@ </head> <body> -Base classes and Implementation for Camel Cluster +Base classes and implementation for Camel Cloud </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html b/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html index a5e4586..f7317f9 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html +++ b/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html @@ -19,7 +19,7 @@ </head> <body> -Base classes and Implementation for Camel Cluster +Base classes and implementation for Camel Cluster </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html b/camel-core/src/main/java/org/apache/camel/impl/saga/package.html similarity index 94% copy from camel-core/src/main/java/org/apache/camel/impl/cluster/package.html copy to camel-core/src/main/java/org/apache/camel/impl/saga/package.html index a5e4586..755a855 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/cluster/package.html +++ b/camel-core/src/main/java/org/apache/camel/impl/saga/package.html @@ -19,7 +19,7 @@ </head> <body> -Base classes and Implementation for Camel Cluster +In-memory Saga coordinator. </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/spi/package.html b/camel-core/src/main/java/org/apache/camel/impl/transformer/package.html similarity index 90% copy from camel-core/src/main/java/org/apache/camel/spi/package.html copy to camel-core/src/main/java/org/apache/camel/impl/transformer/package.html index 5a7d0f5..8c7f9bf 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/package.html +++ b/camel-core/src/main/java/org/apache/camel/impl/transformer/package.html @@ -21,7 +21,7 @@ </head> <body> -Service Provider Interfaces used internally by the Camel runtime which are plugin strategies. +Transformer implementation classes. </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/spi/package.html b/camel-core/src/main/java/org/apache/camel/impl/validator/package.html similarity index 90% copy from camel-core/src/main/java/org/apache/camel/spi/package.html copy to camel-core/src/main/java/org/apache/camel/impl/validator/package.html index 5a7d0f5..b1e7f1a 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/package.html +++ b/camel-core/src/main/java/org/apache/camel/impl/validator/package.html @@ -21,7 +21,7 @@ </head> <body> -Service Provider Interfaces used internally by the Camel runtime which are plugin strategies. +Validator implementation classes. </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/spi/package.html b/camel-core/src/main/java/org/apache/camel/processor/saga/package.html similarity index 90% copy from camel-core/src/main/java/org/apache/camel/spi/package.html copy to camel-core/src/main/java/org/apache/camel/processor/saga/package.html index 5a7d0f5..69393d4 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/package.html +++ b/camel-core/src/main/java/org/apache/camel/processor/saga/package.html @@ -21,7 +21,7 @@ </head> <body> -Service Provider Interfaces used internally by the Camel runtime which are plugin strategies. +Saga EIP implementation. </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/processor/validation/package.html b/camel-core/src/main/java/org/apache/camel/processor/validation/package.html index 1339cdc..8721b1d 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/validation/package.html +++ b/camel-core/src/main/java/org/apache/camel/processor/validation/package.html @@ -21,8 +21,7 @@ </head> <body> -Performs XML validation using <a href="http://java.sun.com/xml/jaxp/index.jsp">JAXP</a> for validating against XSD or -RelaxNG +Performs XML validation using JAXP for validating against XSD </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/saga/CamelSagaCoordinator.java b/camel-core/src/main/java/org/apache/camel/saga/CamelSagaCoordinator.java index c71a1a8..f6f1534 100644 --- a/camel-core/src/main/java/org/apache/camel/saga/CamelSagaCoordinator.java +++ b/camel-core/src/main/java/org/apache/camel/saga/CamelSagaCoordinator.java @@ -21,9 +21,9 @@ import java.util.concurrent.CompletableFuture; import org.apache.camel.Exchange; import org.apache.camel.spi.HasId; - /** - * A saga coordinator can be used to register compensators and take the final decision on the saga: compensate or complete (successfully). + * A saga coordinator can be used to register compensator's and + * take the final decision on the saga: compensate or complete (successfully). */ public interface CamelSagaCoordinator extends HasId { diff --git a/camel-core/src/main/java/org/apache/camel/saga/CamelSagaStep.java b/camel-core/src/main/java/org/apache/camel/saga/CamelSagaStep.java index 715d3a8..b912153 100644 --- a/camel-core/src/main/java/org/apache/camel/saga/CamelSagaStep.java +++ b/camel-core/src/main/java/org/apache/camel/saga/CamelSagaStep.java @@ -36,7 +36,8 @@ public class CamelSagaStep { private Optional<Long> timeoutInMilliseconds; - public CamelSagaStep(Optional<Endpoint> compensation, Optional<Endpoint> completion, Map<String, Expression> options, Optional<Long> timeoutInMilliseconds) { + public CamelSagaStep(Optional<Endpoint> compensation, Optional<Endpoint> completion, + Map<String, Expression> options, Optional<Long> timeoutInMilliseconds) { this.compensation = ObjectHelper.notNull(compensation, "compensation"); this.completion = ObjectHelper.notNull(completion, "completionCallbacks"); this.options = ObjectHelper.notNull(options, "options"); diff --git a/camel-core/src/main/java/org/apache/camel/spi/package.html b/camel-core/src/main/java/org/apache/camel/saga/package.html similarity index 90% copy from camel-core/src/main/java/org/apache/camel/spi/package.html copy to camel-core/src/main/java/org/apache/camel/saga/package.html index 5a7d0f5..d848955 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/package.html +++ b/camel-core/src/main/java/org/apache/camel/saga/package.html @@ -21,7 +21,7 @@ </head> <body> -Service Provider Interfaces used internally by the Camel runtime which are plugin strategies. +Camel Saga EIP </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/spi/package.html b/camel-core/src/main/java/org/apache/camel/spi/package.html index 5a7d0f5..cf63ae7 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/package.html +++ b/camel-core/src/main/java/org/apache/camel/spi/package.html @@ -21,7 +21,7 @@ </head> <body> -Service Provider Interfaces used internally by the Camel runtime which are plugin strategies. +Service Provider Interfaces used by the Camel runtime which are plugin strategies. </body> </html> diff --git a/camel-core/src/main/java/org/apache/camel/spi/package.html b/camel-core/src/main/java/org/apache/camel/util/function/package.html similarity index 90% copy from camel-core/src/main/java/org/apache/camel/spi/package.html copy to camel-core/src/main/java/org/apache/camel/util/function/package.html index 5a7d0f5..01cc2c2 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/package.html +++ b/camel-core/src/main/java/org/apache/camel/util/function/package.html @@ -21,7 +21,7 @@ </head> <body> -Service Provider Interfaces used internally by the Camel runtime which are plugin strategies. +Function utility classes </body> </html> -- To stop receiving notification emails like this one, please contact davscl...@apache.org.