JBoss Developer Studio 4.1

Seam Developer Tools Reference Guide

Provides information relating to the Seam Developer Tools module.

Edition 4.1.0

Anatoly Fedosik

Olga Chikvina

Michael Sorokin

Svetlana Mukhina

Legal Notice

Copyright © 2011 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack Logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.


The Seam Developer Tools Reference Guide explains how to use the Seam Developer Tools module to create Seam projects for deployment.
1. Introduction
1.1. What is Seam?
1.2. Key Features of JBoss Seam
1.3. Installation into Eclipse
1.4. Other relevant resources on the topic
2. Creating a New Seam Project via the New Seam Project wizard
2.1. Create standalone Seam Web Project
2.2. Selecting the Project Facets
2.2.1. Seam project with JPA facets
2.3. Java application building configuration
2.4. How to Configure Web Module Settings
2.5. Adding JSF Capabilities
2.6. Configure Seam Facet Settings
3. Directory Structure of the Generated Project
3.1. WAR Deployment
3.2. EAR Deployment
3.3. Changing the Seam Version
3.4. Changing Seam Parent Project
3.5. Renaming the Projects and Folders
4. Seam Menus and Actions
4.1. File Menu Actions
4.2. Navigate Menu Actions
4.2.1. Find Seam References/Declarations
4.2.2. Open Seam Component
5. Seam Wizards
5.1. New Seam Action
5.2. New Seam Form
5.3. New Seam Conversation
5.4. New Seam Entity
6. Seam Generate Entities
7. Seam Editors
7.1. Visual Page Editor
7.2. Seam Pages Editor
7.2.1. Graphical Mode
7.2.2. Tree Mode
7.2.3. Outline Support for Seam Pages Editor
7.3. Seam Components Editor
7.4. Main Features of Seam Editors
7.4.1. Content Assist
7.4.2. Content Assist for Page Descriptors
7.4.3. OpenOn
7.4.4. Seam Validation
8. Seam Views
8.1. Seam Components View
8.2. Project Explorer integration
9. Seam Preferences
9.1. General Preferences
9.1.1. Validator Preferences
9.2. Project Preferences
9.3. Adding Custom Capabilities
10. Seam Refactoring Tools
10.1. Using the Refactorinig Wizard
10.2. Renaming Seam Components
10.2.1. Renaming Seam Components in the Java Editor
10.2.2. Renaming Seam Components in the Seam Components View
10.2.3. Renaming Seam Components in the Seam Components Editor
10.3. Renaming Seam Context Variables in EL
11. Adding Seam support to EAR project
12. Generate a CRUD Database Application
12.1. What is CRUD?
12.2. How to create the CRUD Database Application with Seam
13. The CRUD Application Walkthrough
13.1. Using CRUD Application
14. Using TestNG project
14.1. What is TestNG?
14.2. Other relevant resources on the topic
14.3. How to use the generated Seam-test project to run Seam tests?
15. FAQ
15.1. How to get Code Assist for Seam specific resources in an externally generated project?
15.2. How to import an example Seam project from jboss-eap directory?
15.3. How to change the deploy folders for Seam source code from src/hot and src/main?
A. Getting Help and Giving Feedback
A.1. Do You Need Help?
A.2. Give us Feedback
B. Revision History


This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the Document Conventions manual, which can be found on the Red Hat Documentation website under the JBoss Developer Studio section.

Chapter 1. Introduction

1.1. What is Seam?

This introduction will help you to understand what is Seam.
Seam is a fully featured application framework on top of Java EE 5. It is also one of the most popular enterprise Java frameworks today. Seam deeply integrates many other standard-based or open source frameworks (e.g., JSF, EJB3, JMS, Web Services, jBPM, JBoss Rules, Ajax4jsf, RichFaces, Facelets, Spring, iText, Quartz, TestNG, etc.), and provides a single programming model for developers to "drive" those underlying frameworks via simple annotated POJOs (Plain Old Java Objects). It makes life easier for developers to tackle complex enterprise applications with many component frameworks.

1.2. Key Features of JBoss Seam

For a start, we propose you to look through the table of main features of JBoss Seam:

Table 1.1. Key Functionality for JBoss Seam

Feature Benefit Chapter
Integrated JSF with EJB 3.0
JBoss Seam combines the component models of EJB3 and JSF, eliminating glue code, and thus, letting the developer think about the business problem.
Integrated AJAX
Developer can add AJAX capability to the user interface of his application without the need to write any JavaScript code as Seam supports JBoss RichFaces and ICEfaces - the best open source JSF-based AJAX solutions.
Bijection allows auto-assembly of stateful components by the container. It even allows a component to safely and easily manipulate the value of a context variable, just by assigning it to an attribute of the component.
New Seam Project wizard
An easy step-by-step wizard to create a stand alone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.
Chapter 2, Creating a New Seam Project via the New Seam Project wizard
Seam component generations options
All the Seam component generations options known from Seam-gen are available as wizards (with sensible auto-defaulting) for creating various common Seam components.
Chapter 5, Seam Wizards
Seam Editors
Visual Page Editor, Seam Pages Editor and Seam Components Editor provide you with a range of great possibilities and will be helpful when working with JBoss Seam.
Chapter 7, Seam Editors
Seam Validator
A configured Seam Validator provides validation of various possible problematic definitions.
Section 7.4.4, “Seam Validation”
CRUD Database Application Generation
JBoss Seam allows adding CRUD support to a Seam Web application.
Chapter 12, Generate a CRUD Database Application
TestNG Framework
TestNG ("Testing, the Next Generation") is a Java unit testing framework that aims to overcome many limitations of JUnit.
Chapter 14, Using TestNG project

1.3. Installation into Eclipse

Here, we are going to explain how to install Seam plugin into Eclipse.
Seam is a one module of JBoss Tools project. Since Seam has a dependence on other JBoss Tools modules we recommend you to install a bundle of all JBoss Tools plug-ins. Installation instruction you can find on JBoss Wiki in InstallingJBossTools section.

1.4. Other relevant resources on the topic

The Seam Framework - Next generation enterprise Java development.
All JBoss Developer Studio/JBoss Tools release documentation you can find at http://docs.jboss.org/tools in the corresponding release directory.
There is some extra information on JBoss Wiki.
The latest documentation builds are available at http://download.jboss.org/jbosstools/nightly-docs.
You can find a set of screencasts on how to search/find references and use Seam refactoring tools in the following Max Andersen's blog post.

Chapter 2. Creating a New Seam Project via the New Seam Project wizard

In this chapter we provide you with the necessary steps to start working with Seam Framework.
At first, we suggest to set the specific Seam perspective that combines a number of different views and editors needed for work with resources concerned. For that select WindowOpen PerspectiveOtherSeam or you can also access it through the button in the right top corner.
Seam Perspective Icon

Figure 2.1. Seam Perspective Icon

Also the Open Web Browser action is directly available in the Seam perspective.
Embedded Web Browser Button

Figure 2.2. Embedded Web Browser Button

2.1. Create standalone Seam Web Project

The best way to get started with Seam is to create a simple Seam Project and experiment with it.
Thus, you should select FileNewSeam Web Project to run the New Seam Project wizard. The wizard form allows you to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications.
Seam Web Project wizard has an option for selecting the actual Server (not just WTP runtime) that will be used for the project. This allows the wizard to identify correctly where the required datasource and driver libraries need to go.
Let's get through the wizard step-by-step. First, you should enter a name and a location directory for your new project.
New Seam Project Wizard

Figure 2.3. New Seam Project Wizard

On the figure above you can see the runtime and the server already created.
If you need to create a new runtime, click on the New... button in the Target Runtime section. It brings up the wizard where you can specify a new JBoss Server Runtime environment or the other type of runtime appropriate for your project configuration. Let's create one more JBoss 4.2 Runtime. Hence, after choosing it click on Next button.
Specifying Target Runtime

Figure 2.4. Specifying Target Runtime

All what you need here is to name runtime, type the path to its install directory or locate it by using Browse button, select a Java Runtime Environment, and select which configuration you want.
Specifying Target Runtime Configurations

Figure 2.5. Specifying Target Runtime Configurations

Clicking on Finish returns you to the Figure 2.3, “New Seam Project Wizard”.
The next step is to define a Server by clicking on New... button in the Target Server section. In appeared New Server dialog the last server which matches the runtime will be selected.
All declared runtimes are listed in the combobox under the servers view. Here, you can indicate a server runtime that you need. Click Add if you want to add a new Server Runtime.
Specifying Target Server

Figure 2.6. Specifying Target Server

Next page allows you to verify the information for a chosen server. Leave everything as it is and click on Next .
JBoss Runtime Summary

Figure 2.7. JBoss Runtime Summary

On the last wizard step you can modify your projects to configure them on the Server.
Project Modification for Configuring on the Server

Figure 2.8. Project Modification for Configuring on the Server

Once you have the Target Server defined click on Finish button to return to the first page of the New Seam Project wizard.


We suggest that you look through the Application Server Manager Guide to find out more about runtimes and servers.
Completion of Runtime and Server Configuration

Figure 2.9. Completion of Runtime and Server Configuration

The last section on this wizard step is Configuration. Here, you can select one of the predefined project configurations either associated with Seam 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by pressing the Modify... button. It will open the dialog which allows to configure your own set of facets for adding extra functionality to your project.
Pass to the next section to find out more details on this dialog.

2.2. Selecting the Project Facets

The Project Facets wizard allows you to enable or disable specific facets which define necessary features for the project. When you switch to this wizard form, all critical facets are already checked for the chosen Configuration.
Notice that this page of the wizard also allows you to set the necessary version for any facet.
Project Facets Selection

Figure 2.10. Project Facets Selection

Moreover, here you can specify your own preset of selected facets by checking needed ones in project facets window and clicking on Save button.
Specifying Custom Facet Preset

Figure 2.11. Specifying Custom Facet Preset

To see all available Server runtimes click on Runtimes tab on the left. You can create a new one using the New button. If more than one runtime is checked here, the Make Primary button won't be dimmed yet. Thus, you can make use of it to mark primary runtime.
Setting Runtime

Figure 2.12. Setting Runtime

Clicking the OT button will bring you to the Web Module wizard form again.

2.2.1. Seam project with JPA facets

For creating Seam project with JPA support you need to select Java Persistent facet on Project Facets page and click OK.
Then you should press Next and may leave the default value on Java application building page and Web Module Settings page.
After that you will see JPA facet page.
JPA Facet page

Figure 2.13. JPA Facet page

On this page you can choose Platform (vendor-specific JPA implementation) for your project, type of JPA Implementation, and configure the Connection to database in the Connection area.
More about JPA facet page you can read in Eclipse documentation.
On the next step you will see JSF Capabilities and Seam facet pages, which are mostly the same as in general Seam project.

2.3. Java application building configuration

With this wizard you can define Java source directories which will be generated on build path. Also you can specify a default output folder. If you are agree with default values, press Next
Java application building Wizard

Figure 2.14. Java application building Wizard

2.4. How to Configure Web Module Settings

As we deal with a Dynamic Web Application, we should at first specify the top level directory of our application for deploying it to a server afterwards. You know, this kind of application contains Web resources. Thus, it's important to indicate the content directory. The wizard will put all those values itself, so you can leave everything as is.
Web Module Settings

Figure 2.15. Web Module Settings

Choose Next to switch to the next wizard form.

2.5. Adding JSF Capabilities

This wizard helps you to add JSF capabilities to your project.
Choose Library provided by Target Runtime from Library Type list if you'd like to use a default JSF implementation given by the present runtime.
Adding JSF Capabilities to Web Project

Figure 2.16. Adding JSF Capabilities to Web Project

In case if you prefer to use your custom JSF implementation, choose User Library Item from Library Type list. In User Library list you can check required library.
Using Custom JSF implementation Library

Figure 2.17. Using Custom JSF implementation Library

If a new library is required, click Manage libraries... ( ) button. Then you should click New.
Using Custom JSF implementation Library

Figure 2.18. Using Custom JSF implementation Library

Here, it's necessary to type a Library Name.
Entering New User Library Name

Figure 2.19. Entering New User Library Name

To add proper Library JARs, click Add JARs... button and select the JARs on your hard drive.
Selection Library JARs

Figure 2.20. Selection Library JARs

You can download necessary JSF implementation libraries provided by Sun and Apache Foundation as well. Click Download... ( ) button and choose one of proposed libraries.
Download JSF Implementation Library

Figure 2.21. Download JSF Implementation Library

The last wizard options allows to edit a path for JSF Configuration File, a name for JSF Servlet, JSF Servlet Classname and change URL Mapping Patterns.
JSF Capabilities Wizard

Figure 2.22. JSF Capabilities Wizard

Since we are arranging the Seam Web project, the last step we should do is to adjust project configurations associated with the Seam.

2.6. Configure Seam Facet Settings

The last wizard step is related to Seam facet and allows you to do the following:
Seam Facet Settings

Figure 2.23. Seam Facet Settings

  • Create Seam runtime and define Seam home folder.
For that click on Add button in the General section. Note, in the wizard shown below you can create a Seam runtime only for the version that was selected in the Section 2.2, “Selecting the Project Facets” wizard (version 1.2 in our case).
Seam Runtime Creation

Figure 2.24. Seam Runtime Creation

  • Select EAR or WAR deployment by checking a necessary radio button.
  • Enter EJB project name and EAR project name in case of EAR radio button is checked.


If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" and "MyProject-test".
  • Select a Database Type
Database Type Selecting

Figure 2.25. Database Type Selecting

  • and then specify a Connection profile appropriate for your database.
Connection Profile Options

Figure 2.26. Connection Profile Options

You can edit chosen profile by using Edit button or organize a new one by clicking on New button and selecting necessary for you type of connection profile.
Connection Profile Selecting

Figure 2.27. Connection Profile Selecting

On the dialog you'll be asked to enter its name and description. And then you should select a proper driver and adjust connection details. Press Next to preview all the adjusted settings and complete the creation of the new profile.
Connection Details

Figure 2.28. Connection Details

The next block of settings in the Seam Facet wizard are describing a Database and a connection to it.
In the Code Generation section the wizard has already provided the names for your Session Bean, Entity Bean and Test packages generation (optional). Of course, you can change them on others of your choice.
Code Generation Section

Figure 2.29. Code Generation Section

Click on Finish to generate a project.

Chapter 3. Directory Structure of the Generated Project

In this chapter we describe where the Seam wizard puts the generated files for both EAR and WAR deployments.
The Seam Project wizard generates projects like Eclipse WTP style in order to utilize Eclipse WTP features and to have a correct classpath. To be more precise it generates one project per artifact.

3.1. WAR Deployment

The project layout for WAR projects is:
Project Layout for WAR projects

Figure 3.1. Project Layout for WAR projects

A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use EJB3 Session beans etc.
WAR projects are generated to enable Seam war hotdeploy feature. Classes put into src/action will be deployed to WEB-INF/dev from which Seam automatically will perform hotdeploy of new components.


Because of Eclipse WTP limits the hot deployed classes also existed in WEB-INF/classes, but since Seam gives WEB-INF/dev precedence it will work.
Furthermore the Seam Project wizard generates a test project that is setup to run Chapter 14, Using TestNG project directly against the proper libraries and server runtime libraries. When the TestNG plugin is installed you can just run your tests via Run AsTestNG Test.
In order to deploy WAR project on server, right-click on the project and select Run AsRun on Server. Studio will deploy WAR project into one web application on server to deploy folder.

3.2. EAR Deployment

The project layout for EAR projects is:
Project Layout for EAR projects

Figure 3.2. Project Layout for EAR projects

An EAR project can use the whole range of Seam components, including EJB3 Session beans.
In order to deploy EAR project on server, right-click on the project with -ear postfix and select Run AsRun on Server. Studio will take care about all modules and deploy EAR project into one enterprise application on server to deploy folder. EAR application keeps ejb and war modules of the EAR project.


The WAR generated for EARs is now configured to utilize Seam hot-deployment (WEB-INF/dev) similar to standalone WAR projects.

3.3. Changing the Seam Version

To upgrade or downgrade your projects Seam version use the facet preferences. You should right-click your project, open its Properties and choose Project Facets category. Next select Seam and change its version to needed one.
Changing the Seam Facet Version

Figure 3.3. Changing the Seam Facet Version

After pressing Apply the wizard for adjusting new Seam runtime settings appears.
Changing the Seam Facet Version

Figure 3.4. Changing the Seam Facet Version

If you need to update the libraries for you project, check the Update libraries option. All libraries you checked will be removed and the libraries from the new Seam distribution will be added after clicking Ok.
Changing the Seam Facet Version

Figure 3.5. Changing the Seam Facet Version


The note "Seam configuration files and their XSDs won't be changed" is meant that the libraries, Seam facet and runtime version will be changed, but configuration files that refer to the old version will have to be manually updated.

3.4. Changing Seam Parent Project

Starting from the 2.0.0.CR2 version of JBoss Tools it is possible to change the Seam parent project. In earlier versions this was only controllable at a project creation time, now it can be changed for existing projects too.
Go to your project preferences and select Seam Settings category on the left. Press the Browse button next to the Main Seam Project section to select the other Seam parent project.
Changing Seam Parent Project

Figure 3.6. Changing Seam Parent Project

3.5. Renaming the Projects and Folders

If you need to rename one of the Seam Project artifacts (<project_name>, <project_name>-ear, <project_name>-ejb or <project_name>-test) or any entire folder like <project_name>/WebContent, <project_name>/ejbModule, <project_name>-test/test-src, or project name in packages org.domain.<project_name>.session, org.domain.<project_name>.entity, you can do this by brining the context menu and navigating Refactor > Rename... or just pressing Shift + Alt + R under the chosen resource.
Renaming the folder

Figure 3.7. Renaming the folder

Use Refactor > Move... (or Shift + Alt + V ), if you need to move <project_name>/WebContent folder, <project_name>/ejbModule folder or <project_name>/test-src folder in the other place within the Project structure.
Moving the folder

Figure 3.8. Moving the folder

Chapter 4. Seam Menus and Actions

In this chapter we provide a description of Seam actions that are available from
  • Menu bar
  • Toolbar
  • Context menus in views

4.1. File Menu Actions

In a Seam perspective, by default there are the following actions in FileNew submenu

Table 4.1. Seam Actions in the New Submenu

Seam Web Project
Runs Section 2.1, “Create standalone Seam Web Project” wizard for creating a new Seam project
Seam Action
Runs Section 5.1, “New Seam Action” wizard for creating a new Seam action
Seam Form
Runs Section 5.2, “New Seam Form” wizard for creating a new Seam form
Seam Entity
Runs Section 5.4, “New Seam Entity” wizard for creating a new Seam entity
Seam Conversation
Runs Section 5.3, “New Seam Conversation” wizard for creating a new Seam conversation
Seam Generate Entities

4.2. Navigate Menu Actions

In the next sections we are going to describe Seam actions which can help you to easily navigate through the source code.

4.2.1. Find Seam References/Declarations

To find EL expressions both in .java and .xhtml files use Find Seam References/Declarations actions. For that, in the main menu bar click on SearchFind Seam References or Find Seam Declarations.
Look at the description of the actions in the table below.

Table 4.2. Find Seam References/Declarations actions

Keyboard Shortcut
Find Seam References
Find Seam Declarations
Find all references and declarations to the selected element. It's available for EL expressions in both .java and .xhtml files. Differs from normal Eclipse Find References/Declarations by showing an EL or Seam references in the Search View.
also Ctrl + 1 for .java files

On the screenshot example below you could see that the search results are listed in the Search view.
Find Seam Declaration for "Identity"

Figure 4.1. Find Seam Declaration for "Identity"

You can also use Ctrl + 1 in .java files to activate the actions:
Find Seam References for "Identity"

Figure 4.2. Find Seam References for "Identity"

4.2.2. Open Seam Component

To open Seam Components click on NavigateOpen Seam Component in the main menu bar. This dialog is also available from toolbar icon or with hot keys combination "Ctrl+Shift+Z ".
Open Seam Components icon

Figure 4.3. Open Seam Components icon

In the table below read a description about the dialog.

Table 4.3. Open Seam Components Dialog

Keyboard Shortcut
Open Seam Components
Brings up the Open Seam Component dialog to open a component in the editor. The Open Seam Component selection dialog shows all Seam components existing in the workspace. You can search the components via their short, imported or full name.

Enter a name in the text field and see the results as it shown on screenshot:
Open Seam Components Dialog

Figure 4.4. Open Seam Components Dialog

You can also open Seam Component from the other component where the required one is declared in @In by using Section 7.4.3, “OpenOn” (Ctrl + left click and select Open Declaration of Seam Component for seam_component in Seam_class.java ).

Chapter 5. Seam Wizards

This chapter introduces you with Seam Components.
All the Seam component generations options known from Seam-gen are available as wizards (with sensible auto-defaulting) for creating various common Seam components:
  • Seam Action
  • Seam Form
  • Seam Entity
  • Seam Conversation
Go to FileNew and select the component wizard.
Seam Component Wizards

Figure 5.1. Seam Component Wizards

The wizards create multiple resources and place it in the appropriate folders depending on your project structure (WAR or EAR).
Let's create a WAR project using the New Seam Project wizard.
Seam Project WAR Deployment

Figure 5.2. Seam Project WAR Deployment

After the project is created you need deploy it on server.

5.1. New Seam Action

In this and following sections you can see example creating Seam Components.
To create a New Seam Action you should select a necessary project, type a name for Seam component, POJO class, Method, Page and select a Package using the Browse button.
New Seam Action Wizard

Figure 5.3. New Seam Action Wizard

If you specify a class which already exists, the wizard will warn you about it.
Wizard Warning against Existing File

Figure 5.4. Wizard Warning against Existing File

You can see the action page in WebContent folder. Click on it to open in JBoss Tools HTML Editor.
Action Page in JBoss Tools HTML Editor.

Figure 5.5. Action Page in JBoss Tools HTML Editor.


You don't need to restart the server to see how the action component works. Just use context menu Run AsRun On Server.
Action component was hot-deployed. Forms and Conversations will work the same way.
Action Component

Figure 5.6. Action Component

5.2. New Seam Form

Click on actionMethod in the internal browser and add a form in your project using the New Seam Form wizard FileNewSeam Form.
Select a necessary project, type a name for Seam component, POJO class, Method, Page and select a Package using Browse button.
New Seam Form Wizard

Figure 5.7. New Seam Form Wizard

If you specify a class which already exists, the wizard will warn you about it.
Wizard Warning against Existing File

Figure 5.8. Wizard Warning against Existing File

The Form Page was created in WebContent folder.
Form Page in JBoss Tools HTML Editor.

Figure 5.9. Form Page in JBoss Tools HTML Editor.

Deploy the form on server. Right click on Form Page, select Run AsRun On Server.
Form Component

Figure 5.10. Form Component

Form component was hot-deployed.

5.3. New Seam Conversation

Enter some value in the text field (e.g. value1) and click on formMethod.
Add a conversation using the New Seam Conversation wizard FileNewSeam Form.
You should select a necessary project, type a name for Seam component, POJO class, Method, Page and select a Package using Browse button.
New Seam Conversation Wizard

Figure 5.11. New Seam Conversation Wizard

If you specify a class which already exists, the wizard will warn you about it.
Wizard Warning against Existing File

Figure 5.12. Wizard Warning against Existing File

Conversation page was created in WebContent folder.
Conversation Page in JBoss Tools HTML Editor.

Figure 5.13. Conversation Page in JBoss Tools HTML Editor.

Right click on Conversation page, select Run AsRun On Server.
Conversation Component

Figure 5.14. Conversation Component

Conversation component was hot-deployed.
Click on Begin and Increment buttons to check the conversation functionality.

5.4. New Seam Entity

Entities cannot be hot-deployed, so we need to stop the server.
Create an Entity using the New Entity wizard FileNewSeam Entity.
You should select a necessary project, type a name for Entity class, select a Package using Browse button, type a name for Master Page and Page.
New Seam Entity Wizard

Figure 5.15. New Seam Entity Wizard

If you specify a class which already exists, the wizard will warn you about it.
Wizard Warning against Existing File

Figure 5.16. Wizard Warning against Existing File

The Master Page and the Entity were created in WebContent folder.
Master Page in JBoss Tools HTML Editor.

Figure 5.17. Master Page in JBoss Tools HTML Editor.

The Entity page is:
Entity Page in JBoss Tools HTML Editor.

Figure 5.18. Entity Page in JBoss Tools HTML Editor.

Run the Entity page on server. This is what you get:
Customer Page

Figure 5.19. Customer Page

Let's create two customers c1 and c2. Enter the name in the text field and press the Save button. Customer should be successfully created. Press Done. Do the same for c2 customer. The result should be:
Two Customers Are Created

Figure 5.20. Two Customers Are Created

Chapter 6. Seam Generate Entities

The main purpose of this chapter is to tell you about Seam Generate Entities.
Generate Entities is available directly from Eclipse using Hibernate Tools plugin for the standard seam-gen generation.
The wizard generates a set of CRUD Seam components and web pages based on existing tables in a database or on existing entities in your application.
Generate Seam Entities Wizard

Figure 6.1. Generate Seam Entities Wizard

By default, the generation mode is set to Reverse engineer from database. The reverse engineering from a database could be described in four steps:
  1. The wizard gets in database, extracts the tables and their connections
  2. On basis of this metainfomation the Entity classes are generated into org.domain.project.entity package
  3. For the entities from step 2 the classes EntityList and EntityHome are generated into org.domain.project.session package
  4. The xhtml pages are generated.


