brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From grk...@apache.org
Subject [2/5] incubator-brooklyn git commit: Added Javadoc describing new entity lifecycle configuration keys
Date Tue, 13 Jan 2015 15:55:56 GMT
Added Javadoc describing new entity lifecycle configuration keys


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

Branch: refs/heads/master
Commit: 0e90d52f6c8141cc6f52eeeb094f3161cef0647d
Parents: d02e107
Author: Andrew Kennedy <grkvlt@apache.org>
Authored: Fri Dec 19 14:19:22 2014 +0000
Committer: Andrew Kennedy <grkvlt@apache.org>
Committed: Mon Jan 12 21:45:01 2015 +0000

----------------------------------------------------------------------
 .../entity/basic/BrooklynConfigKeys.java        | 29 ++++++++++++++++++++
 1 file changed, 29 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0e90d52f/core/src/main/java/brooklyn/entity/basic/BrooklynConfigKeys.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/entity/basic/BrooklynConfigKeys.java b/core/src/main/java/brooklyn/entity/basic/BrooklynConfigKeys.java
index f26280d..e40be9a 100644
--- a/core/src/main/java/brooklyn/entity/basic/BrooklynConfigKeys.java
+++ b/core/src/main/java/brooklyn/entity/basic/BrooklynConfigKeys.java
@@ -21,8 +21,10 @@ package brooklyn.entity.basic;
 import static brooklyn.entity.basic.ConfigKeys.*;
 import brooklyn.config.BrooklynServerConfig;
 import brooklyn.config.ConfigKey;
+import brooklyn.entity.trait.Startable;
 import brooklyn.event.basic.AttributeSensorAndConfigKey;
 import brooklyn.event.basic.TemplatedStringAttributeSensorAndConfigKey;
+import brooklyn.location.Location;
 import brooklyn.util.internal.ssh.ShellTool;
 import brooklyn.util.internal.ssh.SshTool;
 import brooklyn.util.time.Duration;
@@ -55,8 +57,35 @@ public class BrooklynConfigKeys {
             "this should include something readable, and must include a hash of all data
which differentiates an installation " +
             "(e.g. version, plugins, etc), but should be the same where install dirs can
be shared to allow for re-use");
 
+    /**
+     * Set this configuration value to true if the entity installation, customization and
launch process is to be skipped entirely.
+     * <p>
+     * This is usually because the process or service the entity represents is already present
and started, as part of the image
+     * being used. The {@link Startable#SERVICE_UP} attribute will be set in the usual manner.
+     * <p>
+     * If this key is set on a {@link Location} then all entities in that location will be
treated in this way. This is useful
+     * when the location is configured with a particular image containing installed and running
services.
+     *
+     * @see #ENTITY_RUNNING
+     */
     public static final ConfigKey<Boolean> ENTITY_STARTED = newBooleanConfigKey("entity.started",
"Skip the startup process entirely, for running services");
+
+    /**
+     * Set this configuration value to true to skip the entity startup process as with {@link
#ENTITY_STARTED} if the process or
+     * service represented by the entity is already running, otherwise proceed normally.
This is determined using the driver's
+     * {@code isRunning()} method.
+     * <p>
+     * If this key is set on a {@link Location} then all entities in that location will be
treated in this way, again as with {@link #ENTITY_STARTED}.
+     *
+     * @see #ENTITY_STARTED
+     */
     public static final ConfigKey<Boolean> ENTITY_RUNNING = newBooleanConfigKey("entity.running",
"Skip the startup process entirely, if service already running");
+
+    /**
+     * Set this configuration value to true if the entity installation, customization and
launch process is to be skipped entirely.
+     * <p>
+     * This will skip the installation phase of the lifecycle, and move directl;y to customization
and launching of the entity.
+     */
     public static final ConfigKey<Boolean> SKIP_INSTALLATION = newBooleanConfigKey("install.skip",
"Skip the driver install commands entirely, for pre-installed software");
 
     // The implementation in AbstractSoftwareSshDriver runs this command as an SSH command



Mime
View raw message