This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to annotated tag org.apache.sling.distribution.api-0.1.0 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-distribution-api.git
commit 9cbb70eb07257d4bc879e21ecf3d3448845adfeb Author: Tommaso Teofili <[email protected]> AuthorDate: Mon Dec 15 16:22:43 2014 +0000 SLING-4153 - fixed request states, removed useless asStream method in transport secret git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/distribution/api@1645689 13f79535-47bb-0310-9956-ffa450edef68 --- .../communication/DistributionRequestState.java | 32 +++++++++++----------- .../communication/DistributionResponse.java | 3 +- .../distribution/communication/Distributor.java | 3 +- .../communication/SimpleDistributionRequest.java | 3 +- .../transport/DistributionTransportSecret.java | 9 ------ 5 files changed, 22 insertions(+), 28 deletions(-) diff --git a/src/main/java/org/apache/sling/distribution/communication/DistributionRequestState.java b/src/main/java/org/apache/sling/distribution/communication/DistributionRequestState.java index 6c2c751..914240d 100644 --- a/src/main/java/org/apache/sling/distribution/communication/DistributionRequestState.java +++ b/src/main/java/org/apache/sling/distribution/communication/DistributionRequestState.java @@ -22,33 +22,33 @@ package org.apache.sling.distribution.communication; * The different states a {@link org.apache.sling.distribution.communication.DistributionRequest} can have during its lifecycle. * Allowed transitions of {@link org.apache.sling.distribution.communication.DistributionRequestState} for a certain * {@link org.apache.sling.distribution.communication.DistributionRequest} are: - * {@code #SUCCEEDED} -> ø - * {@code #FAILED} -> ø - * {@code #ACCEPTED} -> {@code #FAILED} - * {@code #ACCEPTED} -> {@code #SUCCEEDED} + * {@code #DISTRIBUTED} -> ø + * {@code #DROPPED} -> ø + * {@code #ACCEPTED} -> {@code #DROPPED} + * {@code #ACCEPTED} -> {@code #DISTRIBUTED} * <p/> - * {@link org.apache.sling.distribution.communication.DistributionRequest}s against synchronous {@link org.apache.sling.distribution.agent.DistributionAgent}s - * will only results in {@code #SUCCEEDED} or {@code #FAILED} {@link org.apache.sling.distribution.communication.DistributionRequestState}s - * while requests against asynchronous agents can result in any of {@code #SUCCEEDED}, {@code #FAILED} or {@code #ACCEPTED} states. + * {@link org.apache.sling.distribution.communication.DistributionRequest}s executed synchronously + * will only results in {@code #DISTRIBUTED} or {@code #DROPPED} {@link org.apache.sling.distribution.communication.DistributionRequestState}s + * while requests executed asynchronously can result in any of {@code #DISTRIBUTED}, {@code #DROPPED} or {@code #ACCEPTED} states. */ public enum DistributionRequestState { /** - * A {@link org.apache.sling.distribution.communication.DistributionRequest} has succeeded when the content has been - * successfully distributed (created, transported and persisted) from the source instance to the target instance. + * The request has completed and the content has been successfully distributed + * (created, transported and persisted) from the source instance to the target instance. */ - SUCCEEDED, + DISTRIBUTED, /** - * A {@link org.apache.sling.distribution.communication.DistributionRequest} has failed when the content cannot be - * successfully distributed from the source instance to target instance, this means the request execution failed during - * one of: creation, transport, persistence. + * The request has been dropped and the content could not be successfully + * distributed from the source to target instance, this means the request + * execution failed during one of: creation, queueing, transport, persistence. */ - FAILED, + DROPPED, /** - * A {@link org.apache.sling.distribution.communication.DistributionRequest} has been accepted when the content to be - * distributed has been successfully created, but not yet either transported or persisted correctly to the target instance. + * The request has been accepted, as a consequence the content to be distributed + * has been created and queued (and it will be eventually processed asynchronously). */ ACCEPTED diff --git a/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java b/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java index 423dbe2..c2c7298 100644 --- a/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java +++ b/src/main/java/org/apache/sling/distribution/communication/DistributionResponse.java @@ -53,7 +53,8 @@ public interface DistributionResponse { /** * returns a verbose message of the response - * @return + * @return a message associated with this response holding information about + * e.g. why distribution execution failed, etc. */ @CheckForNull String getMessage(); diff --git a/src/main/java/org/apache/sling/distribution/communication/Distributor.java b/src/main/java/org/apache/sling/distribution/communication/Distributor.java index ac492be..3d1b77c 100644 --- a/src/main/java/org/apache/sling/distribution/communication/Distributor.java +++ b/src/main/java/org/apache/sling/distribution/communication/Distributor.java @@ -48,7 +48,8 @@ public interface Distributor { * @return a {@link org.apache.sling.distribution.communication.DistributionResponse} */ @Nonnull - DistributionResponse distribute(@Nonnull String agentName, @Nonnull ResourceResolver resourceResolver, @Nonnull DistributionRequest distributionRequest); + DistributionResponse distribute(@Nonnull String agentName, @Nonnull ResourceResolver resourceResolver, + @Nonnull DistributionRequest distributionRequest); } diff --git a/src/main/java/org/apache/sling/distribution/communication/SimpleDistributionRequest.java b/src/main/java/org/apache/sling/distribution/communication/SimpleDistributionRequest.java index 201e5e0..010e516 100644 --- a/src/main/java/org/apache/sling/distribution/communication/SimpleDistributionRequest.java +++ b/src/main/java/org/apache/sling/distribution/communication/SimpleDistributionRequest.java @@ -58,6 +58,7 @@ public final class SimpleDistributionRequest implements DistributionRequest { * * @return the type of the request as a {@link DistributionRequestType} */ + @Nonnull public DistributionRequestType getRequestType() { return requestType; } @@ -76,7 +77,7 @@ public final class SimpleDistributionRequest implements DistributionRequest { * Returns whether the a path is covering the entire subtree (deep) or just the specified nodes (shallow) * @return <code>true</code> if the path is deep */ - public boolean isDeep(String path) { + public boolean isDeep(@Nonnull String path) { return deep; } diff --git a/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecret.java b/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecret.java index 476581b..da1bb7f 100644 --- a/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecret.java +++ b/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecret.java @@ -43,13 +43,4 @@ public interface DistributionTransportSecret { @CheckForNull Map<String, String> asCredentialsMap(); - /** - * Get the secrete as a raw {@link java.io.InputStream binary}. - * Note that each call to this method will create a new stream, so the caller will be responsible of closing it. - * - * @return the secret as an {@link java.io.InputStream}, or {@code null} if such a secret cannot represented as a stream. - */ - @CheckForNull - InputStream asStream(); - } -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
