The logging-tools
quickstart shows how to use JBoss Logging Tools to create internationalized loggers, exceptions, and messages and localize them.
What is it?
The logging-tools
quickstart demonstrates the use of JBoss Logging Tools in Red Hat JBoss Enterprise Application Platform. 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 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 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.
Configure the Server to Start With a Different Locale (Optional)
To start the JBoss EAP server with a different locale than the system default:
-
Make a backup copy of the
$ EAP_HOME/bin/standalone.conf
file. -
Edit the file and append commands to set the JVM parameters for the required country and language. The following example sets the country to Germany (
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.
Start the JBoss EAP Standalone Server
-
Open a terminal and navigate to the root of the JBoss EAP directory.
-
Start the JBoss EAP server with the default profile by typing the following command.
$ EAP_HOME/bin/standalone.sh
NoteFor Windows, use the EAP_HOME\bin\standalone.bat
script.
Build and Deploy the Quickstart
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type the following command to build the artifacts.
$ mvn clean package wildfly:deploy
This deploys the logging-tools/target/logging-tools.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/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
-
Example: http://localhost:8080/logging-tools/rest/greetings/Harold
-
Demonstrates simple use of localized messages (with parameter) and logging.
-
It returns the localized
hello NAME
string whereNAME
is the last component of the URL. -
It also logs the localized
Hello message sent
in the server log.
-
-
http://localhost:8080/logging-tools/rest/greetings/LOCALE/NAME
-
Example: http://localhost:8080/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 whereNAME
is the last component of the URL and the locale used is the one supplied in thelocale
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 ofWebApplicationException
.Note that
WebApplicationException
cannot be directly localized by JBoss Logging Tools using the@Message
annotation due to the message parameter being ignored by theWebApplicationException
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
-
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.
-
-
http://localhost:8080/logging-tools/rest/dates/daysuntil/TARGET_DATE
-
Example: http://localhost:8080/logging-tools/rest/dates/daysuntil/2020-12-25
-
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
TARGET_DATE
URL component into a date object using the formatyyyy-MM-dd
-
Returns number of days (as an integer) until that date
-
If the
TARGET_DATE
is invalid, for example, http://localhost:8080/logging-tools/rest/dates/daysuntil/2015-02-31:-
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 localizedParseException
-
-
Undeploy the Quickstart
When you are finished testing the quickstart, follow these steps to undeploy the archive.
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type this command to undeploy the archive:
$ mvn wildfly:undeploy
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.
You might 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
/{artifactId}/target/generated-sources/annotations/org/jboss/as/quickstarts/loggingToolsQS/exceptions line 8
Java Problem
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.
-
Browse to OpenShift Online console and login with your credentials.
-
On the View All Projects or Welcome to Project page, click Create Project.
-
On the Create Project page, enter the following information:
Name: logging-tools Display Name logging-tools Description: logging-tools
-
Click Create to create the project.
-
On the My Projects page, choose your new logging-tools and click Browse Catalog.
-
Choose JBoss EAP CD (no https) and then click Next to view the Information page.
-
Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.
Add to Project: logging-tools Application Name: logging-tools Custom http Route Hostname: (leave blank) Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/ Git Reference: openshift Context directory: logging-tools
-
Click the Create button.
-
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.
-
-
Click the Overview tab to see the
logging-tools
deployment. -
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.
-
Go to the View All Projects page and select Delete Project from the drop down list to the right of the logging-tools project.
-
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