Added 2 timeout settings to UserInfo.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

README.md

@@ -83,12 +83,15 @@ Below environment variable(s) can be used to configure the connection to BaseX,
 | BASEX_USERNAME                   | basex.username            | Username under which the application logs in. | admin            |
 | BASEX_PASSWORD                   | basex.password            | Password of the username used above.          | admin            |
 
-Below environment variable(s) can be used to configure which claims are used to fill the UserInfo response.
-
-| Environment variable             | Java Property                  | Description                                   | Example          |
-| -------------------------------- | ------------------------------ | --------------------------------------------- | ---------------- |
-| USERINFO_NAME_CLAIMNAME          | compas.userinfo.name.claimname | The Name of the user logged in.               | name             |
-| USERINFO_WHO_CLAIMNAME           | compas.userinfo.who.claimname  | The Name of the user used in the Who History. | name             |
+Below environment variable(s) can be used to configure which claims and information are used to fill the UserInfo
+response.
+
+| Environment variable             | Java Property                   | Description                                                 | Example          |
+| -------------------------------- | ------------------------------- | ----------------------------------------------------------- | ---------------- |
+| USERINFO_NAME_CLAIMNAME          | compas.userinfo.name.claimname  | The Name of the user logged in.                             | name             |
+| USERINFO_WHO_CLAIMNAME           | compas.userinfo.who.claimname   | The Name of the user used in the Who History.               | name             |
+| USERINFO_SESSION_WARNING         | compas.userinfo.session.warning | Number of minutes a Session Warning can be displayed.       | 20               |
+| USERINFO_SESSION_EXPIRES         | compas.userinfo.session.expires | Number of minutes a Session Expires to display in Frontend. | 30               |
 
 ## Security
 

app/src/main/java/org/lfenergy/compas/scl/data/rest/UserInfoProperties.java

@@ -13,4 +13,10 @@ public interface UserInfoProperties {
 
     @WithName("who.claimname")
     String who();
+
+    @WithName("session.warning")
+    int sessionWarning();
+
+    @WithName("session.expires")
+    int sessionExpires();
 }

app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResource.java

@@ -66,6 +66,8 @@ public UserInfoResponse getUserInfo(@HeaderParam("Authorization") String authHea
 
         var response = new UserInfoResponse();
         response.setName(jsonWebToken.getClaim(userInfoProperties.name()));
+        response.setSessionWarning(userInfoProperties.sessionWarning());
+        response.setSessionExpires(userInfoProperties.sessionExpires());
         return response;
     }
 }

app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/model/UserInfoResponse.java

@@ -3,6 +3,8 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.data.rest.v1.model;
 
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
@@ -13,14 +15,39 @@
 @XmlRootElement(name = "UserInfoResponse", namespace = SCL_DATA_SERVICE_V1_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class UserInfoResponse {
+    @Schema(description = "The name of the user retrieved from the JWT Claim.")
     @XmlElement(name = "Name", namespace = SCL_DATA_SERVICE_V1_NS_URI)
     private String name;
 
+    @Schema(description = "The number of minutes when the frontend isn't used and a warning message will be shown.")
+    @XmlElement(name = "SessionWarning", namespace = SCL_DATA_SERVICE_V1_NS_URI)
+    private int sessionWarning;
+
+    @Schema(description = "The number of minutes when the session will expire and a expired message will be shown if the frontend isn't used.")
+    @XmlElement(name = "SessionExpires", namespace = SCL_DATA_SERVICE_V1_NS_URI)
+    private int sessionExpires;
+
     public String getName() {
         return name;
     }
 
     public void setName(String name) {
         this.name = name;
     }
+
+    public int getSessionWarning() {
+        return sessionWarning;
+    }
+
+    public void setSessionWarning(int sessionWarning) {
+        this.sessionWarning = sessionWarning;
+    }
+
+    public int getSessionExpires() {
+        return sessionExpires;
+    }
+
+    public void setSessionExpires(int sessionExpires) {
+        this.sessionExpires = sessionExpires;
+    }
 }

app/src/main/resources/application.properties

@@ -4,6 +4,8 @@
 
 compas.userinfo.name.claimname    = ${USERINFO_NAME_CLAIMNAME:name}
 compas.userinfo.who.claimname     = ${USERINFO_WHO_CLAIMNAME:name}
+compas.userinfo.session.warning   = ${USERINFO_SESSION_WARNING:10}
+compas.userinfo.session.expires   = ${USERINFO_SESSION_EXPIRES:15}
 
 quarkus.http.cors                 = false
 quarkus.http.root-path            = /compas-scl-data-service/

app/src/test/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResourceTest.java

@@ -84,7 +84,8 @@ void getUserInfo_WhenCalled_ThenUserInfoResponseRetrieved() {
                 .response();
 
         var xmlPath = response.xmlPath();
-        var name = xmlPath.get("UserInfoResponse.Name");
-        assertEquals("Test User", name);
+        assertEquals("Test User", xmlPath.get("UserInfoResponse.Name"));
+        assertEquals(10, xmlPath.getInt("UserInfoResponse.SessionWarning"));
+        assertEquals(15, xmlPath.getInt("UserInfoResponse.SessionExpires"));
     }
 }