refactor: create thymeleaf module and update existing

Author: juherr

pom.xml

@@ -23,7 +23,9 @@
     <module>steve-ocpp-2-x</module>
     <module>steve-ocpp-soap</module>
     <module>steve-ocpp-websocket</module>
+    <module>steve-ui</module>
     <module>steve-ui-jsp</module>
+    <module>steve-ui-thymeleaf</module>
   </modules>
 
   <properties>
@@ -85,11 +87,21 @@
         <artifactId>steve-api</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>de.rwth.idsg</groupId>
+        <artifactId>steve-ui</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>de.rwth.idsg</groupId>
         <artifactId>steve-ui-jsp</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>de.rwth.idsg</groupId>
+        <artifactId>steve-ui-thymeleaf</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-framework-bom</artifactId>
@@ -104,6 +116,13 @@
         <type>pom</type>
         <scope>import</scope>
       </dependency>
+      <dependency>
+        <groupId>org.eclipse.jetty.ee10</groupId>
+        <artifactId>jetty-ee10-bom</artifactId>
+        <version>${jetty.version}</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
       <dependency>
         <groupId>org.junit</groupId>
         <artifactId>junit-bom</artifactId>

steve-core/pom.xml

@@ -58,6 +58,10 @@
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+    </dependency>
 
     <dependency>
       <groupId>com.google.guava</groupId>
@@ -67,5 +71,9 @@
       <groupId>com.neovisionaries</groupId>
       <artifactId>nv-i18n</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.eclipse.jetty.ee10</groupId>
+      <artifactId>jetty-ee10-webapp</artifactId>
+    </dependency>
   </dependencies>
 </project>

steve-core/src/main/java/de/rwth/idsg/steve/JettyCustomizer.java

