Red Hat

Developer Materials

Internationalization and Localization with JBoss Logging Tools

What is it?

This quick start demonstrates the use of JBoss Logging Tools to 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 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 JBoss EAP with a different locale than the system default.

System requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 6.1 or later.

All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

Configure the JBoss EAP Server to Start With a Different Locale (Optional)

To start the JBoss EAP server with a different locale than the system default:

  1. Make a backup copy of the EAP_HOME/bin/standalone.conf file.
  2. Edit the file and append commands to set the JVM parameters for the required country and language. Eg. Germany and German, DE and de.

     JAVA_OPTS="$JAVA_OPTS -Duser.language=de" This can be done as a single line if you prefer:
     JAVA_OPTS="$JAVA_OPTS -Duser.language=de"   

    Refer to

Start the JBoss EAP Server

  1. Open a command prompt and navigate to the root of the JBoss EAP directory.
  2. The following shows the command line to start the server:

     For Linux:   EAP_HOME/bin/
     For Windows: EAP_HOME\bin\standalone.bat

Build and Deploy the Quickstart

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.

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

     mvn clean install jboss-as:deploy
  4. This will deploy target/jboss-logging-tools.war to the running instance of the server.

Note: You may see the following warnings in the server log.

    [WARNING] logging-tools/src/main/java/org/jboss/as/quickstarts/loggingToolsQS/exceptions/[25,8] Generating translation class.
    [WARNING] logging-tools/src/main/java/org/jboss/as/quickstarts/loggingToolsQS/messages/[24,8] Generating translation class.
    [WARNING] logging-tools/src/main/java/org/jboss/as/quickstarts/loggingToolsQS/exceptions/[27,8] Generating translation class.
    [WARNING] logging-tools/src/main/java/org/jboss/as/quickstarts/loggingToolsQS/loggers/[30,8] Generating translation class.
    [WARNING] logging-tools/src/main/java/org/jboss/as/quickstarts/loggingToolsQS/loggers/[26,8] Generating translation class.

This is due to a bug in the Maven compiler plug-in where all CompilerMessages are logged at warning or error level, even if they are not warnings or errors. A fix has been submitted but has not yet been applied. Details can be found here:

Access the application

The application will be running at the following URL: http://localhost:8080/jboss-logging-tools/

This landing page provides details and links to test the quickstart features. You can also directly access the following URLs.

  1. http://localhost:8080/jboss-logging-tools/rest/greetings/'name'
  2. http://localhost:8080/jboss-logging-tools/rest/greetings/'locale'/'name'
    • Example: http://localhost:8080/jboss-logging-tools/rest/greetings/fr-FR/Harold
    • Demonstrates how to obtain a message bundle for a specified locale and how to throw a localized exceptions. Note that the localized exception is a wrapper around WebApplicationException.
    • Returns a localized "hello name" string where name is the last component of the URL and the locale used is the one supplied in the locale URL.
    • Logs a localized "Hello message sent in locale" message using the JVM locale for the translation.
    • If the supplied locale is invalid (in this case if it contains more than 3 components, eg. fr-FR-POSIX-FOO), it throws a 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.

  3. http://localhost:8080/jboss-logging-tools/rest/greetings/crashme
    • Demonstrates how to throw a localized exception with another exception specified as the cause. This is a completely contrived example.
    • Attempts to divide by zero, catches the exception, and throws the localized one.
  4. http://localhost:8080/jboss-logging-tools/rest/dates/daysuntil/'targetdate'
    • Example: http://localhost:8080/jboss-logging-tools/rest/dates/daysuntil/25-12-2020
    • Demonstrates how to pass parameters through to the constructor of a localized exception, and how to specify an exception as a cause of a log message.
    • Attempts to turn the targetdate URL component into a date object using the format dd-MM-yyyy
    • Returns number of days (as an integer) until that date
    • If the targetdate is invalid, for example, http://localhost:8080/jboss-logging-tools/rest/dates/daysuntil/31-02-2015:
      • Catches the ParseException
      • Creates a localized ParseException passing values from the caught exception as parameters to its constructor
      • Logs a localized message with the localized exception as the cause
      • Throws a WebApplicationException(400) with the text from the localized ParseException

Undeploy the Archive

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. When you are finished testing, type this command to undeploy the archive:

     mvn jboss-as:undeploy

Run the Quickstart in JBoss Developer Studio or Eclipse

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

Debug the Application

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

Recent Changelog

  • May 5, 2014(Sande Gilda):Bz1087463 Add information about warning messages due to Maven compiler plug in bug. Also reformat the access url section
  • Apr 11, 2014(Sande Gilda):Bz1086883 Update Product Version metadata to include EAP 6.3
  • Mar 12, 2014(Sande Gilda):Bz1074530 replace JBOSS_HOME with EAP_HOME
  • Mar 2, 2014(Sande Gilda):Bz1025766 Replace JBoss with JBoss EAP
  • Feb 14, 2014(Sande Gilda):Replace JDBS instructions with shared resource
  • Jan 28, 2014(Sande Gilda):JDF 602 Part 2 of changes to move common instructions to a shared repository. This commit contains the Maven Configuration link changes
  • Dec 16, 2013(Sande Gilda):JDF 577 Replace command line with command prompt when referring to a terminal
  • Nov 15, 2013(Sande Gilda):Bz1025766 found and fixed 3 instances of AS7 with no space in README files
  • Nov 8, 2013(Sande Gilda):Bz1028448 Add spaces to end of metadata so it renders with a line break in HTML
  • Oct 8, 2013(Sande Gilda):BZ1011833 Add HTML versions of README files and fix deployment instructions
Your Rating: