Developer Materials

kitchensink-ear


    The kitchensink-ear quickstart demonstrates web-enabled database application, using JSF, CDI, EJB, JPA, and Bean Validation, packaged as an EAR.

    What is it?

    The kitchensink-ear quickstart is a deployable Maven 3 project to help you get your foot in the door developing with Java EE 8 on JBoss Enterprise Application Platform Server.

    It demonstrates how to create a compliant Java EE 8 application using JSF, CDI, JAX-RS, EJB, JPA, and Bean Validation. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java. It is based on the kitchensink quickstart but is packaged as an EAR archive.

    Considerations for Use in a Production Environment

    H2 Database

    This quickstart uses the H2 database included with JBoss Enterprise Application Platform Server 7.2. 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.

    Datasource Configuration File

    This quickstart uses a *-ds.xml datasource configuration file for convenience and ease of database configuration. These files are deprecated in JBoss EAP 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.

    System Requirements

    The application this project produces is designed to be run on JBoss Enterprise Application Platform Server 7.2 or later.

    All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.

    Use of EAP_HOME

    In the following instructions, replace EAP_HOME with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.

    Start the JBoss EAP Standalone Server

    1. Open a terminal and navigate to the root of the JBoss EAP directory.

    2. Start the JBoss EAP server with the default profile by typing the following command.

      $ EAP_HOME/bin/standalone.sh 
      Note
      For Windows, use the EAP_HOME\bin\standalone.bat script.

    Build and Deploy the Quickstart

    1. Make sure you start the JBoss EAP server as described above.

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

    3. Type the following command to build the artifacts.

      $ mvn clean install wildfly:deploy

    This deploys the kitchensink-ear/ear/target/kitchensink-ear.ear to the running instance of the server.

    You should see a message in the server log indicating that the archive deployed successfully.

    Access the Application

    The application will be running at the following URL: http://localhost:8080/kitchensink-ear/.

    1. Enter a name, email address, and Phone nubmer in the input field and click the Register button.

    2. If the data entered is valid, the new member will be registered and added to the Members display list.

    3. If the data is not valid, you must fix the validation errors and try again.

    4. When the registration is successful, you will see a log message in the server console:

      Registering YOUR_NAME

    Undeploy the Quickstart

    When you are finished testing the quickstart, follow these steps to undeploy the archive.

    1. Make sure you start the JBoss EAP server as described above.

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

    3. 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 since Arquillian tests require the use of a container.

    Note
    The Arquillian tests deploy the application, so make sure you undeploy the quickstart before you begin.

    Follow these steps to run the tests.

    1. Start the JBoss EAP server as described above.

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

    3. Type the following command to run the verify goal with the arq-remote profile activated.

      $ mvn clean verify -Parq-remote
    Note

    You can also let Arquillian manage the JBoss EAP server by using the arq-managed profile, meaning the tests will start the server for you. This profile requires that you provide Arquillian with the location of the JBoss EAP server, either by setting the JBOSS_HOME environment variable, or by setting the jbossHome property in the arquillian.xml file. For more information, see Run the Arquillian Tests.

    Investigate the Console Output

    When you run the Arquillian tests, Maven prints summary of the performed tests to the console. You should see the following results.

    Results :
    Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

    Investigate the Server Console Output

    You should see messages similar to the following:

    INFO  [org.jboss.as.server.deployment] (MSC service thread 1-3) WFLYSRV0027: Starting deployment of "test.war" (runtime-name: "test.war")
    ...
    INFO  [org.jboss.as.quickstarts.kitchensink_ear.service.MemberRegistration] (default task-102) Registering Jane Doe
    INFO  [org.jboss.as.quickstarts.kitchensink_ear.test.MemberRegistrationTest] (default task-102) Jane Doe was persisted with id 1
    ...
    INFO  [org.jboss.as.server.deployment] (MSC service thread 1-2) WFLYSRV0028: Stopped deployment test.war (runtime-name: test.war) in 38ms
    ....
    INFO  [org.jboss.as.server] (management-handler-thread - 22) WFLYSRV0009: Undeployed "test.war" (runtime-name: "test.war")

    Server Log: Expected Warnings and Errors

    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

    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 in Red Hat JBoss Developer Studio or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

    For this quickstart, follow the special instructions to build Quickstarts Containing an EAR.

    1. Right-click on the kitchensink-ear-ear subproject, and choose Run As –> Run on Server.

    2. Choose the server and click Finish.

    3. This starts the server, deploys the application, and opens a browser window that accesses the running application at http://localhost:8080/kitchensink-ear-web.

    4. To undeploy the project, right-click on the kitchensink-ear-ear project and choose Run As –> Maven build. Enter wildfly:undeploy for the Goals and click Run.

    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