#set( $symbol_pound = '#' ) #set( $symbol_dollar = '$' ) #set( $symbol_escape = '\' )
Author: Pete Muir
This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7.
This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.
This application builds on top of the standard JSF approach by incorporating the RichFaces project to provide a set of components, allowing for a rich user experience. RichFaces builds on top of the JSF standard and is a fully portable solution compatible with all JSF implementations.
The kitchensink
quickstart is built using vanilla JSF for its front end. The kitchensink-rf
quickstart builds on top of the JSF user interface, augmenting it with RichFaces JSF components and capabilities.
Some key points to make note of while running the application:
Ajax push: This application makes use of Ajax push. When a member is created in one browser, the member list is updated in all open browsers.
Try this yourself. Open two different browsers, create a new member in one browser and watch for the list to be updated in both browsers.
Ajax: All page updates are made with an Ajax call, increasing the page responsiveness and leading to a more native feeling application.
Client-side validation: By simply nesting a <rich:validator />
tag in the input elements, we wire them with RichFaces client-side validation capabilities. The inputs are validated locally using javascript, without requiring a round-trip to the server.
Popups: Click the view
link next to a member in the member list to view a popup with the member details. To close the popup, click the X
in the top right-hand corner, or click anywhere on the background mask.
Mobile support: View the application from a webkit powered browser on a mobile device to try out the mobile version of the application. Alternatively, view the mobile version on your desktop by navigating to the url: http://localhost:8080/${artifactId}/mobile/
Specific changes to the "vanilla" kitchensink desktop view:
Ajax push: This application makes use of Ajax push. When a member is created in one browser, the member list is updated in all open browsers.
rich:validator for client-side-validation
a4j:commandButton to submit a form via ajax
rich:collapsiblePanel around the members list - click to expand/collapse
rich:popupPanel via the "view" link in the table for showing member details with a popup
rich:panel to get a styled panel header
rich:messages to get styled error messages (with icons)
rich:dataTable for styled column headers
activated the "classic" skin in the web.xml - (styles vanilla JSF components too)
leveraged AS 7 modules for RF dependencies via the "Dependencies" manifest.mf entry
Upgrades made to enable the mobile view:
enabled resourceLoadingOptimisation (packaging and minification)
introduced the RichFaces mobile compatibility CSS file
device detection to automatically choose between the desktop and mobile templates
split the app into multiple screens for mobile
single page programming model w/ CSS3 page transitions activating the device GPU
Note: mobile still has a4j:push integration
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
If you have not yet done so, you must Configure Maven before testing the quickstarts.
The following shows the command line to start the server with the web profile:
For Linux: JBOSS_HOME/bin/standalone.sh
For Windows: JBOSS_HOME${symbol_escape}bin${symbol_escape}standalone.bat
NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.
Type this command to build and deploy the archive:
mvn clean package jboss-as:deploy
This will deploy target/${artifactId}.war
to the running instance of the server.
The application will be running at the following URL: http://localhost:8080/${artifactId}/.
When you are finished testing, type this command to undeploy the archive:
mvn jboss-as:undeploy
This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.
NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Run the Arquillian Tests for complete instructions and additional options.
Type the following command to run the test goal with the following profile activated:
mvn clean test -Parq-jbossas-remote
You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts
If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc