You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by tm...@apache.org on 2020/02/12 12:22:25 UTC
[sling-org-apache-sling-distribution-api] branch master updated:
SLING-9064 - Javadoc use self-closing elements and invalid characters
This is an automated email from the ASF dual-hosted git repository.
tmaret pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-distribution-api.git
The following commit(s) were added to refs/heads/master by this push:
new 4870792 SLING-9064 - Javadoc use self-closing elements and invalid characters
4870792 is described below
commit 4870792678effd78902b3908e3e0465841e345b1
Author: tmaret <tm...@adobe.com>
AuthorDate: Wed Feb 12 13:22:13 2020 +0100
SLING-9064 - Javadoc use self-closing elements and invalid characters
---
.../org/apache/sling/distribution/DistributionRequest.java | 2 +-
.../apache/sling/distribution/DistributionRequestState.java | 13 ++++++++-----
.../apache/sling/distribution/DistributionRequestType.java | 5 ++++-
.../java/org/apache/sling/distribution/Distributor.java | 5 ++++-
.../distribution/transport/DistributionTransportSecret.java | 7 +++++--
.../transport/DistributionTransportSecretProvider.java | 5 ++++-
6 files changed, 26 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/sling/distribution/DistributionRequest.java b/src/main/java/org/apache/sling/distribution/DistributionRequest.java
index fe118c8..6545130 100644
--- a/src/main/java/org/apache/sling/distribution/DistributionRequest.java
+++ b/src/main/java/org/apache/sling/distribution/DistributionRequest.java
@@ -62,7 +62,7 @@ public interface DistributionRequest {
* -/foo - exclude /foo node
*
* filters are checked in order and the last matched filter determines inclusion/exclusion
- *
+ * @param path the path to get applicable filters for
* @return an array of filters
*/
@NotNull
diff --git a/src/main/java/org/apache/sling/distribution/DistributionRequestState.java b/src/main/java/org/apache/sling/distribution/DistributionRequestState.java
index da42081..4dcf6d6 100644
--- a/src/main/java/org/apache/sling/distribution/DistributionRequestState.java
+++ b/src/main/java/org/apache/sling/distribution/DistributionRequestState.java
@@ -21,17 +21,20 @@ package org.apache.sling.distribution;
import aQute.bnd.annotation.ProviderType;
/**
+ * <p>
* The different states a {@link org.apache.sling.distribution.DistributionRequest} can have during its lifecycle.
* Allowed transitions of {@link org.apache.sling.distribution.DistributionRequestState} for a certain
* {@link org.apache.sling.distribution.DistributionRequest} are:
- * {@code #DISTRIBUTED} -> ø
- * {@code #DROPPED} -> ø
- * {@code #ACCEPTED} -> {@code #DROPPED}
- * {@code #ACCEPTED} -> {@code #DISTRIBUTED}
- * <p/>
+ * {@code #DISTRIBUTED} to ø,
+ * {@code #DROPPED} to ø,
+ * {@code #ACCEPTED} to {@code #DROPPED},
+ * {@code #ACCEPTED} to {@code #DISTRIBUTED}.
+ * </p>
+ * <p>
* {@link org.apache.sling.distribution.DistributionRequest}s executed synchronously
* will only results in {@code #DISTRIBUTED} or {@code #DROPPED} {@link org.apache.sling.distribution.DistributionRequestState}s
* while requests executed asynchronously can result in any of {@code #DISTRIBUTED}, {@code #DROPPED} or {@code #ACCEPTED} states.
+ * </p>
*/
@ProviderType
public enum DistributionRequestState {
diff --git a/src/main/java/org/apache/sling/distribution/DistributionRequestType.java b/src/main/java/org/apache/sling/distribution/DistributionRequestType.java
index d01f28e..c534983 100644
--- a/src/main/java/org/apache/sling/distribution/DistributionRequestType.java
+++ b/src/main/java/org/apache/sling/distribution/DistributionRequestType.java
@@ -23,14 +23,17 @@ import aQute.bnd.annotation.ProviderType;
import org.jetbrains.annotations.Nullable;
/**
+ * <p>
* The request type tied to a specific {@link org.apache.sling.distribution.DistributionRequest}, used to decide how
* the distribution content should be aggregated.
- * <p/>
+ * </p>
+ * <p>
* {@code ADD} requests can for example lead to the creation of a package of resources to be persisted on the target instance.
* {@code DELETE} requests can for example lead to the creation of a "command package" to be sent to the target instance
* to actually remove the resources specified in {@link DistributionRequest#getPaths()}.
* {@code PULL} requests can for example lead to the creation of a "command package" that will trigger fetching of content
* from the target instance.
+ * </p>
*/
@ProviderType
public enum DistributionRequestType {
diff --git a/src/main/java/org/apache/sling/distribution/Distributor.java b/src/main/java/org/apache/sling/distribution/Distributor.java
index 192ff39..8895401 100644
--- a/src/main/java/org/apache/sling/distribution/Distributor.java
+++ b/src/main/java/org/apache/sling/distribution/Distributor.java
@@ -24,10 +24,13 @@ import org.apache.sling.api.resource.ResourceResolver;
import org.jetbrains.annotations.NotNull;
/**
+ * <p>
* A distributor is responsible for dispatching {@link org.apache.sling.distribution.DistributionRequest}s to distribution agents.
- * <p/>
+ * </p>
+ * <p>
* The distribution agents are executing the requests by creating packages from a source Sling instance containing content for the specified paths
* and then pushing and installing these on a target instance.
+ * </p>
*/
@ProviderType
public interface Distributor {
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 9719531..815142a 100644
--- a/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecret.java
+++ b/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecret.java
@@ -24,10 +24,13 @@ import aQute.bnd.annotation.ConsumerType;
import org.jetbrains.annotations.Nullable;
/**
+ * <p>
* The secret to be transported for authenticating transport layer connecting two instances.
- * <p/>
+ * </p>
+ * <p>
* Secrets can take different forms, like e.g. username and password, tokens, public keys, etc. and are meant to be used
* by transport implementations used by distribution agents.
+ * </p>
*/
@ConsumerType
public interface DistributionTransportSecret {
@@ -37,7 +40,7 @@ public interface DistributionTransportSecret {
* about username and password for HTTP authentication.
*
* @return the credentials as a {@link java.util.Map}, or {@code null} if {@code secret} cannot be represented in terms
- * of a set of key -> value entries
+ * of a set of key -> value entries
*/
@Nullable
Map<String, String> asCredentialsMap();
diff --git a/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecretProvider.java b/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecretProvider.java
index 7a1f5b2..eaac9c9 100644
--- a/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecretProvider.java
+++ b/src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecretProvider.java
@@ -25,11 +25,14 @@ import java.net.URI;
import org.jetbrains.annotations.Nullable;
/**
+ * <p>
* A provider for {@link org.apache.sling.distribution.transport.DistributionTransportSecret}s
- * <p/>
+ * </p>
+ * <p>
* Such providers can be used by distribution agents implementations in order to plug
* in different types of {@link org.apache.sling.distribution.transport.DistributionTransportSecret secrets} to be used
* to authenticate the underlying Sling instances.
+ * </p>
*/
@ConsumerType
public interface DistributionTransportSecretProvider {