svn commit: r1676252 - /sling/trunk/bundles/extensions/discovery/api/src/main/java/org/apache/sling/discovery/ClusterView.java

[st...@apache.org]

Author: stefanegli
Date: Mon Apr 27 13:12:03 2015
New Revision: 1676252

URL: http://svn.apache.org/r1676252
Log:
SLING-4668 : following clarifying note added to getId: 'Addition in 1.0.4: this id must consist only of alphanumeric characters plus dash '-' and underscore '_'.

Modified:
    sling/trunk/bundles/extensions/discovery/api/src/main/java/org/apache/sling/discovery/ClusterView.java

Modified: sling/trunk/bundles/extensions/discovery/api/src/main/java/org/apache/sling/discovery/ClusterView.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/discovery/api/src/main/java/org/apache/sling/discovery/ClusterView.java?rev=1676252&r1=1676251&r2=1676252&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/discovery/api/src/main/java/org/apache/sling/discovery/ClusterView.java (original)
+++ sling/trunk/bundles/extensions/discovery/api/src/main/java/org/apache/sling/discovery/ClusterView.java Mon Apr 27 13:12:03 2015
@@ -31,27 +31,30 @@ import aQute.bnd.annotation.ProviderType
 @ProviderType
 public interface ClusterView {
 
-	/**
-	 * Returns a stable id of the cluster represented by this
-	 * cluster view.
-	 * <p>
-	 * Similar to the SlingID, this id is persisted and thus
-	 * remains stable accross instance/cluster restarts.
-	 * <p>
-	 * When an instance joins a cluster, it will inherit
-	 * the id from the joined cluster (thus incurs a cluster id
-	 * change).
-	 * <p>
-	 * Note: When instances part from a cluster (eg due to a network
-	 * partitioning) the cluster id is retained. This results in
-	 * potentially multiple clusters with the same id. This 
-	 * fact could be used to detect such partitioning/split brain
-	 * situations. It also implies though that the cluster id
-	 * is not guaranteed to be unique in a topology!
-	 * @return an id of this cluster view
-	 * @see <a href="http://issues.apache.org/jira/browse/SLING-3164">SLING-3164</a>
-	 * @since exists since 1.0.0 - stable since 1.0.2
-	 */
+    /**
+     * Returns a stable id of the cluster represented by this
+     * cluster view.
+     * <p>
+     * Similar to the SlingID, this id is persisted and thus
+     * remains stable accross instance/cluster restarts.
+     * <p>
+     * When an instance joins a cluster, it will inherit
+     * the id from the joined cluster (thus incurs a cluster id
+     * change).
+     * <p>
+     * Note: When instances part from a cluster (eg due to a network
+     * partitioning) the cluster id is retained. This results in
+     * potentially multiple clusters with the same id. This 
+     * fact could be used to detect such partitioning/split brain
+     * situations. It also implies though that the cluster id
+     * is not guaranteed to be unique in a topology!
+     * <p>
+     * Addition in 1.0.4: this id must consist only of alphanumeric
+     * characters plus dash '-' and underscore '_'.
+     * @return an id of this cluster view
+     * @see <a href="http://issues.apache.org/jira/browse/SLING-3164">SLING-3164</a>
+     * @since exists since 1.0.0 - stable since 1.0.2 - alphanumeric + '_' and'-' since 1.0.4
+     */
     String getId();
 
     /**
@@ -64,14 +67,14 @@ public interface ClusterView {
      */
     List<InstanceDescription> getInstances();
 
-	/**
-	 * Provides the InstanceDescription belonging to the leader instance.
-	 * <p>
-	 * Every ClusterView is guaranteed to have one and only one leader.
-	 * <p>
-	 * The leader is stable: once a leader is elected it stays leader
-	 * unless it leaves the cluster (due to shutdown/crash/network problems)
-	 * @return the InstanceDescription belonging to the leader instance
-	 */
+    /**
+     * Provides the InstanceDescription belonging to the leader instance.
+     * <p>
+     * Every ClusterView is guaranteed to have one and only one leader.
+     * <p>
+     * The leader is stable: once a leader is elected it stays leader
+     * unless it leaves the cluster (due to shutdown/crash/network problems)
+     * @return the InstanceDescription belonging to the leader instance
+     */
     InstanceDescription getLeader();
 }