Author: Sande Gilda
Level: Intermediate
Technologies: CDI, JSF, JPA, EJB, JAX-RS, BV, i18n, l10n
Summary: The kitchensink-ml
quickstart demonstrates a localized Java EE 7 compliant application using JSF, CDI, EJB, JPA, and Bean Validation.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
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 WildFly Application Server.
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.
Note: This quickstart uses the H2 database included with WildFly Application Server 11. 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 WildFly 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 WildFly Application Server.
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:
FacesMessage m = new FacesMessage(FacesMessage.SEVERITY_INFO,
KitchensinkMessages.MESSAGES.registeredMessage(),
KitchensinkMessages.MESSAGES.registerSuccessfulMessage());
The src/main/webapp/index.xhtml
file were modified.
# {bundle.<property>}
, for example: # {bundle.memberWelcomeHeader}
.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.
The application this project produces is designed to be run on WildFly Application Server 11 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 for WildFly 11 to make sure you are configured correctly for testing the quickstarts.
In the following instructions, replace WILDFLY_HOME
with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
mvn clean install wildfly:deploy
This will deploy target/kitchensink-ml.war
to the running instance of the server.
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.
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
mvn wildfly:undeploy
This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.
mvn clean verify -Parq-remote
You can also let Arquillian manage the WildFly server by using the arq-managed
profile. For more information about how to run the Arquillian tests, see Run the Arquillian Tests.
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 WildFly server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
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