[18/50] brooklyn-server git commit: DynamicCluster.quarantine: review comments

[he...@apache.org]

DynamicCluster.quarantine: review comments

- adds javadoc
- improves config key description

Project: http://git-wip-us.apache.org/repos/asf/brooklyn-server/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-server/commit/0bcb7446
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-server/tree/0bcb7446
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-server/diff/0bcb7446

Branch: refs/heads/0.6.0
Commit: 0bcb74468e8a74afbcde9e46fda1ec9943c8ea8e
Parents: 5decba3
Author: Aled Sage <al...@gmail.com>
Authored: Thu Nov 7 12:04:43 2013 +0000
Committer: Aled Sage <al...@gmail.com>
Committed: Thu Nov 7 12:04:43 2013 +0000

----------------------------------------------------------------------
 .../java/brooklyn/entity/group/DynamicCluster.java     | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/0bcb7446/core/src/main/java/brooklyn/entity/group/DynamicCluster.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/entity/group/DynamicCluster.java b/core/src/main/java/brooklyn/entity/group/DynamicCluster.java
index 2cd4b48..9b0a307 100644
--- a/core/src/main/java/brooklyn/entity/group/DynamicCluster.java
+++ b/core/src/main/java/brooklyn/entity/group/DynamicCluster.java
@@ -39,6 +39,17 @@ import com.google.common.collect.Multimap;
 
 /**
  * A cluster of entities that can dynamically increase or decrease the number of entities.
+ * 
+ * When quarantine is enabled:
+ * <ul
+ *   <li> The DynamicCluster will have a child entity named "quarantine", which is a group for nodes that failed to start correctly.
+ *   <li> The DynamicCluster's other children will be all nodes in the cluster (that have not been unmanaged/deleted).
+ *   <li> The DynamicCluster's members will be all live nodes in the cluster.
+ *   <li> The Quarantine group's members will be all problem nodes (all nodes that failed to start correctly)
+ * </ul> 
+ * 
+ * When quarantine is disabled, the DynamicCluster will not have a "quarantine" child. Nodes that fail to start will be 
+ * removed from the cluster (i.e. stopped and deleted).
  */
 @ImplementedBy(DynamicClusterImpl.class)
 public interface DynamicCluster extends AbstractGroup, Cluster {
@@ -62,7 +73,7 @@ public interface DynamicCluster extends AbstractGroup, Cluster {
 
     @SetFromFlag("quarantineFailedEntities")
     public static final ConfigKey<Boolean> QUARANTINE_FAILED_ENTITIES = new BasicConfigKey<Boolean>(
-            Boolean.class, "dynamiccluster.quarantineFailedEntities", "Whether to quarantine entities that fail to start, or to try to clean them up", true);
+            Boolean.class, "dynamiccluster.quarantineFailedEntities", "If true, will quarantine entities that fail to start; if false, will get rid of them (i.e. delete them)", true);
 
     public static final AttributeSensor<Lifecycle> SERVICE_STATE = Attributes.SERVICE_STATE;