What you will learn
In this scenario, you will learn how to get started with developing Jakarta EE 8 application using JBoss Enterprise Application Platform on OpenShift. This scenario is targeted for developers that haven't used Jakarta EE before and covers the most common parts of Jakarta EE 8.
What is Red Hat JBoss EAP?
JBoss Enterprise Application Platform is a leading Jakarta EE platform that includes full Jakarta EE 8 support.
What differs JBoss Enterprise Application Platform compared to for example Oracle® WebLogic Application Server and IBM® WebSphere Application Server ND are that JBoss EAP since version 6 and later has been architectured to be used both in cloud environments as well as more traditional environments like Virtual or Bare metal.
This scenario exclusively uses JBoss EAP on OpenShift, which is the leading container platform for Kubernetes and containers, but as a developer, you can also apply what you learn here on other environments.
In this scenario, you learned a bit about developing an application using some of the more common technologies in Jakarta EE, like JAX-RS, CDI, and JPA. You have also learned how to build and deploy that application on Openshift using the JBoss EAP S2I image.
More background and related information on JBoss EAP and the OpenShift image can be found here:
Getting Started with JBoss EAP on OpenShift
Review the weather application
To help illustrate the most common features of Jakarta EE 8, you will build a web application called "Weather App". The application allows users to see weather information in the largest cities per country.
A user can switch country by clicking on one of the flags in the menu.
To save time there is a skeleton project with a prototype version that returns a hard-coded list of cities. What you will achieve are:
- Deploy the prototype to OpenShift
- Read the weather information from a database (internal at first)
- Allow the user to choose a country
- Connect the application to an external database with weather information
Review the current state of the prototype app
The web application is a single page
./src/main/webapp/index.html. In short, the front-end uses Bootstrap and jQuery. It uses REST to contact the back-end.
Two Java classes represent the domain model for our application,
REST application using JAX-RS
The prototype already implements a simple REST based service to allow the front-end to retrieve a country object with a list of cities to display. To enable JAX-RS it's required to provide a class that extends the
javax.ws.rs.core.Application and configure the base URI (path) that is used to expose services. In the prototype, this is done in the
src/main/java/com/redhat/example/weather/RestApplication.java. In that class, we set the base URI to
/api, which means that any call to the back-end using that URI is routed to the JAX-RS subsystem.
Weather REST Service
The current weather service
src/main/java/com/redhat/example/weather/WeatherService.java already implement a simple REST service using JAX-RS and returns a List with one country that is currently hard-coded. We will change that later in this service.
Finally, for convenience, the prototype also includes
src/main/java/com/redhat/example/weather/SelectedCountry.java . This class is not in use at the moment, but we will make use of it later. The class is annotated with
@SessionScope which tells the application server that the state of this class should be stored in the session scope. E.g., the state is maintained between different requests from the front-end to the back-end. However, if the user closes the browser or is inactive for too long, the state is removed. Using the session is a convenient way to store temporary state for a user that is ephemeral. For a persistent state, a database is typically used.
The prototype also includes build configuration in the
pom.xml. The build configuration is pretty simple but does include the
wildfly-maven-plugin. Since we will be deploying to OpenShift, we will not use that plugin, but it's included here if you would like to use this project as a base for local development.
If you are new to Jakarta EE development, the prototype might seem to include a lot "magic", but most of the code in here is normal Java and should be familiar if you have developed Java applications before. The reason we are providing this prototype is to be able to focus on Jakarta EE as quickly as possible and not spend time with setup.
The code for the prototype is available here and the
solution branch contains the finished application.