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

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

Author: scott.stark at jboss.org
Date: 2006-10-14 20:28:45 -0400 (Sat, 14 Oct 2006)
New Revision: 57675

Modified:
   trunk/server/src/main/org/jboss/deployment/JBossWebAppParsingDeployer.java
   trunk/server/src/main/org/jboss/deployment/WebAppParsingDeployer.java
Log:
Update javadoc

Modified: trunk/server/src/main/org/jboss/deployment/JBossWebAppParsingDeployer.java
===================================================================
--- trunk/server/src/main/org/jboss/deployment/JBossWebAppParsingDeployer.java	2006-10-15 00:03:21 UTC (rev 57674)
+++ trunk/server/src/main/org/jboss/deployment/JBossWebAppParsingDeployer.java	2006-10-15 00:28:45 UTC (rev 57675)
@@ -25,7 +25,6 @@
 import org.jboss.deployers.spi.DeploymentException;
 import org.jboss.deployers.spi.deployer.DeploymentUnit;
 import org.jboss.metadata.WebMetaData;
-import org.jboss.virtual.VirtualFile;
 import org.jboss.metadata.web.JBossWebMetaDataObjectFactory;
 import org.jboss.xb.binding.ObjectModelFactory;
 
@@ -45,15 +44,33 @@
       super(WebMetaData.class);
    }
 
+   /**
+    * Get the virtual file path for the jboss-web descriptor in the
+    * DeploymentContext.getMetaDataPath.
+    * 
+    * @return the current virtual file path for the web-app descriptor
+    */
    public String getWebXmlPath()
    {
       return webXmlPath;
    }
+   /**
+    * Set the virtual file path for the jboss-web descriptor in the
+    * DeploymentContext.getMetaDataLocation. The standard path is jboss-web.xml
+    * to be found in the WEB-INF metdata path.
+    * 
+    * @param webXmlPath - new virtual file path for the web-app descriptor
+    */
    public void setWebXmlPath(String webXmlPath)
    {
       this.webXmlPath = webXmlPath;
    }
 
+   /**
+    * Overriden to indicate we expect to run the parse even if an existing
+    * WebMetaData attachment is found.
+    * @return true.
+    */
    @Override
    protected boolean allowsReparse()
    {
@@ -62,6 +79,7 @@
 
    /**
     * Overriden to order this deployer after the WebAppParsingDeployer
+    * @return PARSER_DEPLOYER+1
     */
    @Override
    public int getRelativeOrder()
@@ -69,26 +87,19 @@
       return PARSER_DEPLOYER+1;
    }
 
-   @Override
-   protected void init(DeploymentUnit unit, WebMetaData metaData, VirtualFile file)
-      throws Exception
-   {
-      log.debug("init, metaData: "+metaData);
-      super.init(unit, metaData, file);
-   }
-
    /**
-    * @return JBossWebMetaDataObjectFactory
+    * Return JBossWebMetaDataObjectFactory as our ObjectModelFactory.
+    * @return a new JBossWebMetaDataObjectFactory instance
     */
    @Override
    protected ObjectModelFactory getObjectModelFactory(WebMetaData root)
    {
-      log.debug("getObjectModelFactory");
       return new JBossWebMetaDataObjectFactory(root);
    }
 
    /**
-    * 
+    * Overriden to invoke createMetaData(unit, webXmlPath, null) to parse any
+    * webXmlPath descriptor into a WebMetaData instance.
     */
    @Override
    public void deploy(DeploymentUnit unit) throws DeploymentException

Modified: trunk/server/src/main/org/jboss/deployment/WebAppParsingDeployer.java
===================================================================
--- trunk/server/src/main/org/jboss/deployment/WebAppParsingDeployer.java	2006-10-15 00:03:21 UTC (rev 57674)
+++ trunk/server/src/main/org/jboss/deployment/WebAppParsingDeployer.java	2006-10-15 00:28:45 UTC (rev 57675)
@@ -25,7 +25,6 @@
 import org.jboss.deployers.spi.DeploymentException;
 import org.jboss.deployers.spi.deployer.DeploymentUnit;
 import org.jboss.metadata.WebMetaData;
-import org.jboss.virtual.VirtualFile;
 import org.jboss.metadata.web.WebMetaDataObjectFactory;
 import org.jboss.xb.binding.ObjectModelFactory;
 
@@ -38,6 +37,7 @@
  */
 public class WebAppParsingDeployer extends ObjectModelFactoryDeployer<WebMetaData>
 {
+   /** The name of the web-app descriptor in the deployment context metadata path */
    private String webXmlPath = "web.xml";
 
    public WebAppParsingDeployer()
@@ -45,30 +45,41 @@
       super(WebMetaData.class);
    }
 
+   /**
+    * Get the virtual file path for the web-app descriptor in the
+    * DeploymentContext.getMetaDataPath.
+    * 
+    * @return the current virtual file path for the web-app descriptor
+    */
    public String getWebXmlPath()
    {
       return webXmlPath;
    }
+   /**
+    * Set the virtual file path for the web-app descriptor in the
+    * DeploymentContext.getMetaDataLocation. The standard path is web.xml
+    * to be found in the WEB-INF metdata path.
+    * 
+    * @param webXmlPath - new virtual file path for the web-app descriptor
+    */
    public void setWebXmlPath(String webXmlPath)
    {
       this.webXmlPath = webXmlPath;
    }
 
+   /**
+    * Return WebMetaDataObjectFactory as our ObjectModelFactory.
+    * @return a new WebMetaDataObjectFactory instance
+    */
    @Override
-   protected void init(DeploymentUnit unit, WebMetaData metaData, VirtualFile file) throws Exception
-   {
-      // TODO Auto-generated method stub
-      super.init(unit, metaData, file);
-   }
-
-   @Override
    protected ObjectModelFactory getObjectModelFactory(WebMetaData root)
    {
       return new WebMetaDataObjectFactory();
    }
 
    /**
-    * 
+    * Overriden to invoke createMetaData(unit, webXmlPath, null) to parse any
+    * webXmlPath descriptor into a WebMetaData instance.
     */
    @Override
    public void deploy(DeploymentUnit unit) throws DeploymentException