[seam-commits] Seam SVN: r8754 - branches/Seam_2_0_FP/doc/Seam_Reference_Guide/en-US.

seam-commits at lists.jboss.org seam-commits at lists.jboss.org
Wed Aug 20 14:50:48 EDT 2008


Author: pete.muir at jboss.org
Date: 2008-08-20 14:50:48 -0400 (Wed, 20 Aug 2008)
New Revision: 8754

Modified:
   branches/Seam_2_0_FP/doc/Seam_Reference_Guide/en-US/Migration.xml
Log:
Jays changes to migration docs

Modified: branches/Seam_2_0_FP/doc/Seam_Reference_Guide/en-US/Migration.xml
===================================================================
--- branches/Seam_2_0_FP/doc/Seam_Reference_Guide/en-US/Migration.xml	2008-08-20 18:26:02 UTC (rev 8753)
+++ branches/Seam_2_0_FP/doc/Seam_Reference_Guide/en-US/Migration.xml	2008-08-20 18:50:48 UTC (rev 8754)
@@ -22,15 +22,6 @@
       details those changes.
    </para>
    
-   <tip>
-      <para>
-         Don't forget to update the XSD's in <literal>pages.xml</literal> and
-         <literal>components.xml</literal> to point at the ones for Seam 2.
-         Just change the suffix from <literal>-1.2.xml</literal> to
-         <literal>-2.0.xml</literal>.
-      </para>
-   </tip>
-   
    <section id="migrating.skeleton">
       <title>Creating a new project skeleton using seam-gen</title>
       
@@ -56,10 +47,15 @@
          into your favorite IDE, and copy your code and views across. 
       </para>
       
+      <para>
+         Continue on to <xref linkend="migrating.general"/> for details regarding
+         the changes needed to your code, and configuration files.
+      </para>
+      
    </section>
    
    <section id="migrating.insitu">
-      <title>In situ migration</title>
+      <title>In place migration</title>
       
       <para>
          This requires more work, but is suitable for more complex projects. The
@@ -72,7 +68,7 @@
          
          <warning>
             <para>
-               You only need to do this if you are migrating from the comunity
+               You only need to do this if you are migrating from the community
                edition of Seam, JBoss EAP 4.2 and 4.3 shipped a version of Seam
                1.2 which used JSF 1.2.
             </para>
@@ -109,16 +105,24 @@
          
          <para>
             In your Seam 1.2 app you may have specified some Seam specific 
-            configuration in <literal>web.xml</literal>. In Seam 2, you need
-            specify a listener (as you did in Seam 1.2):
+            configuration in <literal>web.xml</literal>.  First, we'll discuss
+            all the Seam related elements you need in 
+            <literal>web.xml</literal>, not just those that have changed, noting
+            any changes.
          </para>
          
+         <para>
+             In Seam 2, you need specify a listener (just as you did in Seam 
+             1.2):
+         </para>
+         
          <programlisting role="XML"><![CDATA[<listener>
    <listener-class>org.jboss.seam.servlet.SeamListener</listener-class>
 </listener>]]></programlisting>
 
          <para>
