[jboss-cvs] JBossAS SVN: r107059 - projects/jboss-jca/trunk/doc/developerguide/en/modules.

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

Author: jesper.pedersen
Date: 2010-07-23 13:33:57 -0400 (Fri, 23 Jul 2010)
New Revision: 107059

Modified:
   projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml
   projects/jboss-jca/trunk/doc/developerguide/en/modules/issuetracking.xml
   projects/jboss-jca/trunk/doc/developerguide/en/modules/standalone.xml
Log:
Developer guide updates

Modified: projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml	2010-07-23 17:07:36 UTC (rev 107058)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml	2010-07-23 17:33:57 UTC (rev 107059)
@@ -2,9 +2,93 @@
 <chapter id="deployers">
   <title>Deployers</title>
 
+  <para>The deployer chains for the project is located in the <code>deployers</code> module.</para>
+
   <section id="rardeployer">
     <title>RAR Deployer</title>
 
+    <para>The responsibility of the RAR deployer is to deploy a resource adapter archive (.RAR) file.</para>
+
+    <section id="rardeployer_fungal">
+      <title>Fungal</title>
+
+      <para>The Fungal kernel features a simple deployment framework, so only two classes are needed for the
+        deployer chain.</para>
+
+      <para>The classes are located in the</para>
+
+      <programlisting>
+deployers/src/main/java/org/jboss/jca/deployers/fungal
+      </programlisting>
+
+      <para>directory.</para>
+
+      <section id="rardeployer_fungal_radeployer">
+        <title>RADeployer</title>
+
+        <para>This class represent a resource adapter deployer and implements the</para>
+
+        <programlisting>
+com.github.fungal.spi.deployers.Deployer
+        </programlisting>
+
+        <para>interface.</para>
+
+        <para>The responsible of the class is to</para>
+
+        <itemizedlist>
+          <listitem>
+            Create a classloader for the deployment
+          </listitem>
+          <listitem>
+            Retrieve metadata and annotations such that they can be merged
+          </listitem>
+          <listitem>
+            Perform archive validation using the JCA validator
+          </listitem>
+          <listitem>
+            Perform bean validation
+          </listitem>
+          <listitem>
+            Identify and activate the resource adapter objects
+          </listitem>
+          <listitem>
+            Bind connection factories and admin objects into JNDI
+          </listitem>
+        </itemizedlist>
+
+      
+      </section>
+
+      <section id="rardeployer_fungal_radeployment">
+        <title>RADeployment</title>
+      
+        <para>This class represent a resource adapter deployment and implements the</para>
+
+        <programlisting>
+com.github.fungal.spi.deployers.Deployment
+        </programlisting>
+
+        <para>interface.</para>
+
+        <para>The responsible of the class is to</para>
+
+        <itemizedlist>
+          <listitem>
+            Unbind connection factories and admin objects in JNDI
+          </listitem>
+          <listitem>
+            Close the classloader
+          </listitem>
+          <listitem>
+            Clean up any temporary files
+          </listitem>
+        </itemizedlist>
+
+      </section>
+
+    </section>
+
   </section>
 
   <section id="dsdeployer">

Modified: projects/jboss-jca/trunk/doc/developerguide/en/modules/issuetracking.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/issuetracking.xml	2010-07-23 17:07:36 UTC (rev 107058)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/issuetracking.xml	2010-07-23 17:33:57 UTC (rev 107059)
@@ -47,7 +47,7 @@
           </row>
           <row>
             <entry>Fungal</entry>
-            <entry>The JCA/Fungal kernel.</entry>
+            <entry>The Fungal kernel (Deprecated).</entry>
           </row>
           <row>
             <entry>JDBC</entry>
@@ -58,6 +58,10 @@
             <entry>A generic JMS resource adapter.</entry>
           </row>
           <row>
+            <entry>Performance</entry>
+            <entry>Performance related work.</entry>
+          </row>
+          <row>
             <entry>Timer</entry>
             <entry>A timer resource adapter.</entry>
           </row>
@@ -99,7 +103,7 @@
             <entry>Issue which holds informations about a release.</entry>
           </row>
           <row>
-            <entry>Thirdparty Change</entry>
+            <entry>Component Update</entry>
             <entry>Identifies a thirdparty library dependency.</entry>
           </row>
         </tbody>
@@ -149,7 +153,7 @@
       </tgroup>
     </table>
 
-    <para>Note: Thirdparty issues can't be resolved nor closed during a development cycle. These are resolved
+    <para>Note: 'Component Update' issues can't be resolved nor closed during a development cycle. These are resolved
       and closed as part of the release procedure of the project. The reason for this is that the library in
       question can receive further updates during the active development cycle.</para>
   </section>

Modified: projects/jboss-jca/trunk/doc/developerguide/en/modules/standalone.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/standalone.xml	2010-07-23 17:07:36 UTC (rev 107058)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/standalone.xml	2010-07-23 17:33:57 UTC (rev 107059)
@@ -24,6 +24,10 @@
         <para>contains the user deployments.</para>
       </listitem>
       <listitem>
+        <code>$IRON_JACAMAR_HOME/doc/</code>
+        <para>contains the documentation.</para>
+      </listitem>
+      <listitem>
         <code>$IRON_JACAMAR_HOME/lib/</code>
         <para>contains all the libraries used by the container.</para>
       </listitem>
@@ -32,6 +36,10 @@
         <para>contains the log files.</para>
       </listitem>
       <listitem>
+        <code>$IRON_JACAMAR_HOME/system/</code>
+        <para>contains system deployments files.</para>
+      </listitem>
+      <listitem>
         <code>$IRON_JACAMAR_HOME/tmp/</code>
         <para>contains temporary files.</para>
       </listitem>