[jboss-cvs] JBossAS SVN: r64358 - trunk/server/src/main/org/jboss/deployment.

[jboss-cvs-commits at lists.jboss.org]

Author: scott.stark at jboss.org
Date: 2007-07-30 20:47:12 -0400 (Mon, 30 Jul 2007)
New Revision: 64358

Modified:
   trunk/server/src/main/org/jboss/deployment/EARContentsDeployer.java
Log:
Update the comments

Modified: trunk/server/src/main/org/jboss/deployment/EARContentsDeployer.java
===================================================================
--- trunk/server/src/main/org/jboss/deployment/EARContentsDeployer.java	2007-07-31 00:10:51 UTC (rev 64357)
+++ trunk/server/src/main/org/jboss/deployment/EARContentsDeployer.java	2007-07-31 00:47:12 UTC (rev 64358)
@@ -28,6 +28,7 @@
 import java.util.jar.Manifest;
 
 import org.jboss.deployers.spi.DeploymentException;
+import org.jboss.deployers.spi.deployer.DeploymentStage;
 import org.jboss.deployers.spi.deployer.DeploymentStages;
 import org.jboss.deployers.spi.deployer.helpers.AbstractDeployer;
 import org.jboss.deployers.structure.spi.DeploymentUnit;
@@ -53,8 +54,12 @@
    private boolean requiresEarSuffix = false;
 
    /**
-    *
-    */   
+    * Create the EARContentsDeployer and register as a DeploymentStage.PARSE
+    * stage deployer with J2eeApplicationMetaData output.
+    * 
+    * @param appParsingOrder - the AppParsingDeployer relative order
+    * used to ensure EARContentsDeployer runs after AppParsingDeployer.
+    */
    public EARContentsDeployer(int appParsingOrder)
    {
       setStage(DeploymentStages.PARSE);
@@ -84,14 +89,16 @@
          log.trace("Not a vfs deployment: " + unit.getName());
          return;
       }
-      //
+      // See if the suffix matches the .ear requirement
       if (requiresEarSuffix && unit.getSimpleName().endsWith(".ear") == false)
       {
          log.trace("Unit name does not end in .ear: " + unit.getSimpleName());
          return;
       }
       VFSDeploymentUnit vfsunit = VFSDeploymentUnit.class.cast(unit);
-      // If there is a META-INF/application.xml
+      /* If there is a META-INF/application.xml we don't process this.
+       * This is probably unnecessary?
+       */
       VirtualFile appXml = vfsunit.getMetaDataFile("application.xml");
       if( appXml != null )
       {
@@ -102,6 +109,11 @@
       deploy(vfsunit);
    }
 
+   /**
+    * Entry point for handling a VFSDeploymentUnit
+    * @param unit
+    * @throws DeploymentException
+    */
    public void deploy(VFSDeploymentUnit unit) throws DeploymentException
    {
       VirtualFile root = unit.getRoot();
@@ -109,6 +121,13 @@
       deploy(unit, root, ear);
    }
 
+   /**
+    * Process the ear VFSDeploymentUnit.
+    * 
+    * @param unit - the parent VFSDeploymentUnit for the ear
+    * @param root - the deployment VFS root
+    * @param file - the deployment ear VF
+    */
    protected void deploy(VFSDeploymentUnit unit, VirtualFile root, VirtualFile file)
    {
       try