[jboss-cvs] JBossAS SVN: r84501 - in projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss: deployers/spi/management/deploy and 1 other directories.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Fri Feb 20 05:05:51 EST 2009


Author: emuckenhuber
Date: 2009-02-20 05:05:51 -0500 (Fri, 20 Feb 2009)
New Revision: 84501

Modified:
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentStatus.java
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java
   projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java
Log:
javadoc update

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/ManagementView.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -21,50 +21,51 @@
  */
 package org.jboss.deployers.spi.management;
 
-import java.net.URL;
 import java.util.Set;
 
-import org.jboss.deployers.spi.management.deploy.DeploymentProgress;
 import org.jboss.managed.api.ComponentType;
 import org.jboss.managed.api.DeploymentTemplateInfo;
 import org.jboss.managed.api.ManagedComponent;
 import org.jboss.managed.api.ManagedDeployment;
-import org.jboss.managed.api.ManagedDeployment.DeploymentPhase;
 import org.jboss.profileservice.spi.NoSuchDeploymentException;
-import org.jboss.profileservice.spi.NoSuchProfileException;
-import org.jboss.profileservice.spi.ProfileKey;
 
 /**
  * The management view plugin spi for querying profiles for the
  * deployemnt management object interface roots.
  * 
  * @author Scott.Stark at jboss.org
+ * @author <a href="mailto:emuckenh at redhat.com">Emanuel Muckenhuber</a>
  * @version $Revision$
  */
 public interface ManagementView
 {
    /**
-    * Load and associate the given profile with the ManagementView
-    * for future operations. This must be called before the other ManagementView
-    * operations may be used. Currently there can only be one actively loaded
-    * profile against which a client is performing management operations.
-    * 
-    * @param key - the profile key to load
-    * @throws NoSuchProfileException
+    * Load all active profiles in the ManagementView for future operations.  
+    * This must be called before the other ManagementView operations may be used.
     */
-   public void loadProfile(ProfileKey key)
-      throws Exception;
+   public void load();
 
    /**
-    * Get the names of the deployment in the profile.
+    * Reload the current profiles managed deployments/objects.
+    */
+   public void reload();
+   
+   /**
+    * Release the ManagementView.
+    *
+    */
+   public void release();
+
+   /**
+    * Get the names of all deployments.
     * 
-    * @return the names
+    * @return the deployment names
     */
    public Set<String> getDeploymentNames();
 
    /**
-    * Get the names of the deployment in the profile that have the
-    * given deployment type.
+    * Get the names of the deployment that have the given deployment type.
+    * 
     * @param type - the deployment type
     * @return the names
     */
@@ -72,14 +73,17 @@
 
    /**
     * Search for all deployment names with a name matching the regex expression.
+    * 
     * @param regex - the regex to query deployment name 
     * @return the deployment name.
     * @throws NoSuchDeploymentException if no matches are found 
     */
    public Set<String> getMatchingDeploymentName(String regex)
       throws NoSuchDeploymentException;
+   
    /**
     * Search for all deployments matched by the matcher.
+    * 
     * @param name - the name to input to the matcher
     * @param matcher - the matcher 
     * @return a possibly empty set of ManagedDeployment accepted by the matcher
@@ -94,12 +98,10 @@
     * @param name the name
     * @return the deployment
     * @throws NoSuchDeploymentException if no matches are found 
-    * @throws Exception for any error
     */
    public ManagedDeployment getDeployment(String name)
-      throws NoSuchDeploymentException, Exception;
+      throws NoSuchDeploymentException;
 
-
    /**
     * Get the deployments of a type.
     * @param type - the deployment or module type.
@@ -148,12 +150,12 @@
     * the component ManagedProperty set to matching the deployment ManagedObject
     * properties.
     * 
-    * @param comp
+    * @param comp the managed component
     * @throws Exception
     */
    public void updateComponent(ManagedComponent comp)
       throws Exception;
-
+   
    /**
     * Get the registered DeploymentTemplate names.
     * 
@@ -178,29 +180,14 @@
     * @param info
     * @throws Exception
     */
-   public void applyTemplate( String deploymentBaseName, DeploymentTemplateInfo info)
+   public void applyTemplate(String deploymentBaseName, DeploymentTemplateInfo info)
     throws Exception;
 
    /**
-    * Remove a deployment
-    * 
-    * @param deploymentName the deployment name
-    * @throws NoSuchProfileException
-    * @throws NoSuchDeploymentException
-    * @throws Exception for any error
-    */
-   public void removeDeployment(String deploymentName)
-      throws NoSuchDeploymentException, Exception;
-
-   /**
     * Process the changes made to the profile.
     * 
     * @throws Exception
     */
    public void process() throws Exception;
 
-   /**
-    * Reload the current profiles managed deployments/objects.
-    */
-   public void reloadProfile() throws Exception;
 }

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentID.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -23,8 +23,6 @@
 
 import java.net.URL;
 
