Author: manaRH Date: 2010-09-16 09:22:48 -0400 (Thu, 16 Sep 2010) New Revision: 13760 Modified: branches/enterprise/JBPAPP_5_0/doc/Seam_Reference_Guide/en-US/Gettingstarted.xml Log: JBPAPP-5035 Modified: branches/enterprise/JBPAPP_5_0/doc/Seam_Reference_Guide/en-US/Gettingstarted.xml =================================================================== --- branches/enterprise/JBPAPP_5_0/doc/Seam_Reference_Guide/en-US/Gettingstarted.xml 2010-09-16 11:33:26 UTC (rev 13759) +++ branches/enterprise/JBPAPP_5_0/doc/Seam_Reference_Guide/en-US/Gettingstarted.xml 2010-09-16 13:22:48 UTC (rev 13760) @@ -41,65 +41,98 @@ First, configure seam-gen for your environment. Just type the following in your command line interface: </para> -<programlisting>cd &lt;seam_distribution_dir&gt; seam setup</programlisting> +<programlisting>cd &lt;seam_distribution_dir&gt;</programlisting> +<programlisting>seam setup</programlisting> <para> You will receive the following prompt for the required information: </para> <programlisting>&lt;seam_distribution_dir&gt;$ ./seam setup -Buildfile: build.xml +SEAM_HOME: /home/mnovotny/apps/jboss-eap-5.1/seam +Using seam-gen sources from: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen +Buildfile: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen/build.xml init: setup: - [echo] Welcome to seam-gen :-) - [input] Enter your project workspace (the directory that contains your Seam projects) [C:/Projects] [C:/Projects] -/Users/pmuir/workspace - [input] Enter your JBoss home directory [C:/Program Files/jboss-eap-5.0.1/jboss-as] [C:/Program Files/jboss-eap-5.0.1/jboss-as] -/var/lib/jbossas + [echo] Welcome to seam-gen 2.2.2.EAP5 :-) + [echo] Answer each question or hit ENTER to accept the default (in brackets) + [echo] + [input] Enter the directory where you want the project to be created (should not contain spaces) [/home/mnovotny/projects] [/home/mnovotny/projects] + + [input] Enter your JBoss AS home directory [/var/lib/jbossas] [/var/lib/jbossas] +/home/mnovotny/apps/jboss-eap-5.1/jboss-as + [input] Enter your JBoss AS domain [default] [default] + [input] Enter the project name [myproject] [myproject] helloworld [echo] Accepted project name as: helloworld - [input] Select a RichFaces skin (not applicable if using ICEFaces) [blueSky] ([blueSky], classic, ruby, wine, deepMarine, emeraldTown, sakura, DEFAULT) + [input] Select a RichFaces skin [glassX] (blueSky, classic, darkX, deepMarine, DEFAULT, emeraldTown, [glassX], japanCherry, laguna, ruby, wine) - [input] Is this project deployed as an EAR (with EJB components) or a WAR (with no EJB support) [ear] ([ear], war, ) + [input] Is this project deployed as an EAR (with EJB components) or a WAR (with no EJB support)? [war] (ear, [war]) +ear + [input] Enter the base package name for your Java classes [com.mydomain.helloworld] [com.mydomain.helloworld] - [input] Enter the Java package name for your session beans [com.mydomain.helloworld] [com.mydomain.helloworld] -org.jboss.helloworld - [input] Enter the Java package name for your entity beans [org.jboss.helloworld] [org.jboss.helloworld] + [input] Enter the Java package name for your session beans [com.mydomain.helloworld.action] [com.mydomain.helloworld.action] - [input] Enter the Java package name for your test cases [org.jboss.helloworld.test] [org.jboss.helloworld.test] + [input] Enter the Java package name for your entity beans [com.mydomain.helloworld.model] [com.mydomain.helloworld.model] - [input] What kind of database are you using? [hsql] ([hsql], mysql, oracle, postgres, mssql, db2, sybase, enterprisedb, h2) + [input] Enter the Java package name for your test cases [com.mydomain.helloworld.test] [com.mydomain.helloworld.test] + + [input] What kind of database are you using? [hsql] ([hsql], mysql, derby, oracle, postgres, mssql, db2, sybase, enterprisedb, h2) mysql + [input] Enter the filesystem path to the JDBC driver jar [] [] +/usr/share/java/mysql.jar + [input] skipping input as property driver.license.jar.new has already been set. [input] Enter the Hibernate dialect for your database [org.hibernate.dialect.MySQLDialect] [org.hibernate.dialect.MySQLDialect] - [input] Enter the filesystem path to the JDBC driver jar [lib/hsqldb.jar] [lib/hsqldb.jar] -/usr/share/java/mysql.jar - [input] Enter JDBC driver class for your database [com.mysql.jdbc.Driver] [com.mysql.jdbc.Driver] + [input] Enter the JDBC driver class for your database [com.mysql.jdbc.Driver] [com.mysql.jdbc.Driver] + [input] Enter the JDBC DataSource class for your database [com.mysql.jdbc.jdbc2.optional.MysqlDataSource] [com.mysql.jdbc.jdbc2.optional.MysqlDataSource] + [input] Enter the JDBC URL for your database [jdbc:mysql:///test] [jdbc:mysql:///test] -jdbc:mysql:///helloworld - [input] Enter database username [sa] [sa] -pmuir - [input] Enter database password [] [] - [input] skipping input as property hibernate.default_schema.new has already been set. - [input] Enter the database catalog name (it is OK to leave this blank) [] [] + [input] Enter the database username [sa] [sa] +root + [input] Enter the database password [] [] - [input] Are you working with tables that already exist in the database? [n] (y, [n], ) + [input] skipping input as property hibernate.default_schema.entered has already been set. + [input] Enter the database catalog name (Enter '-' to clear previous value) [] [] + + [input] Are you working with tables that already exist in the database? [n] (y, [n]) y - [input] Do you want to drop and recreate the database tables and data in import.sql each time you deploy? [n] (y, [n], ) -n - [input] Enter your ICEfaces home directory (leave blank to omit ICEfaces) [] [] + [input] Do you want to recreate the database tables and execute import.sql each time you deploy? [n] (y, [n]) -[propertyfile] Creating new property file: /Users/pmuir/workspace/jboss-seam/seam-gen/build.properties - [echo] Installing JDBC driver jar to JBoss server - [echo] Type 'seam create-project' to create the new project +[propertyfile] Creating new property file: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen/build.properties + [echo] Installing JDBC driver jar to JBoss AS + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/jboss-as/server/default/lib -BUILD SUCCESSFUL -Total time: 1 minute 32 seconds -~/workspace/jboss-seam $ +init: + +init-properties: + [echo] /home/mnovotny/apps/jboss-eap-5.1/jboss-as + +validate-workspace: + +validate-project: + +settings: + [echo] JBoss AS home: /home/mnovotny/apps/jboss-eap-5.1/jboss-as + [echo] Project name: helloworld + [echo] Project location: /home/mnovotny/projects/helloworld + [echo] Project type: ear + [echo] Action package: com.mydomain.helloworld.action + [echo] Model package: com.mydomain.helloworld.model + [echo] Test package: com.mydomain.helloworld.test + [echo] JDBC driver class: com.mysql.jdbc.Driver + [echo] JDBC DataSource class: com.mysql.jdbc.jdbc2.optional.MysqlDataSource + [echo] Hibernate dialect: org.hibernate.dialect.MySQLDialect + [echo] JDBC URL: jdbc:mysql:///test + [echo] Database username: root + [echo] Database password: + [echo] + [echo] Type './seam create-project' to create the new project + </programlisting> <para> The tool provides sensible defaults. To accept them, press <keycap>Enter</keycap> when prompted. @@ -114,19 +147,107 @@ Create a new project in our Eclipse workspace directory by typing: </para> -<programlisting>seam new-project +<programlisting>./seam create-project </programlisting> -<programlisting>&lt;seam_distribution_dir&gt; seam new-project -Buildfile: build.xml -... -new-project: - [echo] A new Seam project named &#39;helloworld&#39; was created in the C:\Projects directory - [echo] Type &#39;seam explode&#39; and go to http://localhost:8080/helloworld - [echo] Eclipse Users: Add the project into Eclipse using File &gt; New &gt; Project and select General &gt; Project (not Java Project) - [echo] NetBeans Users: Open the project in NetBeans -BUILD SUCCESSFUL Total time: 7 seconds -C:\Projects\jboss-seam&gt; +<programlisting>&lt;seam_distribution_dir&gt;$ ./seam create-project +SEAM_HOME: /home/mnovotny/apps/jboss-eap-5.1/seam +Using seam-gen sources from: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen +Buildfile: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen/build.xml + +init: + +init-properties: + [echo] /home/mnovotny/apps/jboss-eap-5.1/jboss-as + +validate-workspace: + +validate-project: + +initcopy: + +initpoms: + [echo] Setting up dependencies + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms +[artifact:install] [INFO] Installing /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms/root.pom to /home/mnovotny/.m2/repository/org/jboss/seam/root/2.2.2.EAP5/root-2.2.2.EAP5.pom + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms +[artifact:install] [INFO] Installing /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms/parent.pom to /home/mnovotny/.m2/repository/org/jboss/seam/parent/2.2.2.EAP5/parent-2.2.2.EAP5.pom + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + [copy] Copying 1 file to /home/mnovotny/apps/jboss-eap-5.1/seam/classes/poms + +copyseam: + +copyseamdependencies: + +copyjbossembedded: + +copy-lib: + [echo] Copying Seam and dependencies to the /home/mnovotny/projects/helloworld/lib directory... + [copy] Copying 120 files to /home/mnovotny/projects/helloworld/lib + [copy] Copied 4 empty directories to 1 empty directory under /home/mnovotny/projects/helloworld/lib + [echo] Copying JBoss Embedded configuration to the /home/mnovotny/projects/helloworld/bootstrap directory... + [copy] Copying 30 files to /home/mnovotny/projects/helloworld/bootstrap + +file-copy-war: + +file-copy-ear: + [echo] Copying build scripts for EAR deployment to the /home/mnovotny/projects/helloworld directory... + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [echo] Copying resources needed for EAR deployment to the /home/mnovotny/projects/helloworld/resources directory... + [copy] Copying 8 files to /home/mnovotny/projects/helloworld/resources + +setup-filters: + +file-copy: + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 3 files to /home/mnovotny/projects/helloworld/resources + [copy] Copying 11 files to /home/mnovotny/projects/helloworld/resources + [copy] Copying 4 files to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/.settings + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [copy] Copying 1 file to /home/mnovotny/projects/helloworld + [mkdir] Created dir: /home/mnovotny/projects/helloworld/nbproject + [copy] Copying 3 files to /home/mnovotny/projects/helloworld/nbproject + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/resources + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/resources + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/resources + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/resources + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/resources + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/resources + [copy] Copying 13 files to /home/mnovotny/projects/helloworld/view + [copy] Copying 16 files to /home/mnovotny/projects/helloworld/view + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/hot/com/mydomain/helloworld/action + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/hot/com/mydomain/helloworld/action + [copy] Copying 3 files to /home/mnovotny/projects/helloworld + [mkdir] Created dir: /home/mnovotny/projects/helloworld/src/main/com/mydomain/helloworld/model + [mkdir] Created dir: /home/mnovotny/projects/helloworld/src/test/com/mydomain/helloworld/test + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/test + +create-project: + [echo] A new Seam project named 'helloworld' was created in the /home/mnovotny/projects directory + [echo] Type './seam explode' and go to http://localhost:8080/helloworld + [echo] Eclipse Users: Import the project using File > Import... > Existing Projects into Workspace, set the root directory to /home/mnovotny/projects, then select the project named helloworld + [echo] NetBeans Users: Open the project using File > Open project... and select the project folder /home/mnovotny/projects/helloworld + [echo] IDEA Users: Open the project using File > Open project... and select the file /home/mnovotny/projects/helloworld/helloworld.ipr + +BUILD SUCCESSFUL +Total time: 9 seconds + </programlisting> <para> This copies the Seam <filename>JAR</filename>s, dependent <filename>JAR</filename>s and the JDBC driver <filename>JAR</filename> to a new Eclipse project. It generates all required resources and configuration files, a Facelets template file and stylesheet, along with Eclipse metadata and an Ant build script. The Eclipse project will be automatically deployed to an exploded directory structure in JBoss as soon as you add the project. To add the project, go to <guimenu>New</guimenu> &#8594; <guimenu>Project...</guimenu> &#8594; <guimenu>General</guimenu> &#8594; <guimenu>Project</guimenu> &#8594; <guimenu>Next</guimenu>, type the <guilabel>Project name</guilabel> (in this case, <literal>helloworld</literal>), and then click <literal>Finish</literal>. Do not select <literal>Java Project</literal> from the New Project wizard. @@ -160,9 +281,16 @@ Seam prompts for some information, and generates a new Facelets page and Seam component for your project. </para> -<programlisting>C:\Projects\jboss-seam&gt;seam new-action -Buildfile: build.xml +<programlisting>&lt;seam_distribution_dir&gt;$ ./seam new-action +SEAM_HOME: /home/mnovotny/apps/jboss-eap-5.1/seam +Using seam-gen sources from: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen +Buildfile: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen/build.xml +init: + +init-properties: + [echo] /home/mnovotny/apps/jboss-eap-5.1/jboss-as + validate-workspace: validate-project: @@ -170,29 +298,34 @@ action-input: [input] Enter the Seam component name ping - [input] Enter the local interface name [Ping] + [input] Enter the local interface name [Ping] [Ping] - [input] Enter the bean class name [PingBean] + [input] Enter the bean class name [PingBean] [PingBean] - [input] Enter the action method name [ping] + [input] Enter the action method name [ping] [ping] - [input] Enter the page name [ping] + [input] Enter the page name [ping] [ping] setup-filters: -new-action: +new-action-ear: [echo] Creating a new stateless session bean component with an action method - [copy] Copying 1 file to C:\Projects\helloworld\src\hot\org\jboss\helloworld - [copy] Copying 1 file to C:\Projects\helloworld\src\hot\org\jboss\helloworld - [copy] Copying 1 file to C:\Projects\helloworld\src\hot\org\jboss\helloworld\test - [copy] Copying 1 file to C:\Projects\helloworld\src\hot\org\jboss\helloworld\test - [copy] Copying 1 file to C:\Projects\helloworld\view - [echo] Type 'seam restart' and go to http://localhost:8080/helloworld/ping.seam + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/hot/com/mydomain/helloworld/action + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/hot/com/mydomain/helloworld/action + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/test/com/mydomain/helloworld/test + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/test/com/mydomain/helloworld/test + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/view + [echo] Type './seam restart' and go to http://localhost:8080/helloworld/ping.seam +new-action-war: + +insert-menu-item: + +new-action: + BUILD SUCCESSFUL -Total time: 13 seconds -C:\Projects\jboss-seam&gt; +Total time: 16 seconds </programlisting> <para> Since we have added a new Seam component, it is necessary to restart the exploded directory deployment. You can do this by typing <literal>seam restart</literal>, or by running the <literal>restart</literal> target in the generated project&#39;s <literal>build.xml</literal> file from within Eclipse. Alternatively, you can edit the <literal>resources/META-INF/application.xml</literal> file in Eclipse. @@ -219,9 +352,16 @@ <programlisting>seam new-form </programlisting> -<programlisting>C:\Projects\jboss-seam&gt;seam new-form -Buildfile: C:\Projects\jboss-seam\seam-gen\build.xml +<programlisting>&lt;seam_distribution_dir&gt;$ ./seam new-form +SEAM_HOME: /home/mnovotny/apps/jboss-eap-5.1/seam +Using seam-gen sources from: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen +Buildfile: /home/mnovotny/apps/jboss-eap-5.1/seam/seam-gen/build.xml +init: + +init-properties: + [echo] /home/mnovotny/apps/jboss-eap-5.1/jboss-as + validate-workspace: validate-project: @@ -229,29 +369,34 @@ action-input: [input] Enter the Seam component name hello - [input] Enter the local interface name [Hello] + [input] Enter the local interface name [Hello] [Hello] - [input] Enter the bean class name [HelloBean] + [input] Enter the bean class name [HelloBean] [HelloBean] - [input] Enter the action method name [hello] + [input] Enter the action method name [hello] [hello] - [input] Enter the page name [hello] + [input] Enter the page name [hello] [hello] setup-filters: -new-form: +new-form-ear: [echo] Creating a new stateful session bean component with an action method - [copy] Copying 1 file to C:\Projects\hello\src\hot\com\hello - [copy] Copying 1 file to C:\Projects\hello\src\hot\com\hello - [copy] Copying 1 file to C:\Projects\hello\src\hot\com\hello\test - [copy] Copying 1 file to C:\Projects\hello\view - [copy] Copying 1 file to C:\Projects\hello\src\hot\com\hello\test - [echo] Type 'seam restart' and go to http://localhost:8080/hello/hello.seam + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/hot/com/mydomain/helloworld/action + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/hot/com/mydomain/helloworld/action + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/test/com/mydomain/helloworld/test + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/view + [copy] Copying 1 file to /home/mnovotny/projects/helloworld/src/test/com/mydomain/helloworld/test + [echo] Type './seam restart' and go to http://localhost:8080/helloworld/hello.seam +new-form-war: + +insert-menu-item: + +new-form: + BUILD SUCCESSFUL -Total time: 5 seconds -C:\Projects\jboss-seam&gt; +Total time: 10 seconds </programlisting> <para> Restart the application again, and go to <literal>http://localhost:8080/helloworld/hello.seam</literal>. Look at the generated code. Run the test. Experiment with adding new fields to the form and Seam component. (Remember to restart the deployment each time you alter the Java code.) @@ -373,30 +518,6 @@ For WAR projects created with seam-gen, incremental hot deployment is available out of the box for classes in the <literal>src/hot</literal> source directory. However, seam-gen does not support incremental hot deployment for EAR projects. </para> </section> - <!-- - <section> - <title>Using Seam with JBoss 4.0</title> - <para> - Seam 2.0 was developed for JavaServer Faces 1.2. When using JBoss AS, we recommend using JBoss 4.2 or JBoss 5.0, both of which bundle the JSF 1.2 reference implementation. However, Seam 2.0 can still operate on the JBoss 4.0 platform. There are two steps required to do this: install an EJB3-enabled version of JBoss 4.0, and replace MyFaces with the JSF 1.2 reference implementation. Once these steps have been completed, Seam 2.0 applications can be deployed to JBoss 4.0. - </para> - <section> - <title>Install JBoss 4.0</title> - <para> - JBoss 4.0 does not ship a default configuration compatible with Seam. To run Seam, install JBoss 4.0.5 using the JEMS 1.2 installer with the EJB3 profile selected. Seam will not run with an installation that doesn&#39;t include EJB3 support. The JEMS installer can be downloaded from <ulink url="http://labs.jboss.com/jemsinstaller/downloads">http://l... jemsinstaller/downloads</ulink>. - </para> - </section> - - <section> - <title>Install the JSF 1.2 RI</title> - <para> - The web configuration for JBoss 4.0 can be found in the <filename>server/default/deploy/jbossweb-tomcat55.sar</filename>. You will need to delete <filename>myfaces-api.jar</filename> and any <filename>myfaces-impl.jar</filename> from the <filename>jsf-libs </filename>directory. Then, you will need to copy <filename>jsf-api.jar</filename>, <filename>jsf-impl.jar</filename>, <filename>el-api.jar</filename>, and <filename>el-ri.jar</filename> to that directory. The JSF JARs can be found in the Seam <filename>lib</filename> directory. The EL JARs can be obtained from the Seam 1.2 release. - </para> - <para> - You will also need to edit the <filename>conf/web.xml</filename>, replacing <filename>myfaces-impl.jar</filename> with <filename>jsf-impl.jar</filename>. - </para> - </section> - - </section>--> </chapter>