svn commit: r396058 - in /geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config: ConfigurationData.java ConfigurationManager.java

[am...@apache.org]

Author: ammulder
Date: Fri Apr 21 19:22:05 2006
New Revision: 396058

URL: http://svn.apache.org/viewcvs?rev=396058&view=rev
Log:
Add some docs

Modified:
    geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationData.java
    geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationManager.java

Modified: geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationData.java
URL: http://svn.apache.org/viewcvs/geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationData.java?rev=396058&r1=396057&r2=396058&view=diff
==============================================================================
--- geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationData.java (original)
+++ geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationData.java Fri Apr 21 19:22:05 2006
@@ -181,6 +181,11 @@
         return gbeanState;
     }
 
+    /**
+     * Gets a map of Artifact (config ID) to ConfigurationData for nested
+     * configurations (as in, a WAR within an EAR, not dependencies between
+     * totally separate configurations).
+     */
     public Map getChildConfigurations() {
         return Collections.unmodifiableMap(childConfigurations);
     }
@@ -191,7 +196,9 @@
     }
 
     /**
-     * Gets the configurations owned by this configuration.  This is only used for cascade-uninstall.
+     * Gets the configurations owned by this configuration.  This is only used
+     * for cascade-uninstall.
+     * 
      * @return the configurations owned by this configuration
      */
     public Set getOwnedConfigurations() {

Modified: geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationManager.java
URL: http://svn.apache.org/viewcvs/geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationManager.java?rev=396058&r1=396057&r2=396058&view=diff
==============================================================================
--- geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationManager.java (original)
+++ geronimo/branches/1.1/modules/kernel/src/java/org/apache/geronimo/kernel/config/ConfigurationManager.java Fri Apr 21 19:22:05 2006
@@ -32,7 +32,9 @@
     /**
      * Is the specified configuration installed into the server
      * environment?  That is, does it exist in the configuration store,
-     * regardless of whether it's loaded or running?
+     * regardless of whether it's loaded or running?  Note that this
+     * always returns false if the argument does not represent a
+     * configuration (e.g. if it's for a plain JAR).
      *
      * @param configurationId the configuration identifier, which must be
      *                        fully resolved (isResolved() == true)
@@ -42,7 +44,9 @@
     boolean isInstalled(Artifact configurationId);
 
     /**
-     * Is the specified configuration loaded into the kernel?
+     * Is the specified configuration loaded into the kernel?  Note that this
+     * always returns false if the argument does not represent a
+     * configuration (e.g. if it's for a plain JAR).
      *
      * @param configurationId the configuration identifier, which must be
      *                        fully resolved (isResolved() == true)
@@ -52,7 +56,9 @@
     boolean isLoaded(Artifact configurationId);
 
     /**
-     * Is the specified configuation running?
+     * Is the specified configuation running?  Note that this
+     * always returns false if the argument does not represent a
+     * configuration (e.g. if it's for a plain JAR).
      *
      * @param configurationId the configuration identifier, which must be
      *                        fully resolved (isResolved() == true)
@@ -66,6 +72,8 @@
      * missing), check whether there are any instances installed into
      * the server environment.  That is, are there any matches in the
      * configuration store, regardless of whether they're loaded or running?
+     * Note that this always returns an empty array if the argument does not
+     * represent a configuration (e.g. if it's for a plain JAR).
      *
      * @param query The partially-complete artifact name to check for
      *
@@ -76,6 +84,8 @@
     /**
      * Given an artifact that's not fully resolved (e.g. some parts are
      * missing), check whether there are any instances loaded.
+     * Note that this always returns an empty array if the argument does not
+     * represent a configuration (e.g. if it's for a plain JAR).
      *
      * @param query The partially-complete artifact name to check for
      *
@@ -86,6 +96,8 @@
     /**
      * Given an artifact that's not fully resolved (e.g. some parts are
      * missing), check whether there are any instances running.
+     * Note that this always returns an empty array if the argument does not
+     * represent a configuration (e.g. if it's for a plain JAR).
      *
      * @param query The partially-complete artifact name to check for
      *