-import org.jboss.managed.api.ManagedDeployment.DeploymentPhase;
-
 /**
  * A representation of a top-level deployment id.
  * 

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentManager.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -56,16 +56,6 @@
    public void releaseProfile(ProfileKey key, boolean allowHotDeployments) throws Exception;
 
    /**
-    * Add raw deployment content to the profile.
-    * 
-    * @param name the deployment name
-    * @param contentURL - URL for obtaining the deployment archive
-    * @param copyContent should we copy content or just reference it
-    * @return a DeploymentProgress used to run and track the distribute progress.
-    */
-   public DeploymentProgress distribute(String name, URL contentURL, boolean copyContent);
-
-   /**
     * Map from the external name passed to distribute to the uploaded
     * deployment repository name.
     * 
@@ -83,25 +73,45 @@
    public boolean isRedeploySupported();
    
    /**
-    * Do redeploy.
+    * Add raw deployment content to the profile.
     * 
-    * @param name the deployment to redeploy
-    * @return a DeploymentProgress used to run and track the redeploy progress.
+    * @param name the deployment name
+    * @param contentURL - URL for obtaining the deployment archive
+    * @param copyContent should we copy content or just reference it
+    * @return a DeploymentProgress used to run and track the distribute progress.
     */
-   public DeploymentProgress redeploy(String name);
+   public DeploymentProgress distribute(String name, URL contentURL, boolean copyContent);
    
    /**
+    * Prepare a set of deployments through their dependency analysis phase.
+    *
+    * @param names the unique names of the deployments
+    * @return a DeploymentProgress used to run and track the prepare progress.
+    * @throws Exception for any error
+    */
+   public DeploymentProgress prepare(String... names)
+      throws Exception;
+
+   /**
     * Start a previously distributed deployment. 
     * 
-    * @param names the unique names of the deployments within the phase to start
+    * @param names the unique names of the deployments
     * @return a DeploymentProgress used to run and track the start progress.
     */
    public DeploymentProgress start(String... names);
+
+   /**
+    * Do redeploy.
+    * 
+    * @param name the deployment to redeploy
+    * @return a DeploymentProgress used to run and track the redeploy progress.
+    */
+   public DeploymentProgress redeploy(String name);
    
    /**
     * Stop a previously started deployment.
     * 
-    * @param names the unique names of the deployments within the phase to stop
+    * @param names the unique names of the deployments
     * @return a DeploymentProgress used to run and track the stop progress.
     */
    public DeploymentProgress stop(String... names);
