The kitchensink-ml quickstart demonstrates a localized Java EE 7 compliant application using JSF, CDI, EJB, JPA, and Bean Validation.

What is it?

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

It demonstrates how to create a localized Java EE 7 compliant application using JSF, CDI, JAX-RS, EJB, JPA, and Bean Validation. A localized application is one that supports multiple languages. That is what the -ml suffix denotes in the quickstart name kitchensink-ml. This quickstart also includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.

This quickstart uses the kitchensink quickstart as its starting point. It has been enhanced to provide localization of labels and messages. A user sets the preferred language choice in the browser and, if the application supports that language, the application web page is rendered in that language. For demonstration purposes, this quickstart has been tranlated into French(fr) and Spanish (es) using http://translate.google.com, so the translations may not be ideal.

Localization Code Changes

The following changes were made to the quickstart to enable it to use the browser preferred locale setting when displaying the web page:

  • Properties files were created for the supported languages.

    • This quickstart is localized for Spanish and French. You can add additional language support by creating properties files with the appropriate suffix and populating the properties with translated values.

    • The JSF resource Bundle is located at `src/main/resources/org/jboss/as/quickstarts/kitchensink/bundle/Resources_(es|fr).properties

    • Messages generated by Java code (e.g. log messages and messages sent to the UI) are internationalized using JBoss Logging. The log messages are accessed via the org.jboss.as.quickstarts.kitchensink.util.KitchensinkMessages interface, and the message bundles are located at: src/main/resources/org/jboss/as/quickstarts/kitchensink/util/KitchensinkMessages.i18_(es|fr).properties

    • The message bundle consumed by Bean Validation is located at src/main/resources/ValidationMessages.properties. This is defined by the bean validation specification.

  • The following XML was added to the src/main/webapp/WEB-INF/faces-config.xml file. When you create a property file for a new language, you must add the supported locale to this file.

    <application>
      <locale-config>
        <default-locale>en</default-locale>
        <supported-locale>en-US</supported-locale>
        <supported-locale>fr</supported-locale>
        <supported-locale>fr-FR</supported-locale>
        <supported-locale>es</supported-locale>
        <supported-locale>es-ES</supported-locale>
      </locale-config>
      <resource-bundle>
        <base-name>org/jboss/as/quickstarts/kitchensink/bundle/Resources</base-name>
        <var>bundle</var>
      </resource-bundle>
    </application>
  • The src/main/java/org/jboss/as/quickstarts/kitchensink/model/Member.java file was modififed to add the message key to @Pattern annotation.

    @NotNull
    @Size(min = 1, max = 25)
    @Pattern(regexp = "[A-Za-z ]*", message = "{name_validation_message}")
    private String name;
  • The src/main/java/org/jboss/as/quickstarts/kitchensink/util/KitchensinkMessages.java file was created, which defines default messages in English. The jboss-logging-processor will automatically generate an implementation for you, which can be accesssed via the MESSAGES static variable.

    @MessageBundle(projectCode = "")
    public interface KitchensinkMessages {
    
       KitchensinkMessages MESSAGES = Messages.getBundle(KitchensinkMessages.class, FacesContext.getCurrentInstance().getViewRoot().getLocale());
    
       @Message("Registered!")
       String registeredMessage();
    
       @Message("Successfully registered!")
       String registerSuccessfulMessage();
    
       @Message("Registration failed:")
       String registerFailMessage();
    
       @Message("Registration failed. See server log for more information.")
       String defaultErrorMessage();
    }
  • The src/main/java/org/jboss/as/quickstarts/kitchensink/controller/MemberController.java file was modified as follows:

    • Messages strings were replaced with strings retrieved using the resource bundle property names. For example:

      FacesMessage m = new FacesMessage(FacesMessage.SEVERITY_INFO,
              KitchensinkMessages.MESSAGES.registeredMessage(),
              KitchensinkMessages.MESSAGES.registerSuccessfulMessage());
  • The src/main/webapp/index.xhtml file were modified.

    • Strings for headers, messages, labels were replaced with the appropriate # {bundle.<property>}, for example: # {bundle.memberWelcomeHeader}.

Set the Browser Preferred Locale

How you set your browser preferred locale depends on the browser and version you use. Use your browser help option to search for instructions to change the preferred language setting.

Considerations for Use in a Production Environment

H2 Database

This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 7.1. 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 for Red Hat JBoss Enterprise Application Platform.

System Requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 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 package wildfly:deploy

This deploys the kitchensink-ml/target/kitchensink-ml.war 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-ml/.

Change your browser preferred language to French or Spanish and refresh the page to see it displayed in the new language.

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

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.

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.

Deploy the Quickstart to OpenShift Online

Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.

Create and Deploy the Quickstart Project

Follow these instructions to deploy this quickstart to OpenShift Online.

  1. Browse to OpenShift Online console and login with your credentials.

  2. On the View All Projects or Welcome to Project page, click Create Project.

  3. On the Create Project page, enter the following information:

    Name:  kitchensink-ml
    Display Name kitchensink-ml
    Description: kitchensink-ml
  4. Click Create to create the project.

  5. On the My Projects page, choose your new kitchensink-ml and click Browse Catalog.

  6. Choose JBoss EAP CD (no https) and then click Next to view the Information page.

  7. Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.

    Add to Project: kitchensink-ml
    Application Name: kitchensink-ml
    Custom http Route Hostname: (leave blank)
    Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/
    Git Reference: openshift
    Context directory: kitchensink-ml
  8. Click the Create button.

  9. Click on the Continue to the project overview link.

    • You should see "Build #1 is running …​" with the console log below.

      Cloning ...
      Downloading ...
      Building ...
      Copying ...
      Pushing ...
    • At the end of the build, you should see "Push successful".

    • Click View Full Log to see the entire log.

  10. Click the Overview tab to see the kitchensink-ml deployment.

  11. Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:

    http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com

Delete the Quickstart Project

Follow these instructions to delete the project from OpenShift Online.

  1. Go to the View All Projects page and select Delete Project from the drop down list to the right of the kitchensink-ml project.

  2. Type the name of the project to confirm, and then click Delete

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