REST-Service

[Test project for a course at IMT]

Information

Java service with Maven and Tomcat 9.0. This service uses Jersey and implements a test Rest API to query flights, airlines and seats. The service is connected with a gRPC API to a service allowing to book hotels.

Setup

With Docker

By default, this project is configured to run with docker. You will only have to change the path to your keycloak-realm.json file in the docker-compose file ("docker/global-docker/docker-compose").

To run project, you can choose to use the docker-compose file, or build manually images from the DockerFile of each service. (docker image are not stored on docker hub, you will have to build them with DockerFile first)

To build the rest service image, you can follow the guide here : https://github.com/KontainPluton/REST-Service/blob/main/docker/rest-server-docker/createDockerImage.md

If you want to use keycloak (dockerised) you need to create users. Refer to the tutorial in the Configure Keycloack Server part, to create a user (id: test & pwd: test, for example) https://github.com/KontainPluton/REST-Service#configure-keycloak-server-

If you want to have the hotel reservation part, please install and start the gRPC service on this git Repository (work by default with docker) :

---

Without Docker

Requirements :

• Have Java 1.8 (jdk) installed (https://openjdk.java.net/install/)
• Have Apache Maven installed (https://maven.apache.org/download.cgi)
• Have Apache Tomcat 9.0 installed (run on paort 8090) (doesn't work with Tomcat 10.x) (https://tomcat.apache.org/download-90.cgi)
• Have Keycloak server installed (localhost:8080) (https://www.keycloak.org/downloads) (we will configure the realm and the clients in this part)

If you want to have the hotel reservation part, please install and start the gRPC service on this git Repository :

You also will have to change the environment variable USE_DOCKER in Environment.java to false and eventualy change the grpc server adress

Configure Keycloak server :

(In this part, this guide can be usefull : https://www.katacoda.com/keycloak/courses/keycloak/configure-keycloak)

Once the server is installed (and configured on port 8080 (localhost)), you must add an admin user to keycloak. This user will be used to connect to the global server configuration page.

Move to the /bin folder of your keycloak installation (example: cd keycloak-16.1.0/bin) and type : (here, login=admin and password=admin)

Linux :

./add-user-keycloak.sh -r master -u admin -p admin

Windows :

./add-user-keycloak.bat -r master -u admin -p admin

Once done you can start your server, run :

Linux :

./standalone.sh

Windows :

./standalone.bat

Open your browser and go to : localhost:8080, and click on "Administrative Console". The login and password are those defined previously for the admin user.

---

Then you can follow the guide (https://www.katacoda.com/keycloak/courses/keycloak/configure-keycloak).

• Create a new realm : BookMe
• Create a client : service-rest
  • Access Type : bearer-only
  • Admin URL : http://localhost:8090/java-restserver/api/securised/
• Create a client : js-client
  • Access Type : public
  • Admin URL : http://localhost:8090/java-restserver/JS-Client/
  • Root URL : http://localhost:8090/java-restserver/JS-Client/
  • Valid Redirect URIs : http://localhost:8090/*
• Create a role : user
• Create a user : test (password: test) (non-temporary password)
• Assign the role user to the test user

---

Install Keycloak adapter for Tomcat :

Download the Keycloak tomcat adapter here : https://www.keycloak.org/downloads Then you can follow the guide here : https://www.keycloak.org/docs/latest/securing_apps/#_tomcat_adapter

---

Build the REST-Service

• Go into java-restserver folder.
• Go into src/main/webapp/ folder.
• In WEB-INF/keycloack.json, change http://host.docker.internal:8080/auth/ to http://localhost:8080/auth
• In JS-Client/keycloack.json, change http://host.docker.internal:8080/auth/ to http://localhost:8080/auth
• In JS-Client/app.js, change the constant serverIP with : localhost (instead of host.docker.internal)
• Go back to the first folder : java-restserver
• Run : mvn clean
• Run : mvn install
• Go into target/java-restserver/META-INF folder.

If there is no context.xml in this folder, add it from the folder: java-restserver/src/main/resources/META-INF/ (from the repository root folder). Then rebuild the project (mvn install).

Finally, find the java-restserver.war file (maven target folder), and move it into your tomcat webapps folder.

(For Linux, it's by default : $CATALINA_HOME/webapps/)

---

If you run tomcat, you can access :

• JS-Client (front-end) : http://localhost:8090/java-restserver/JS-Client/
• REST API (unsecure) : http://localhost:8090/java-restserver/api/notsecurised/
• REST API (secure, so you need keycloak access_token) : http://localhost:8090/java-restserver/api/securised/