@@ -0,0 +1,25 @@
+/*
+ * SteVe - SteckdosenVerwaltung - https://github.com/steve-community/steve
+ * Copyright (C) 2013-2025 SteVe Community Team
+ * All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package de.rwth.idsg.steve;
+
+import org.eclipse.jetty.ee10.webapp.WebAppContext;
+
+public interface JettyCustomizer {
+    void configure(WebAppContext ctx);
+}

steve-core/src/main/java/de/rwth/idsg/steve/SteveConfiguration.java

@@ -48,6 +48,14 @@ public static class Paths {
         private final String routerEndpointPath;
 
         private final @Nullable String contextPath;
+
+        public String getLocation() {
+            return contextPath + managerMapping + "/home";
+        }
+
+        public String getWsPathInfix() {
+            return routerEndpointPath + websocketMapping;
+        }
     }
 
     private final Paths paths;

steve-core/src/main/java/de/rwth/idsg/steve/utils/DateTimeUtils.java

@@ -28,7 +28,6 @@
 import java.time.OffsetDateTime;
 import java.time.ZoneId;
 import java.time.ZoneOffset;
-import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
 
 /**
@@ -149,9 +148,4 @@ public static String timeElapsed(Instant from, Instant to) {
 
         return sb.toString().trim();
     }
-
-    public static long getOffsetFromUtcInSeconds() {
-        var offset = ZonedDateTime.now().getOffset();
-        return offset.getTotalSeconds();
-    }
 }

…h/idsg/steve/utils/LogFileRetriever.java …h/idsg/steve/utils/LogFileRetriever.javasteve-ui-jsp/src/main/java/de/rwth/idsg/steve/utils/LogFileRetriever.java renamed to steve-core/src/main/java/de/rwth/idsg/steve/utils/LogFileRetriever.java steve-ui-jsp/src/main/java/de/rwth/idsg/steve/utils/LogFileRetriever.java renamed to steve-core/src/main/java/de/rwth/idsg/steve/utils/LogFileRetriever.java

@@ -19,6 +19,7 @@
 package de.rwth.idsg.steve.config;
 
 import com.google.common.collect.Lists;
+import de.rwth.idsg.steve.SteveConfiguration;
 import de.rwth.idsg.steve.ocpp.ws.OcppWebSocketHandshakeHandler;
 import de.rwth.idsg.steve.ocpp.ws.ocpp12.Ocpp12WebSocketEndpoint;
 import de.rwth.idsg.steve.ocpp.ws.ocpp15.Ocpp15WebSocketEndpoint;
@@ -45,13 +46,13 @@
 @RequiredArgsConstructor
 public class OcppWebSocketConfiguration implements WebSocketConfigurer {
 
-    public static final String PATH_INFIX = "/websocket/CentralSystemService/";
-    public static final Duration PING_INTERVAL = Duration.ofMinutes(15);
-    public static final Duration IDLE_TIMEOUT = Duration.ofHours(2);
-    public static final int MAX_MSG_SIZE = 8_388_608; // 8 MB for max message size
+    public static final Duration WS_PING_INTERVAL = Duration.ofMinutes(15);
+    public static final Duration WS_IDLE_TIMEOUT = Duration.ofHours(2);
+    public static final int WS_MAX_MSG_SIZE = 8_388_608; // 8 MB for max message size
 
     private final ChargePointRegistrationService chargePointRegistrationService;
     private final ChargeBoxIdValidator chargeBoxIdValidator;
+    private final SteveConfiguration config;
 
     private final Ocpp12WebSocketEndpoint ocpp12WebSocketEndpoint;
     private final Ocpp15WebSocketEndpoint ocpp15WebSocketEndpoint;
@@ -60,13 +61,16 @@ public class OcppWebSocketConfiguration implements WebSocketConfigurer {
     @Override
     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
 
-        OcppWebSocketHandshakeHandler handshakeHandler = new OcppWebSocketHandshakeHandler(
+        var handshakeHandler = new OcppWebSocketHandshakeHandler(
                 chargeBoxIdValidator,
                 new DefaultHandshakeHandler(),
                 Lists.newArrayList(ocpp16WebSocketEndpoint, ocpp15WebSocketEndpoint, ocpp12WebSocketEndpoint),
-                chargePointRegistrationService);
+                chargePointRegistrationService,
+                config.getPaths().getWsPathInfix() + "/");
 
-        registry.addHandler(handshakeHandler.getDummyWebSocketHandler(), PATH_INFIX + "*")
+        registry.addHandler(
+                        handshakeHandler.getDummyWebSocketHandler(),
+                        config.getPaths().getWsPathInfix() + "/*")
                 .setHandshakeHandler(handshakeHandler)
                 .setAllowedOrigins("*");
     }

steve-ocpp-websocket/src/main/java/de/rwth/idsg/steve/config/OcppWebSocketConfiguration.java

@@ -130,8 +130,8 @@ public void onOpen(WebSocketSession session) throws Exception {
         // the connection because of a idle timeout, we ping-pong at fixed intervals.
         var pingSchedule = asyncTaskScheduler.scheduleAtFixedRate(
                 new PingTask(chargeBoxId, session),
-                Instant.now().plus(OcppWebSocketConfiguration.PING_INTERVAL),
-                OcppWebSocketConfiguration.PING_INTERVAL);
+                Instant.now().plus(OcppWebSocketConfiguration.WS_PING_INTERVAL),
+                OcppWebSocketConfiguration.WS_PING_INTERVAL);
 
         futureResponseContextStore.addSession(session);
 

steve-ocpp-websocket/src/main/java/de/rwth/idsg/steve/ocpp/ws/AbstractWebSocketEndpoint.java

@@ -36,7 +36,7 @@
 public abstract class ConcurrentWebSocketHandler implements WebSocketHandler {
 
     private static final int SEND_TIME_LIMIT = (int) TimeUnit.SECONDS.toMillis(10);
-    private static final int BUFFER_SIZE_LIMIT = 5 * OcppWebSocketConfiguration.MAX_MSG_SIZE;
+    private static final int BUFFER_SIZE_LIMIT = 5 * OcppWebSocketConfiguration.WS_MAX_MSG_SIZE;
 
     private final Map<String, ConcurrentWebSocketSessionDecorator> sessions = new ConcurrentHashMap<>();
 

steve-ocpp-websocket/src/main/java/de/rwth/idsg/steve/ocpp/ws/ConcurrentWebSocketHandler.java

@@ -19,7 +19,6 @@
 package de.rwth.idsg.steve.ocpp.ws;
 
 import com.google.common.base.Strings;
-import de.rwth.idsg.steve.config.OcppWebSocketConfiguration;
 import de.rwth.idsg.steve.service.ChargePointRegistrationService;
 import de.rwth.idsg.steve.web.validation.ChargeBoxIdValidator;
 import lombok.RequiredArgsConstructor;
@@ -51,6 +50,7 @@ public class OcppWebSocketHandshakeHandler implements HandshakeHandler {
     private final DefaultHandshakeHandler delegate;
     private final List<AbstractWebSocketEndpoint> endpoints;
     private final ChargePointRegistrationService chargePointRegistrationService;
+    private final String wsPathInfix;
 
     /**
      * We need some WebSocketHandler just for Spring to register it for the path. We will not use it for the actual
@@ -73,7 +73,7 @@ public boolean doHandshake(
         // 1. Check the chargeBoxId
         // -------------------------------------------------------------------------
 
-        var chargeBoxId = getLastBitFromUrl(request.getURI().getPath());
+        var chargeBoxId = getLastBitFromUrl(wsPathInfix, request.getURI().getPath());
         var isValid = chargeBoxIdValidator.isValid(chargeBoxId);
         if (!isValid) {
             log.error("ChargeBoxId '{}' violates the configured pattern.", chargeBoxId);
@@ -133,17 +133,15 @@ public boolean doHandshake(
         return null;
     }
 
-    public static String getLastBitFromUrl(final String input) {
+    public static String getLastBitFromUrl(String path, String input) {
         if (Strings.isNullOrEmpty(input)) {
             return "";
         }
 
-        var substring = OcppWebSocketConfiguration.PATH_INFIX;
-
-        var index = input.indexOf(substring);
+        var index = input.indexOf(path);
         if (index == -1) {
             return "";
         }
-        return input.substring(index + substring.length());
+        return input.substring(index + path.length());
     }
 }