@@ -109,7 +119,7 @@
    /**
     * Remove a previously distributed deployment.
     * 
-    * @param names the unique names of the deployments within the phase to prepare
+    * @param names the unique names of the deployments
     * @return a DeploymentProgress used to run and track the remove progress.
     */
    public DeploymentProgress remove(String... names);

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentStatus.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentStatus.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/deployers/spi/management/deploy/DeploymentStatus.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -36,7 +36,7 @@
       UPLOADING, DEPLOYING, RUNNING, COMPLETED, FAILED, CANCELLED
    }
    public enum CommandType {
-      DISTRIBUTE, PREPARE, START, STOP, UNDEPLOY, REDEPLOY 
+      DISTRIBUTE, PREPARE, START, STOP, REMOVE, REDEPLOY 
    }
 
    /**

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/DeploymentRepository.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -36,6 +36,7 @@
  * 
  * @author Scott.Stark at jboss.org
  * @author adrian at jboss.org
+ * @author <a href="mailto:emuckenh at redhat.com">Emanuel Muckenhuber</a>
  * @version $Revision$
  */
 public interface DeploymentRepository
@@ -96,11 +97,10 @@
 
    /**
     * Upload raw deployment content to a profile repository. This does not make
-    * the deployment avaialble to
-    * @param vfsPath - the vfs path relative to the phase root
+    * the deployment available to getDeployments or getModifiedDeployments
+    * 
+    * @param vfsPath - the full vfs path of the deployment 
     * @param contentIS - the input stream for the deployment contents
-    * @param phase - the phase of the deployment as it relates to when the
-    *    deployment is loaded
     * @throws IOException
     * @return the unique name of the deployment in the repository
     */
@@ -109,8 +109,8 @@
 
    /**
     * Get the repository virtual file for the given deployment name
+    * 
     * @param name - the unique virtual file URI name as returned by addDeploymentContent
-    * @param phase - the phase of the deployment as it relates to when the deployment is loaded
     * @return the deployment content virtual file
     * @throws IOException for any error
     */
@@ -119,32 +119,31 @@
 
    /**
     * lock deployment content and exclude it from modified deployment checks.
-    * @param vfsPath - the content vfs path relative to the deployment phase root
-    * @param phase - the deployment phase
+    * 
+    * @param vfsPath - the full vfs path of the deployment
     * @return the deployment content flags, {@linkplain DeploymentContentFlags}
     */
    public int lockDeploymentContent(String vfsPath);
    /**
     * Unlock a previously locked deployment content.
-    * @param vfsPath - the content vfs path relative to the deployment phase root
-    * @param phase - the deployment phase
+    * 
+    * @param vfsPath - the full vfs path of the deployment
     * @return the deployment content flags, {@linkplain DeploymentContentFlags}
     */
    public int unlockDeploymentContent(String vfsPath);
 
    /**
     * Get the status flags for the deployment path
-    * @param vfsPath - the content vfs path relative to the deployment phase root
-    * @param phase - the deployment phase
+    * 
+    * @param vfsPath - the full vfs path of the deployment
     * @return the deployment content flags, {@linkplain DeploymentContentFlags}
     */
    public int getDeploymentContentFlags(String vfsPath);
    /**
     * Set one or more flags for the deployment.
-    * @see #clearDeploymentContentFlags(String, DeploymentPhase, int)
+    * @see #clearDeploymentContentFlags(String)
     * 
-    * @param vfsPath - the content vfs path relative to the deployment phase root
-    * @param phase - the deployment phase
+    * @param vfsPath - the full vfs path of the deployment
     * @param flags - the deployment content flags, {@linkplain DeploymentContentFlags}
     */
    public int setDeploymentContentFlags(String vfsPath, int flags);
@@ -152,16 +151,14 @@
     * Clear one or more flags for the deployment. This ands the compliment of
     * the flags argument into the existing content flags and returns the result.
     * 
-    * @param vfsPath - the content vfs path relative to the deployment phase root
-    * @param phase - the deployment phase
+    * @param vfsPath - the full vfs path of the deployment
     * @param flags - the deployment content flags, {@linkplain DeploymentContentFlags}
     */
    public int clearDeploymentContentFlags(String vfsPath, int flags);
    /**
     * Does a deployment content have the indicated flag.
     * 
-    * @param vfsPath - the content vfs path relative to the deployment phase root
-    * @param phase - the deployment phase
+    * @param vfsPath - the full vfs path of the deployment
     * @param flags - the deployment content flags, {@linkplain DeploymentContentFlags}
     * @return true if the content flags contains the flag, false otherwise.
     */