-            the Seam master filter (note the package of the class changed):
+            Modify the Seam master filter (note the package of the class 
+            changed):
          </para>
          
          <programlisting role="XML"><![CDATA[<filter>
@@ -138,7 +142,8 @@
          </para>
 
          <para>
-            Finally, you should have the Seam resouce servlet (as in Seam 1.2):
+            Finally, you should have the Seam resouce servlet (just as you did
+            in Seam 1.2):
          </para>
          
              <programlisting role="XML"><![CDATA[<servlet>
@@ -172,11 +177,17 @@
       
       
          <para>
-            If you are using Facelets, then you'll need to check that the 
-            default <literal>FaceletViewHandler</literal> is in use. Seam 1.2 
-            required you to use a special Facelet's 
-            <literal>ViewHandler</literal> to install it's EL enhancement whilst
-            the EL enhancement in Seam 2 is built in. Also, the version of 
+            Next, we'll describe the changes you need to make to your JSF
+            <literal>ViewHandler</literal> configuration. Previously the
+            configuration you used depended on whether you were using Seam's EL
+            enhancements or Ajax4JSF or both. In Seam 2 you should use the
+            default <literal>FaceletViewHandler</literal>.
+         </para>
+         
+         <para> 
+            Seam 1.2 required you to use a special JSF 
+            <literal>ViewHandler</literal> to install it's EL enhancement 
+            (whilst in Seam 2 the EL enhancement is built in). The version of 
             Ajax4JSF distributed with Seam 1.2 required you to specify which 
             <literal>ViewHandler</literal> to use when it was in use. Make sure
             that the Ajax4JSF configuration is removed from your 
@@ -213,7 +224,8 @@
          </para>
          
          <para>
-            To disable Seam Managed Transactions, set
+            Seam Managed Transaction are enabled by default, to disable Seam 
+            Managed Transactions, set 
             <literal>transaction-management-enabled</literal> to false:
          </para>
       
@@ -231,17 +243,19 @@
          <title>Deployment structure changes</title>
          
          <para>
-            You should place all the dependencies which you previously declared 
-            as modules in <literal>application.xml</literal> in the 
-            <literal>lib/</literal> directory of your EAR 
+            If you have an EAR application there are some deployment structure
+            changes needed. You should move all the dependencies which you 
+            previously declared as modules in <literal>application.xml</literal> 
+            in the <literal>lib/</literal> directory of your EAR 
             <emphasis>except</emphasis> <literal>jboss-seam.jar</literal> which 
             should be declared as an ejb module in 
-            <literal>application.xml</literal>.
+            <literal>application.xml</literal>. Remove the unneeded module
+            declarations from <literal>application.xml</literal>.
          </para>
          
       </section>
       
-      <section>
+      <section id="migration.embedded">
          <title>Migration to JBoss Embedded</title>
 
          <para>
@@ -294,8 +308,17 @@
    </section>
    
    <section id="migrating.general">
-      <title>Component changes</title>
+      <title>Updating your code</title>
       
+      <tip>
+         <para>
+            Don't forget to update the XSD's in <literal>pages.xml</literal> and
+            <literal>components.xml</literal> to point at the ones for Seam 2.
+            Just change the suffix from <literal>-1.2.xml</literal> to
+            <literal>-2.0.xml</literal>.
+         </para>
+      </tip>
+      
       <section>
          <title>Built-in Component changes</title>
          
@@ -1123,21 +1146,37 @@
             </listitem>
             <listitem>
                <para>
-                  @RequestParameter is located in
+                  The annotation to inject a request parameter is located in
                   <literal>org.jboss.seam.annotations.web</literal>
                </para>
+               <itemizedlist>
+                  <listitem>
+                     <para>
+                        <literal>@RequestParameter</literal>
+                     </para>
+                  </listitem>
+                </itemizedlist> 
             </listitem>
             <listitem>
                <para>
-                  @WebRemote are located in
+                  The annotation required to make a method accessible via 
+                  remoting is located in 
                   <literal>org.jboss.seam.annotations.remoting</literal>
                </para>
             </listitem>
             <listitem>
                <para>
-                  @Restrict are located in
+                  The annotation to apply a security restriction to the 
+                  component is located in
                   <literal>org.jboss.seam.annotations.security</literal>
                </para>
+               <itemizedlist>
+                  <listitem>
+                     <para>
+                        <literal>@Restrict</literal>
+                     </para>
+                  </listitem>
+                </itemizedlist> 
             </listitem>
             <listitem>
                <para>
@@ -1194,7 +1233,7 @@
          </para>
          
          <para>
-            The resouce bundle loader has been split out of the resouce bundle,
+            The resource bundle loader has been split out of the resource bundle,
             so you should replace 
             <literal>&lt;core:resource-bundle/&gt;</literal> with 
             <literal>&lt;core:resource-loader/&gt;</literal>. 




More information about the seam-commits mailing list