[jboss-cvs] JBossAS SVN: r103746 - in trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers: pojo and 1 other directory.

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

Author: jmesnil
Date: 2010-04-09 05:30:42 -0400 (Fri, 09 Apr 2010)
New Revision: 103746

Modified:
   trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQConfigParserDeployer.java
   trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQCoreConfigRealDeployer.java
   trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSParserDeployer.java
   trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSRealDeployer.java
   trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/pojo/HornetQCoreDeployment.java
Log:
hornetq-int: added javadoc to deployers

Modified: trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQConfigParserDeployer.java
===================================================================
--- trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQConfigParserDeployer.java	2010-04-09 09:23:10 UTC (rev 103745)
+++ trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQConfigParserDeployer.java	2010-04-09 09:30:42 UTC (rev 103746)
@@ -31,14 +31,14 @@
 import org.jboss.vfs.VirtualFile;
 
 /**
- * This Deployer will take a hornetq-configuration.xml parse the Configuration
- * and attach the Configuration output into the deployment unit. Another
- * deployer that takes Configuration as an input will then take over and install
- * the queues at the proper places.
+ * This Deployer will take either {@code hornetq-configuration.xml} or {@code horneq-queues.xml}, parse it, create a Configuration object,
+ * and attach the Configuration output into the deployment unit.
  * 
- * @see HornetQJMSRealDeployer
+ * Another deployer, {@code HornetQCoreConfigRealDeployer}, which takes Configuration as an input will then take over and deploy the resources.
+
+ * @see HornetQCoreConfigRealDeployer
  * 
- * @author <mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
+ * @author <a href="mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
  * 
  */
 public class HornetQConfigParserDeployer extends AbstractVFSParsingDeployer<Configuration>

Modified: trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQCoreConfigRealDeployer.java
===================================================================
--- trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQCoreConfigRealDeployer.java	2010-04-09 09:23:10 UTC (rev 103745)
+++ trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQCoreConfigRealDeployer.java	2010-04-09 09:30:42 UTC (rev 103746)
@@ -34,15 +34,22 @@
 import org.jboss.metadata.ejb.jboss.JBossMetaData;
 
 /**
- * In a regular flow HornetQCoreParserDeployer will parer hornetq-configuration.xml or hornetq-queues.xml and it
- * will jump-start the deployment for Configuration.class. This deployer will
- * then be called directly by the VFS Deployment Framework, as the Input object
+ * This deployer is called directly by the VFS Deployment Framework, as the Input object
  * for this is a Configuration class.
  * 
- * In an alternate flow, other deployers (e.g. TorqueBox) may install a Configuration object
- * directly and this deployer will take over without the need of a real XML file
+ * In regular flow, {@code HornetQConfigParserDeployer} will have parse HornetQ XML configuration files and created {@code Configuration} outputs.
+ * <br>
+ * In an alternate flow, other deployers (e.g. TorqueBox) may instantiate a Configuration object directly and this deployer will take over after.
+ * <p>
+ * The <strong>only resources deployed by this deployer</strong> are:
+ * <ul>
+ *   <li>core queues ({@link Configuration#getQueueConfigurations()}</li> 
+ *   <li>address settings ({@link Configuration#getAddressesSettings()}</li> 
+ *   <li>security roles ({@link Configuration#getSecurityRoles()}</li> 
+ * </ul>
+ * Other attributes of the Configuration are not deployed by these deployers.
  * 
- * @author <mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
+ * @author <a href="mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
  * 
  */
 public class HornetQCoreConfigRealDeployer extends AbstractSimpleRealDeployer<Configuration>
@@ -59,6 +66,9 @@
         addInput(JBossMetaData.class);
     }
 
+    /** 
+     * Actual deployment to HornetQ is done in {@link HornetQCoreDeployment#start()}
+     */
     @Override
     public void deploy(DeploymentUnit unit, Configuration config) throws DeploymentException
     {

Modified: trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSParserDeployer.java
===================================================================
--- trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSParserDeployer.java	2010-04-09 09:23:10 UTC (rev 103745)
+++ trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSParserDeployer.java	2010-04-09 09:30:42 UTC (rev 103746)
@@ -33,16 +33,15 @@
 
 
 /**
- * This Deployer will take a hornetq-jms.xml parse the JMSConfiguration and
- * attach the JMSConfiguration output into the deployment unit. Another deployer
- * that takes JMSConfiguration as an input will then take over and install the
- * queues at the proper places.
+ * This deployer will take a {@code hornetq-jms.xml} configuration file, parse it, create a {@code JMSConfiguration} object and
+ * attach it to the deployment unit.
  * 
- * This is done through the VFS Deployment Framework. Othe projects may choose to deploy a HornetQ JMSConfiguration directly.
+ * Another deployer, {@code HornetQJMSRealDeployer}, which takes JMSConfiguration as an input will then take over and deploy the
+ * JMS resources.
  * 
  * @see HornetQJMSRealDeployer
  * 
- * @author <mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
+ * @author <a href="mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
  * 
  */
 public class HornetQJMSParserDeployer extends AbstractVFSParsingDeployer<JMSConfiguration>

Modified: trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSRealDeployer.java
===================================================================
--- trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSRealDeployer.java	2010-04-09 09:23:10 UTC (rev 103745)
+++ trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/HornetQJMSRealDeployer.java	2010-04-09 09:30:42 UTC (rev 103746)
@@ -30,17 +30,13 @@
 import org.jboss.metadata.ejb.jboss.JBossMetaData;
 
 /**
- * In a regular flow HornetQJMSParserDeployer will parer hornetq-jms.xml and it
- * will jump-start the deployment for JMSConfiguration.class. This deployer will
- * then be called directly by the VFS Deployment Framework, as the Input object
- * for this is a JMSConfiguration class.
+ * This deployer is called directly by the VFS Deployment Framework, as the Input object for this is a JMSConfiguration class.
  * 
- * In an alternate flow, other deployers (e.g. TorqueBox) may install a
- * JMSConfiguration object directly and this deployer will take over without the
- * need of a real XML file
+ * In regular flow, {@code HornetQJMSParserDeployerr} will have parse hornetq-jms.xml configuration files and created {@code JMSConfiguration} outputs.
+ * <br>
+ * In an alternate flow, other deployers (e.g. TorqueBox) may instantiate a JMSConfiguration object directly and this deployer will take over after.
  * 
- * @author <mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
- * 
+ * @author <a href="mailto:clebert.suconic at jboss.org">Clebert Suconic</a>
  */
 public class HornetQJMSRealDeployer extends AbstractSimpleRealDeployer<JMSConfiguration>
 {

Modified: trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/pojo/HornetQCoreDeployment.java
===================================================================
--- trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/pojo/HornetQCoreDeployment.java	2010-04-09 09:23:10 UTC (rev 103745)
+++ trunk/hornetq-int/src/main/java/org/jboss/as/integration/hornetq/deployers/pojo/HornetQCoreDeployment.java	2010-04-09 09:30:42 UTC (rev 103746)
@@ -83,6 +83,17 @@
       return name;
    }
 
+   /**
+    * AS6 deployers will deploy HornetQ Core resources from hornetq-configuration and hornetq-queues.xml files.
+    * The deployed resources are:
+    * <ul>
+    *   <li>core queues ({@link Configuration#getQueueConfigurations()}</li> 
+    *   <li>address settings ({@link Configuration#getAddressesSettings()}</li> 
+    *   <li>security roles ({@link Configuration#getSecurityRoles()}</li> 
+    * </ul>
+    * Other attributes of the Configuration are not deployed by these deployers.
+    * 
+    */
    @Start
    public void start()
    {