@@ -171,34 +168,30 @@
     * Add a deployment
     * 
     * @param vfsPath the path
-    * @param d the deployment
-    * @param phase - the phase of the deployment as it relates to when the
+    * @param deployment the deployment
     * deployment is loaded
     * @throws Exception for any error
     */
-   public void addDeployment(String vfsPath, ProfileDeployment d)
+   public void addDeployment(String vfsPath, ProfileDeployment deployment)
       throws Exception;
    
    /**
     * Update a deployments attachments. This persists the deployments
     * pre-determined attachments.
     * 
-    * @param vfsPath - the vfs path relative to the phase root for the deployment
-    * @param phase - the deployment phase
+    * @param deployment - the deployment
     * @param comp - the ManagedComponent that has been modified
     * @throws Exception
     */
-   public void updateDeployment(ProfileDeployment d, ManagedComponent comp)
+   public void updateDeployment(ProfileDeployment deployment, ManagedComponent comp)
       throws Exception;
 
    /**
     * Get a named deployment.
     * 
     * @param name - the deployment name
-    * @param phase - the phase of the deployment as it relates to when the
-    * deployment is loaded
-    * @return the named bootstrap
-    * @throws NoSuchDeploymentException - if there is no such bootstrap
+    * @return the deployment
+    * @throws NoSuchDeploymentException - if there is no such deployment
     */
    public ProfileDeployment getDeployment(String name)
       throws NoSuchDeploymentException;
@@ -206,9 +199,7 @@
    /**
     * Remove a deployment
     * 
-    * @param vfsPath - the vfs path
-    * @param phase - the phase of the deployment as it relates to when the
-    * deployment is loaded
+    * @param vfsPath - the full vfs path of the deployment
     * @return the removed deployment
     * @throws Exception for any error
     */

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ModificationInfo.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -37,6 +37,7 @@
    private final static long serialVersionUID = 1;
 
    public enum ModifyStatus {ADDED, MODIFIED, REMOVED};
+   
    private ProfileDeployment deployment;
    private long lastModified;
    private ModifyStatus status;

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/Profile.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -75,7 +75,6 @@
     * Add a deployment
     * 
     * @param d the deployment
-    * @param phase - the phase of the deployment as it relates to when the
     * deployment is loaded
     * @throws Exception for any error
     */
@@ -85,8 +84,6 @@
     * Remove a deployment
     * 
     * @param name the deployment name
-    * @param phase - the phase of the deployment as it relates to when the
-    * deployment is loaded
     * @return the DeploymentContext for the name if found
     * @throws Exception for any error
     */
@@ -96,8 +93,6 @@
     * Get a named deployment.
     * 
     * @param name - the deployment name
-    * @param phase - the phase of the deployment as it relates to when the
-    * deployment is loaded. If null, then all phases are queried.
     * @return the named bootstrap
     * @throws Exception for any error
     * @throws NoSuchDeploymentException - if there is no such bootstrap
@@ -136,7 +131,6 @@
     * Checks whether a deployment context is available in the basic profile service.
     * 
     * @param    name    the name of the deployment
-    * @param    phase   optionally a deployment phase, if null search all
     * @return   true if the deployment is found or false otherwise
     */
    boolean hasDeployment(String name);

Modified: projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java
===================================================================
--- projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java	2009-02-20 09:48:49 UTC (rev 84500)
+++ projects/integration/trunk/jboss-profileservice-spi/src/main/java/org/jboss/profileservice/spi/ProfileService.java	2009-02-20 10:05:51 UTC (rev 84501)
@@ -28,8 +28,6 @@
 
 /**
  * The entry point service for accessing/administering server profiles
- *  
- * @todo this should be broken up into different feature plugin services
  * 
  * @author Scott.Stark at jboss.org
  * @author <a href="mailto:emuckenh at redhat.com">Emanuel Muckenhuber</a>




More information about the jboss-cvs-commits mailing list