3.2. Setting up a new project

Procedure 3.1. Create a Seam project with seam-gen

1. Configure seam-gen for your environment by typing the following in your command line interface:

   cd seam_distribution_dir; ./seam setup

   The following output will be displayed:

   Buildfile: build.xml
   
   init:
   
   setup:
   
       [echo] Welcome to seam-gen 2.2.2.EAP5 :-)
   
       [echo] Answer each question or hit ENTER to accept the default (in brackets)
   
       [echo]

   You will then receive the following prompts for required information:

   1. [input] Enter the directory where you want the project to be created (should not contain spaces) [/home/<username>/projects] [/home/<username>/projects]

      Pressing Enter will accept the shown default (/home/<username>/projects).
      Alternatively you can enter a different value.

   2. [input] Enter your JBoss AS home directory [/var/lib/jbossas] [/var/lib/jbossas]

      Again, press Enter to accept the default or enter a new value:

      /home/<username>/path/to/jboss-as

   3. [input] Enter your JBoss AS domain [default] [default]

      If you use a custom domain, enter it here.

   4. [input] Enter the project name [myproject] [myproject]

      Enter the name of your project. Not entering a name will default to naming your project myproject.
      For this example, the project will be called helloworld.

      [echo] Accepted project name as: helloworld

   5. [input] Select a RichFaces skin [glassX] (blueSky, classic, darkX, deepMarine, DEFAULT, emeraldTown, [glassX], japanCherry, laguna, ruby, wine)

      You can choose a skin for your project from the list presented. You can see that glassX is the default.

   6. [input] Is this project deployed as an EAR (with EJB components) or a WAR (with no EJB support)? [war] (ear, [war])

      Enter the appropriate archive format.
      EAR projects support Enterprise JavaBeans 3.0 (EJB3) and require Java EE 5. WAR projects do not support EJB3, but can be deployed to a J2EE environment, and their packaging is simpler.
      If you have an EJB3-ready application server like JBoss installed, choose ear. Otherwise, choose war. This tutorial assumes you are using an EAR deployment, but you can follow these steps even if your project is WAR-deployed.

   7. [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.action] [com.mydomain.helloworld.action]
      
      [input] Enter the Java package name for your entity beans [com.mydomain.helloworld.model] [com.mydomain.helloworld.model]
      
      [input] Enter the Java package name for your test cases [com.mydomain.helloworld.test] [com.mydomain.helloworld.test]
      

      You will be prompted to nominate the package names for your Java classes, session beans, entity beans and test cases.

   8. [input] What kind of database are you using? [hsql] ([hsql], mysql, derby, oracle, postgres, mssql, db2, sybase, enterprisedb, h2)

      Nominate your database, mysql, for example. The default is hsql.

   9. [input] Enter the filesystem path to the JDBC driver jar [] []

      Enter the path to your system's JDBC driver; /usr/share/java/mysql.jar for example.
      You may see the following output:

      [input] skipping input as property driver.license.jar.new has already been set.

   10. [input] Enter the Hibernate dialect for your database [org.hibernate.dialect.MySQLDialect] [org.hibernate.dialect.MySQLDialect]

       Nominate the appropriate Hibernate dialect.

   11. [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 driver class for your database [com.mysql.jdbc.Driver] [com.mysql.jdbc.Driver]
       

       You will be prompted to nominate the JDBC classes for your instance.

   12. [input] Enter the JDBC URL for your database [jdbc:mysql:///test] [jdbc:mysql:///test]

       The default URL will differ based on your response to the earlier database question.

   13. [input] Enter the database username [sa] [sa]

       Nominate the username for access to the database, for example root.

   14. [input] Enter the database password [] []

       Set the password for the above username.
       You may see the following message:

       [input] skipping input as property hibernate.default_schema.entered has already been set.

   15. [input] Enter the database schema name (Enter '-' to clear previous value) [] []
       
       [input] Enter the database catalog name (Enter '-' to clear previous value) [] []

       Name the database schema and catalogue as prompted.

   16. [input] Are you working with tables that already exist in the database? [n] (y, [n])

       If you are working with an existing data model, make sure to tell seam-gen that tables already exist in the database.

   17. [input] Do you want to recreate the database tables and execute import.sql each time you deploy? [n] (y, [n])

       Again, answer as appropriate.
   18. You will see the following output. Some details will differ in your instance, based on answers you provided to the above questions:

       [propertyfile] Creating new property file: /home/path/to/jboss-as/seam/seam-gen/build.properties
       
           [echo] Installing JDBC driver jar to JBoss AS
       
           [copy] Copying 1 file to /home/path/to/jboss-as/server/default/lib
       
       init:
       
       init-properties:
       
           [echo] /home/path/to/jboss-as/
       
       validate-workspace:
       
       validate-project:
       
       settings:
       
           [echo] JBoss AS home: /home/path/to/jboss-as/
       
           [echo] Project name: helloworld
       
           [echo] Project location: /home/path/to/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
           
       BUILD SUCCESSFUL
       Total time: 2 minutes 14 seconds
       

       The time shown in this example is non-indicative of the actual time it will take to complete this task.
2. Create a new project in our Eclipse workspace directory by entering one of the following commands:

   ./seam create-project

   Or

   ./seam new-project

   You will see the following output:

   Buildfile: build.xml 
   ... 
   new-project: 
     [echo] A new Seam project named 'helloworld' was created in the C:\Projects directory 
     [echo] Type 'seam explode' and go to http://localhost:8080/helloworld 
     [echo] Eclipse Users: Add the project into Eclipse using File > New > Project and select General > Project (not Java Project) 
     [echo] NetBeans Users: Open the project in NetBeans 
   BUILD SUCCESSFUL Total time: 7 seconds 
   C:\Projects\jboss-seam>
   

   This copies the Seam JARs, dependent JARs and the JDBC driver JAR 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 New → Project... → General → Project → Next, type the Project name (in this case, helloworld), and then click Finish. Do not select Java Project from the New Project wizard.