The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation. (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the connection profile set on the Section 2.6, “Configure Seam Facet Settings” while creating a project. Configured connection profile settings are hold in the generated hibernate-console.properties. To change the connection profile, double-click the console configuration. It could be found in the Hibernate Configurations view (WindowShow viewOtherHibernateHibernate Configurations or just switch to the Hibernate perspective).
Checking the Use existing entities mode the wizard executes only 3 and 4 steps. It generates missing classes and xhtml pages.
Read the Chapter 12, Generate a CRUD Database Application chapter in order to see how the Generate Seam Entities wizard can be used.

Chapter 7. Seam Editors

This chapter tells about Seam Editors and their features.

7.1. Visual Page Editor

Visual Page Editor is a great tool to use for the authoring of Seam pages. The major features of VPE are listed in Section 7.4, “Main Features of Seam Editors”
You can also read more about Visual Page Editor in the Visual Web Tools Reference Guide.

7.2. Seam Pages Editor

Seam Pages Editor provides a handy way to edit the pages.xml file.
You can edit the pages.xml file in three modes: Graphical, Tree and Source.
Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file.

7.2.1. Graphical Mode

Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.
Seam Pages Editor: Graphical View

Figure 7.1. Seam Pages Editor: Graphical View

The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings.

Table 7.1. Pages Editor: Graphical View. Visual elements

Element Description
A yellow box with a solid border represents a <page> element.
Pressing on the plus icon ( ) on the <page> element reveals a box that lists the parameters for the page.
A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.
A gray box with a dashed border represents a page that has navigation (navigation rule) to but the page is not defined in the page.xml file.
An <exception> is represented by a blue box with a orange diamond.

Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange.
On the left hand side of the Graphical view of Seam Page Editor you can find a toolbar with a set of icons for the most frequently used commands.

Table 7.2. Pages Editor: Graphical View. Commands Icons

Icon Image Command
Select a page element
Marquee a page item
Add a page relationship
Add an exception rule

Context menus are also available when you click either on an item or a blank space.
A context menu called on a blank space of the diagram provides the following options:
  • Page creates a new page element on the diagram
  • Exception creates a new exception element on the diagram
  • Auto Layout formats the layout of the diagram automatically
  • Select Element calls the Select Element Wizard with a filter to perform a quick search through the pages.xml file
Right clicking on a selected <page> element calls a context menu where you can choose the following options if you click on the New menu item:
  • Rule opens the Add Navigation Rule dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify render or redirect navigation options
  • Param calls a dialog box where you can define a parameter (using the <param> tag) for the <page> element Seam Pages Diagram Preferences

In order to customize the layout of Diagram you can go to WindowPreferencesJBoss ToolsWebSeamEditorsSeam Pages Diagram.
Preferences of Seam Pages Diagram

Figure 7.2. Preferences of Seam Pages Diagram

7.2.2. Tree Mode

Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.
Seam Pages Editor: Tree View

Figure 7.3. Seam Pages Editor: Tree View

In this mode all elements and attributes of the page.xml file can be viewed and edited in a visual, user friendly way.

7.2.3. Outline Support for Seam Pages Editor

Seam Pages Editor provides Outline view support. You can explore the pages.xml using Outline view in two modes: Tree ( ) and Diagram Navigation ( ).
The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications.
Outline view: Diagram Navigation mode

Figure 7.4. Outline view: Diagram Navigation mode

The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.
Outline view: Tree mode

Figure 7.5. Outline view: Tree mode

7.3. Seam Components Editor

When editing components.xml a structured tree editor is available in addition to pure source editing. It has a graphical view (Tree tab) and source (Source tab).
component.xml Editor

Figure 7.6. component.xml Editor


You can view and edit components.xml and other xml files directly in the Project Explorer and Properties sheet without opening the components.xml editor.
component.xml Editor

Figure 7.7. component.xml Editor

7.4. Main Features of Seam Editors

In this chapter you will know what Seam Editors features are and how to work with them.

7.4.1. Content Assist

Content Assist (Ctrl + Space) is available when using EL expressions in the following file formats:
  • JSP
  • XML
  • JAVA
Notice, the code completion for the Seam components shows the proposals marked with Seam icon.
Content Assist

Figure 7.8. Content Assist

Content Assist is also available for the "jsfc " attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.
Content Assist for the "jsfc" attribute

Figure 7.9. Content Assist for the "jsfc" attribute


To get Code Assist available for an externally generated and imported project, don't forget to enable Seam features and configure Seam Settings in Section 9.2, “Project Preferences”. Content Assist for components.xml

While you are editing a components.xml file you can make use of the Content Assist for inserting needed elements.
Content Assist in the component.xml Editor

Figure 7.10. Content Assist in the component.xml Editor

The editor also makes code completion aware of methods/attributes for EntityQuery component.
Content Assist for EntityQuery Component

Figure 7.11. Content Assist for EntityQuery Component Content assist for @Named beans

To the nice code completion you can also use Content assist for all occurrences where @Named beans are used.
Content assist for @Named beans

Figure 7.12. Content assist for @Named beans

7.4.2. Content Assist for Page Descriptors

Content Assist ( CA ) is available for Page Descriptors, .page.xml and page.xml files. Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor.
Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods.

7.4.3. OpenOn

OpenOn lets you easily navigate through your project without using the Package Explorer or Project Explorer. After pressing Ctrl + left click (or just F3) you will see a corresponding method or class.

Figure 7.13. OpenOn

OpenOn is available for the following files:


In this section were described only use cases special for Seam applications.For general information please read OpenOn section in Visual Web Tools Reference Guide.
OpenOn in XHTML files
Using OpenOn in .xhtml files you can open:
  • components or properties resolved using an EL expression;
  • all actions described in pages.xml;
  • other .xhtml files that paths are specified in a current file;
  • image files that paths are set in the value property.The files will be opened in the default system graphical editor.
OpenOn in XML files
OpenOn is also supported in Page Descriptors (.page.xml and pages.xml). OpenOn allows you to navigate to Java beans as well as to view pages. You can Ctrl + left click on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on.
OpenOn in .page.xml file

Figure 7.14. OpenOn in .page.xml file

If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn in components.xml to open the files containing rule definitions in the "rule-files" tag.
OpenOn in components.xml file

Figure 7.15. OpenOn in components.xml file

You can also use OpenOn to open jBPM components that are described in Seam component descriptor. Two places where it works are available:
  • inside <component> definition;
    OpenOn in components.xml file

    Figure 7.16. OpenOn in components.xml file

  • inside jbpm tags;
    OpenOn in components.xml file

    Figure 7.17. OpenOn in components.xml file

OpenOn in Java files
OpenOn is also supported in seam components where In annotation is presented. After pressing Ctrl + left click on the seam component specified in @In you will get the possibility to open the file where the component is declarated as well as all of the seam components where it is used in the next declarations:
  • @Out
  • @DataModel
  • @Role
  • @Roles
OpenOn in Seam Component

Figure 7.18. OpenOn in Seam Component

7.4.4. Seam Validation

Validation of various possible problematic definitions is implemented for Seam applications.
If an issue is found it will be shown in the standard Problems View.
Seam Validation

Figure 7.19. Seam Validation


Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.
In the preferences page for Seam Validator you can see and modify the validator behavior. Go to WindowPreferencesJBoss ToolsWebSeamValidator and select the severity level for the optional Seam Validator problem.
Seam Validator Preferences

Figure 7.20. Seam Validator Preferences

On WTP projects validation are enabled by default and thus executed automatically, but on normal Java projects you will have to go and add the Validation builder of your project . It is available in the properties of your project under Validation.
Enabling the Validation Builder

Figure 7.21. Enabling the Validation Builder

The validations can be run manually by clicking Validate via the context menu on your project (folder or file inside your project) which will execute all the active WTP validations. Following to the project's preferences under Validation it's possible to enable/disable any validator.
It's also possible to turn off the validation for some resource (a file, folder) inside your project via the Exclude Validation context menu option.
Excluding Validation for the WebContent Folder

Figure 7.22. Excluding Validation for the WebContent Folder

As a result, if you've turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.
Validation Filters

Figure 7.23. Validation Filters

Chapter 8. Seam Views

8.1. Seam Components View

This chapter introduces you with Seam Components View.
The Seam Components View is available from Seam perspective. It provides a list of seam components found in a project.
Seam Components View

Figure 8.1. Seam Components View

The Seam Components View can show a components default scope in two ways:
  • as labels on each component (click on the triangular symbol at the top of the Seam Components View page and select Scope PresentationLabel)
Label Scope Presentation of Seam Components

Figure 8.2. Label Scope Presentation of Seam Components

  • as a node per scope where the components are grouped under a node representing its default scope.
Node Scope Presentation of Seam Components

Figure 8.3. Node Scope Presentation of Seam Components

The Seam Packages can be presented in two ways:
  • Flat
Flat Presentation of Seam Packages

Figure 8.4. Flat Presentation of Seam Packages

  • Hierarchical
Hierarchical Presentation of Seam Packages

Figure 8.5. Hierarchical Presentation of Seam Packages

The Seam Component View can be filtered by choosing Customize View.
Customize View

Figure 8.6. Customize View

Select the Seam Components from Libraries under the Filters tab. This will make the view ignore components defined in jars. This will hide the many built-in Seam components and leave only those that are actually defined in the project or have been actively configured via components.xml. Therefore, deselecting the filter will show you all available components.
Selecting the Seam Components from Referenced Projects will hide the components that dependent on other project.
Available Seam Component View Customizations

Figure 8.7. Available Seam Component View Customizations

8.2. Project Explorer integration

If you don't like to have a view for every piece of information in Eclipse, the content of the Seam Components view is also available as a node in the built-in Project Explorer (not Package Explorer!) view in Eclipse.
Seam Components in Project Explorer

Figure 8.8. Seam Components in Project Explorer

Chapter 9. Seam Preferences

In this chapter you get to know how Seam preferences can be modified during the development process.

9.1. General Preferences

Seam preferences can be set using the Seam preference page. Click on WindowPreferencesJBoss ToolsWebSeam.
On this page you can manage the Seam Runtime. Use the appropriate buttons to Add more runtimes or to Remove those that are not needed.
Seam Preferences Page

Figure 9.1. Seam Preferences Page

Clicking on Edit button you get the form where you can change the path of Seam runtime home folder, modify name and version. Press Finish to apply the changes.
Edit Seam Runtime

Figure 9.2. Edit Seam Runtime


If you try to delete the Seam Runtime that is already in use by some project in the current workspace, then a warning message will appear. To confirm the removal press OK
Besides, when you right-click on your Seam project with deleted runtime in Project Explorer and select PropertiesSeam Settings the error message "Runtime <runtime_name> does not exist" will appear.

9.1.1. Validator Preferences

Seam preference page includes a subsection Validator. See WindowPreferencesJBoss ToolsWebSeamValidator.
On this page you can choose a severity level for the various Seam validator problems. For example, if you want to ignore the case when component name is duplicated expand the Components node and select Ignore next to Duplicate component name. After that you won't see the error.
Seam Validator Preference Page

Figure 9.3. Seam Validator Preference Page

Notice, that in the Expression language section there is now a preference for setting severity of EL Syntax. You can select whether the Seam validator displays an error, a warning or just ignore the EL Syntax error.


There are references made between each EL and variable name, so you can revalidate a particular EL if a context variable was changed. This makes parsing of each resource with referenced ELs much faster.
Severity Preference for EL Syntax

Figure 9.4. Severity Preference for EL Syntax

The Revalidate unresolved ELs automatically option is enabled by default. If necessary, you can uncheck it. It may increase a performance for big complex projects.
In the upper right corner of the Seam Validator preferences page there is a Configure Project Specific Settings link. Clicking on it you get the form where you can choose a project for specific setting. Project specific configuration allows you to have different validator settings for each project. Check the Show only projects with project specific settings if you want to see the projects that have been already set. Click on Ok.
Project Specific Configuration

Figure 9.5. Project Specific Configuration

You get the validator properties page for chosen project. Check the Enable project specific settings to be able to change the settings.


You can open the same page by right clicking on the needed project in Package Explorer, then PropertiesSeam Validator.
Validator Properties Page for Chosen Project

Figure 9.6. Validator Properties Page for Chosen Project

9.2. Project Preferences

Once Seam project is created you can modify its settings. Right click on Seam project in Project Explorer and select PropertiesSeam Settings.
This project properties page allows you to have a flexible project layout. It means that you are not restricted with a specific project structure. You can use the Seam wizards (New Action, Form, Entity, etc.) on Maven, command line seam-gen or your own project structure.
Properties for Seam Project

Figure 9.7. Properties for Seam Project


The wizard doesn't allow the renaming of the artifacts listed in the Seam Settings. It's possible to do in the Package Explorer. See Section 3.5, “Renaming the Projects and Folders”.
Also notice, you are not required to use the New Seam Project wizard to benefit from Seam artifact wizards. You can just enable Seam on your existing project by checking Seam Support and targeting to Seam Runtime, and then configure the folders as you want.
Properties for Seam Project when Seam runtime is not selected

Figure 9.8. Properties for Seam Project when Seam runtime is not selected


On the figure above fields for configuring Seam artifacts are unavailable because Seam Runtime is not selected.
In Seam Wizards (New Action, Form, Entity, Conversation, Generate Entities) you can get a quick access to project settings using the Settings link in the upper right corner of each wizard.
Quick Setting Link In Seam Wizards

Figure 9.9. Quick Setting Link In Seam Wizards

9.3. Adding Custom Capabilities

JBoss Tools provides a possibility to add custom capabilities to any Seam project, i.e. add a support of additional frameworks built on top of JSF, such as
  • ADF
  • Facelets
  • JBoss Rich Faces (versions 3.1, 3.2, 3.3)
To enable it, you should call the context menu for a Seam project and select JBoss ToolsAdd Custom Capabilities. Then check the needed modules and press Finish.
Custom Capabilities be added to Seam Project

Figure 9.10.  Custom Capabilities be added to Seam Project

The next page displays all the updates that have been made to the project.
Adding Custom Capabilities to Seam Project

Figure 9.11. Adding Custom Capabilities to Seam Project

Chapter 10. Seam Refactoring Tools

The goal of Seam components refactoring is to make system-wide code changes without affecting the behavior of the program. The Seam module of JBoss Tools provides assistance in easily code refactoring.
Starting from Jboss Tools M4 refactoring functionality became also available for managed beans, method and properties used in ELs. Thus now Seam refactoring tools include the next refactoring operations:
Refactoring commands are available from the context menus of several views and editors and use a standard Eclipse refactoring wizard. For details, see Section 10.1, “Using the Refactorinig Wizard” later in this chapter.


Seam refactoring could be only performed in the file that is not marked as Read only in its properties.
Properties View for Java File

Figure 10.1. Properties View for Java File

10.1. Using the Refactorinig Wizard

This wizard is opened always when the user clicks the Rename Seam Component, Rename Seam Context Variable or Rename command in any of the views/editors mentioned later in this chapter.
Refactoring Wizard

Figure 10.2. Refactoring Wizard

In the Seam Components name field you should enter a new name of the component, then click Next and follow the next wizard steps:
Navigating Between the Differences

Figure 10.3. Navigating Between the Differences

As you see, when performing a refactoring operation, you can preview all of the changes resulting from a refactoring action before you choose to carry them out.
The view represents two windows: one with the original source code and the other with refactored one.
With the help of , , , buttons you can quickly navigate between the differences in the code. If you don't agree with some changes you can't undo them but you can remove the class from the list of classes that need refactoring.
List of classes that need refactoring

Figure 10.4. List of classes that need refactoring

To apply the changes click Finish.
Renaming the selected seam component corrects all references to the component (also in other files in the project). Renaming a type doesn't allow to rename similarly named variables and methods.

10.2. Renaming Seam Components

Renaming a Seam component could be performed in the:

10.2.1. Renaming Seam Components in the Java Editor

If you want to rename certain seam component using Java editor, first of all it's necessary to open it. If you don't know, where the seam component is declared, use Section 4.2.2, “Open Seam Component” icon.
To rename a Seam component in the Java editor it's necessary to select the component, left click the file and then select Seam RefactorRename Seam Component.
Opening Refactoring Wizard in Java Editor

Figure 10.5. Opening Refactoring Wizard in Java Editor

For details, see also the movie, "Renaming a Seam component in the Java Editor".

10.2.2. Renaming Seam Components in the Seam Components View

To open the Refactoring wizard in the Seam Components view you should left click the component you want to open and choose Rename Seam Component option.
Opening Refactoring Wizard in Seam Components View

Figure 10.6. Opening Refactoring Wizard in Seam Components View

10.2.3. Renaming Seam Components in the Seam Components Editor

When you open components.xml file using JBoss Tools XML Editor, open the Refactoring wizard in the Tree tab by left-clicking the component in components area and choosing Rename option.
Opening Refactoring Wizard in components.xml File

Figure 10.7. Opening Refactoring Wizard in components.xml File

For details, see also the movie, "Renaming a Seam component in the components.xml file".

10.3. Renaming Seam Context Variables in EL

Renaming a Seam context variables in EL could be executed in .java, .xml, .jsp, .xhtml and .properties files in Seam projects using the context menu command Seam RefactorRename Seam Context Variable.
Refactoring Seam Context Variable in .properties File

Figure 10.8. Refactoring Seam Context Variable in .properties File

Opening Refactoring wizard in components.xml file

Figure 10.9. Opening Refactoring wizard in components.xml file

Opening Refactoring wizard in .html file

Figure 10.10. Opening Refactoring wizard in .html file

For details, see also a set of movies about renaming Seam context variables in EL in different locations:

Chapter 11. Adding Seam support to EAR project

From this chapter you will find out how to add Seam support to EAR project
For example you have several WTP projects:
  • seamproject-ear (You can create WTP EAR project using NewProjectJava EEEnterprise Application Project wizard)
  • seamproject-ejb (You can create WTP EJB project using NewProjectEJBEJB Project wizard)
  • seamproject-war (You can create WTP WEB project using NewProjectWebDynamic Web Project wizard)


You can add as many EJBs modules as you want just doing the same for each EJB project.
WTP Projects

Figure 11.1. WTP Projects

Make sure EJB and WAR are included in EAR as modules (Properties for seamproject-earJava EE Module Dependencies)
Java EE Module Dependencies

Figure 11.2. Java EE Module Dependencies

Make sure there is jboss-seam.jar in application.xml as well:
Java EE Module Dependencies

Figure 11.3. Java EE Module Dependencies

Then include libs from EAR to EJB Manifest Class-Path (Properties for seamproject-ejbJava EE Module Dependencies)
Including Libs from EAR to EJB Manifest Class-Path

Figure 11.4. Including Libs from EAR to EJB Manifest Class-Path

Include libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path (Properties for seamproject-warJava EE Module Dependencies)
Including Libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path

Figure 11.5. Including Libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path

Thus we have set our WTP EAR/EJB/WAR projects and now we are ready to add Seam support to them:
First you have to add Seam support to WAR project: Properties for seamproject-warSeam Settings
Adding Seam Support to WAR Project

Figure 11.6. Adding Seam Support to WAR Project

Set seamproject-war as Main Seam project. All other settings mostly are used by New Seam Entity/Action/Form/Conversation/... Wizards. Thus you can set them as you wish.
Then you can add Seam support to EJB project: Properties for seamproject-warSeam Settings
Adding Seam Support to EJB Project

Figure 11.7. Adding Seam Support to EJB Project

It&s important to set seamproject-war project as main Seam project there.
It will allow Seam Tools to use one common Seam model for seamproject-ejb and seamproject-war projects.
The last step is to clean/build the projects
That is all. You have added Seam support to your EAR project.
Added Seam Support to EAR Project

Figure 11.8. Added Seam Support to EAR Project

Chapter 12. Generate a CRUD Database Application

12.1. What is CRUD?

CRUD is an acronym for the four basic types of SQL commands: Create , Read , Update , Delete . Most applications have some kind of CRUD functionality, and we can assume that every programmer had to deal with CRUD at some point. A CRUD application is one that uses forms to get data into and out of a database.
In the next section we will create a Seam Web application, connect it to the HSQL database and add CRUD support.

12.2. How to create the CRUD Database Application with Seam

  • First, you should download a database and start it by running ./runDBServer.sh or runDBServer.bat from the database directory.
  • Create a new Seam Web Project using New Seam Project wizard or main menu FileNewSeam Web Project.
Seam Web Project Creation

Figure 12.1. Seam Web Project Creation

  • Name your project as crudapp, specify Target Runtime, Server and Seam Runtime configuration. Then press Next and follow the next wizard steps keeping default settings.
New Seam Project Wizard

Figure 12.2. New Seam Project Wizard


Please have a look at Chapter 2, Creating a New Seam Project via the New Seam Project wizard how to create Target Runtime and Seam Runtime in order to get started creating, running, and debugging J2EE applications.
  • On Seam Facet page click New... next to the Connection profile section to create a new Connection profile.
Seam Facet page

Figure 12.3. Seam Facet page

  • On New Connection Profile dialog select the HSQLDB connection profile type, name it cruddb and click Next.
New JDBC Connection Profile

Figure 12.4. New JDBC Connection Profile

  • On the next page click the round icon next to the Drivers field to select a database driver.
New JDBC Connection Profile Database Driver

Figure 12.5. New JDBC Connection Profile Database Driver

  • Now you should see the New Driver Definition dialog. On the first tab select the HSQLDB JBDC Driver. Underneath in the Driver name field you can change its name if you need.
Database Driver Type

Figure 12.6. Database Driver Type

  • You may notice the note on the previous figure. It prompts that you should specify the driver of the type you pointed. Set the location of the driver by switching to the next tab and press Add JAR/Zip button.
Driver Definition

Figure 12.7. Driver Definition

  • On the Properties tab set the Connection URL, Database Name and User ID and click OK.
Driver Definitions Properties

Figure 12.8. Driver Definitions Properties

  • After clicking OK to submit the newly created driver you can observe and if you need edit all specified connection details.
Driver and Connection Details

Figure 12.9. Driver and Connection Details

  • Now click Test Connection to be sure that connection can be established.
JDBC Connection is OK

Figure 12.10. JDBC Connection is OK

  • Validate JDBC Connection profile settings and press Finish or Back if something is wrong.
Validate JDBC Connection settings

Figure 12.11. Validate JDBC Connection settings

  • After clicking Finish two projects crudapp and crudapp-test will be created.
CRUDAPP Seam Project

Figure 12.12. CRUDAPP Seam Project

  • Have a look at the created projects. You can expand WEB_CONTENT folder and open home.xhtml or login.xhtml with JBoss Visual Editor.
login.xhtml in VPE

Figure 12.13. login.xhtml in VPE

  • Switch to Database Development perspective with WindowOpen PerspectiveOther... and connect to the cruddb database.
Connecting to the CRUDDB database

Figure 12.14. Connecting to the CRUDDB database

  • Expand cruddb nodes to view its Schemas, Tables, Columns etc.
CRUDDB Database

Figure 12.15. CRUDDB Database

  • Switch back to the Seam perspective. From the toolbar select NewSeam Generate Entities to create a set of CRUD Seam components and web pages based on existing tables in the database. On the first page of Generate Seam Entities wizard keep everything by default and press Next.
Generate Seam Entities

Figure 12.16. Generate Seam Entities

  • Click Refresh to display all the tables from the database.
Dialog for Selecting Tables

Figure 12.17. Dialog for Selecting Tables

  • Now you can filter the tables. Use the Include button to include only necessary ones.
Selecting Tables

Figure 12.18. Selecting Tables

  • Under WebContent folder you can find all generated xhtml files:
Entities Web Pages

Figure 12.19. Entities Web Pages

  • And under src folder java classes are created.
Entities Java Classes

Figure 12.20. Entities Java Classes

  • Switch to Hibernate perspective with WindowOpen PerspectiveOther.... On Hibernate Configurations view expand the crudapp configuration. Right click on Customers and select Open Mapping Diagram from the popup menu.
Hibernate Configurations View

Figure 12.21. Hibernate Configurations View

  • Observe the Mapping Diagram opened in the editor. Here you can see the relations between models and database tables. For better navigating on the diagram use the Outline view.
Mapping Diagram

Figure 12.22. Mapping Diagram

  • For example, select Customers entity, right click and select Open Source File. This will open the Customers.java file in the java editor. You can also do this by right-clicking on the same entity on the Mapping Diagram.
Entity class from Mapping Diagram

Figure 12.23. Entity class from Mapping Diagram

So far, you are ready to deploy your application to JBoss Application Server. This is described in the next chapter.

Chapter 13. The CRUD Application Walkthrough

After you familiarized oneself with example of creating the CRUD Database Application with Seam, you can read this charter.

13.1. Using CRUD Application

To run your CRUD Application you should do the following steps:
  • Run a project on the Server.
On Package Explorer View right click on the crudapp project, select Run AsRun on Server.
Run Project on Server

Figure 13.1. Run Project on Server

Select a Server and click Finish
Select a Server

Figure 13.2. Select a Server

Home page of the crudapp project should appear in Web Browser .
Home page

Figure 13.3. Home page

After that you can use CRUD application with "employee" database.
You can use internal JBDS Web Browser or your external Web Browser with the same link (http://localhost:8080/crudapp/home.seam).
Click on the Employees List link and observe that data from employee database is displayed.
Employees List Page

Figure 13.4. Employees List Page

Use Employees search parameters fields to filter the selected list.
Press Select opposite one of employees.
Employee details Page

Figure 13.5. Employee details Page

Press Edit to edit employee fields.
Enter Login and Password to login. (Use "crudapp-user"/"secret" for example)
Login page

Figure 13.6. Login page

Edit Employee

Figure 13.7. Edit Employee

Fill in firstname and press Save.
Database will be updated.

Chapter 14. Using TestNG project

With the help this chapter you will get to know with TestNG.

14.1. What is TestNG?

TestNG ("Testing, the Next Generation") is a Java unit testing framework that aims to overcome many limitations of JUnit. TestNG introduces some new functionalities that make it more powerful and easier to use, such as:
  • JDK 5 Annotations (JDK 1.4 is also supported with JavaDoc annotations)
  • Flexible test configuration
  • Support for data-driven testing (with @DataProvider)
  • Support for parameters
  • Allows distribution of tests on slave machines
  • Powerful execution model (no more TestSuite)
  • Supported by a variety of tools and plug-ins (Eclipse, IDEA, Maven, etc...)
  • Embeds BeanShell for further flexibility
  • Default JDK functions for runtime and logging (no dependencies)
  • Dependent methods for application server testing
More information can be found on home page: www.testng.org

14.3. How to use the generated Seam-test project to run Seam tests?

  • Create a new Seam Web Project with EAR deployment using the New Seam Project wizard.
  • After a project is created you will have the generated Seam-test project that is setup to run TestNG directly against the proper libraries and server runtime libraries.
Seam-test Project

Figure 14.1. Seam-test Project

  • Add Seam Action to your project via FileNewSeam Action.
Seam Action Creation

Figure 14.2. Seam Action Creation

  • Fill out the wizard fields. New Seam Action wizard will create resources and place them in the appropriate folders dependent on EAR project structure.
New Seam Action Wizard

Figure 14.3. New Seam Action Wizard

  • When Action is created you will see actionPage.xhtml in Package Explorer view. ActionBean.java will be automatically opened in Java Editor.
Created Action

Figure 14.4. Created Action

  • Select ActionLocalTest.xml in Seam-test project and run the test with right click Run AsTestNG Suite.


OpenOn is available in testNG XML files opened in JBoss XML Editor
Running TestNG

Figure 14.5. Running TestNG

The test process will start and its output will be written in Console View.
Test is Finished

Figure 14.6. Test is Finished

  • After running TestNG you will have the test results in test-output folder in Seam-test project (press F5 to refresh the Package Explorer view). Open index.html file with Web Browser or simply use the TestNG view.
The below view shows a successful run of the test.
Viewing the Test Results

Figure 14.7. Viewing the Test Results

You can see the test results in Web Browser.
Test Results in Browser

Figure 14.8. Test Results in Browser

After clicking on ActionLocal Tests link you will see the Results for ActionLocal Tests.
Test Information

Figure 14.9. Test Information

Select a result on the left-hand pane and its details will be displayed on the right-hand one.
ActionLocal Test Details

Figure 14.10. ActionLocal Test Details

Thus with Seam tooling you can easily take advantage of TestNG framework. As you can see, it generates its own TestNG project as a separate module within which you can easily monitor the tests execution and their output.

Chapter 15. FAQ

15.1. How to get Code Assist for Seam specific resources in an externally generated project?

To get Code Assist for Seam specific resources in an externally generated project, you should enable Seam features in Project Preferences. Right click an imported project and navigate PropertiesSeam Settings. Check Seam support box to enable all available Section 9.2, “Project Preferences”.

15.2. How to import an example Seam project from jboss-eap directory?

To import an example Seam project from jboss-eap into your working directory, you should perform the following steps:
  • Go to NewOtherJava Project from Existing Buildfile
  • Point to the build.xml of any chosen project by pressing Browse button
  • Hit Finish to open the project
As these seam examples are non WTP projects, next you should enable Seam support for them. To do that, right click the project and go to PropertiesSeam Settings.


Projects are not directly deployable unless they are in the correct state, such as an archive created through Project Archives. As an alternative, working examples are provided for Seam by navigating to HelpProject ExamplesSeam

15.3. How to change the deploy folders for Seam source code from src/hot and src/main?

You should right-click the project, select PropertiesJava Build Path, then switch to the Source tab, select the output folder for src/hot ( src/main) and click Edit to change their output location.
In conclusion, the main goal of this document is to get you know with a full feature set that JBoss Tools provides to support Seam development. Thus if you have some questions, comments or suggestions on the topic, please fell free to ask in the JBoss Tools Forum. You can also influence on how you want to see JBoss Tools docs in future leaving your vote on the article Overview of the improvements required by JBossTools/JBDS Docs users.
A set of movies on Seam tooling is available on Seam movies page.

Getting Help and Giving Feedback

A.1. Do You Need Help?

If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at http://access.redhat.com. Through the customer portal, you can:
  • search or browse through a knowledgebase of technical support articles about Red Hat products.
  • submit a support case to Red Hat Global Support Services (GSS).
  • access other product documentation.
Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at https://www.redhat.com/mailman/listinfo. Click on the name of any mailing list to subscribe to that list or to access the list archives.

A.2. Give us Feedback

If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product JBoss Developer Studio and the component Seam Developer Tools Reference Guide. The following link will take you to a pre-filled bug report for this product: http://bugzilla.redhat.com/.
Fill out the following template in Bugzilla's Description field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly.
Document URL:

Section Number and Name:

Describe the issue:

Suggestions for improvement:

Additional information:

Be sure to give us your name so that you can receive full credit for reporting the issue.

Revision History

Revision History
Revision 4.1.2-1.406Tue Jan 7 2014Rüdiger Landmann
Rebuild with Publican 4.0.0
Revision 4.1.2-1Thu Aug 29 2013Michelle Murray
TOOLSDOC-387: Rebuilt for Customer Portal, content unchanged
Revision 1-0Wed Jun 09 2010JBoss Tools Documentation Team
General updates
Revision 0-0Fri Nov 20 2009Isaac Rooskov
Initial creation of book by publican