tasks-jsf: JSF, JPA quickstart

Author: Lukas Fryc
Level: Intermediate
Technologies: JSF, JPA
Summary: The tasks-jsf quickstart demonstrates how to use JPA persistence with JSF as the view layer.
Prerequisites: tasks
Target Product: ${product.name}
Source: <${github.repo.url}>

What is it?

The tasks-jsf quickstart demonstrates how to use JPA persistence with JSF as view layer in an application deployed to ${product.name.full}. It provides a JSF front end for the tasks quickstart.

The theme of this application is simple Task management with simple login. The project contains two entities - a user and a task.

This sample includes a persistence unit and some sample persistence code to introduce you to database access in enterprise Java. Persistence code is covered by tests to help you write business logic without the need to use any view layer.

JSF is used to present the user two views.

• authentication form: This provides the simple login
• task view: This view contains the task list, a task detail, and a task addition form. The task view uses AJAX.

System Requirements

The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.

All you need to build this project is ${build.requirements}. See Configure Maven for ${product.name} ${product.version} to make sure you are configured correctly for testing the quickstarts.

Note: This quickstart uses the H2 database included with ${product.name.full} ${product.version}. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!

Note: This quickstart uses a *-ds.xml datasource configuration file for convenience and ease of database configuration. These files are deprecated in ${product.name} and should not be used in a production environment. Instead, you should configure the datasource using the Management CLI or Management Console. Datasource configuration is documented in the Configuration Guide for ${product.name.full}.

Use of ${jboss.home.name}

In the following instructions, replace ${jboss.home.name} with the actual path to your ${product.name} installation. The installation path is described in detail here: Use of ${jboss.home.name} and JBOSS_HOME Variables.

Start the ${product.name} Server

1. Open a command prompt and navigate to the root of the ${product.name} directory.

2. The following shows the command line to start the server:

    For Linux:   ${jboss.home.name}/bin/standalone.sh
    For Windows: ${jboss.home.name}\bin\standalone.bat
   

Build and Deploy the Quickstart

1. Make sure you have started the ${product.name} server as described above.

2. Open a command prompt and navigate to the root directory of this quickstart.

3. Type this command to build and deploy the archive:

    mvn clean install wildfly:deploy
   

4. This will deploy target/${project.artifactId}.war to the running instance of the server.

Access the Application

The application will be running at the following URL http://localhost:8080/${project.artifactId}/.

Server Log: Expected Warnings and Errors

Note: You will see the following warnings in the server log. You can ignore these warnings.

WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in a future version.

HHH000431: Unable to determine H2 database version, certain features may not work

Undeploy the Archive

1. Make sure you have started the ${product.name} server as described above.

2. Open a command prompt and navigate to the root directory of this quickstart.

3. When you are finished testing, type this command to undeploy the archive:

    mvn wildfly:undeploy
   

Run the Arquillian Tests

This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.

1. Make sure you have started the ${product.name} server as described above.

2. Open a command prompt and navigate to the root directory of this quickstart.

3. Type the following command to run the test goal with the following profile activated:

    mvn clean verify -Parq-remote
   

You can also let Arquillian manage the ${product.name} server by using the arq-managed profile. For more information about how to run the Arquillian tests, see Run the Arquillian Tests.

Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a ${product.name} server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

    mvn dependency:sources