Author: Darrin Mison
Level: Beginner
Technologies: JBoss Logging Tools
Summary: The logging-tools
quickstart shows how to use JBoss Logging Tools to create internationalized loggers, exceptions, and messages and localize them.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
The logging-tools
quickstart demonstrates the use of JBoss Logging Tools in WildFly Application Server. The logging tools create internationalized loggers, exceptions, and generic messages; and then provide localizations for them. This is done using a simple JAX-RS service. Translations in French(fr-FR), German(de-DE), and Swedish (sv-SE) are provided courtesy of http://translate.google.com for demonstration. My apologies if they are less than ideal translations.
Once the quick start is deployed you can access it using URLs documented below.
Instructions are included below for starting WildFly with a different locale than the system default.
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.
To start the WildFly server with a different locale than the system default:
WILDFLY_HOME/bin/standalone.conf
file.DE
) and the language to German (de
).
JAVA_OPTS="$JAVA_OPTS -Duser.country=DE"
JAVA_OPTS="$JAVA_OPTS -Duser.language=de"
This can be done as a single line if you prefer:
JAVA_OPTS="$JAVA_OPTS -Duser.country=DE -Duser.language=de"
For more information about internationalization and localization, see http://www.oracle.com/technetwork/java/javase/tech/intl-139810.html.
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
mvn clean install wildfly:deploy
This will deploy target/logging-tools.war
to the running instance of the server.
The application will be running at the following URL: http://localhost:8080/logging-tools/
This landing page provides details and links to test the quickstart features. You can also directly access the following URLs.
http://localhost:8080/logging-tools/rest/greetings/'name'
hello NAME
string where NAME
is the last component of the URL.Hello message sent
in the server log.http://localhost:8080/logging-tools/rest/greetings/'locale'/'name'
WebApplicationException
.hello NAME
string where NAME
is the last component of the URL and the locale used is the one supplied in the locale
URL.Hello message sent in LOCALE
message using the JVM locale for the translation.WebApplicationException
(404) using a localizable sub-class of WebApplicationException
.Note that WebApplicationException
cannot be directly localized by JBoss Logging Tools using the @Message
annotation due to the message parameter being ignored by the WebApplicationException
constructors. Cases like this can be worked around by creating a subclass with a constructor that does deal with the message parameter.
http://localhost:8080/logging-tools/rest/greetings/crashme
http://localhost:8080/logging-tools/rest/dates/daysuntil/'targetdate'
targetdate
URL component into a date object using the format yyyy-MM-dd
targetdate
is invalid, for example, http://localhost:8080/logging-tools/rest/dates/daysuntil/2015-02-31:
ParseException
ParseException
passing values from the caught exception as parameters to its constructorWebApplicationException
(400) with the text from the localized ParseException
mvn wildfly:undeploy
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.
You may see the following warning when you import this quickstart into JBoss Developer Studio. You can ignore this warning as it occurs in a generated file.
The import org.jboss.as.quickstarts.loggingToolsQS.exceptions.LocaleInvalidException is never used
GreeterExceptionBundle_$bundle.java
/logging-tools/target/generated-sources/annotations/org/jboss/as/quickstarts/loggingToolsQS/exceptions line 8
Java Problem
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