Merge pull request #1820 from steve-community/1819-migrate-to-spring-boot-refactor-as-preparation

Prep for Spring Boot migration

Author: goekay

pom.xml

@@ -518,6 +518,12 @@
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
             <version>2.8.13</version>
+            <exclusions>
+                <exclusion>
+                    <artifactId>tomcat-embed-el</artifactId>
+                    <groupId>org.apache.tomcat.embed</groupId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <dependency>
@@ -529,11 +535,21 @@
             <groupId>com.github.steve-community</groupId>
             <artifactId>ocpp-jaxb</artifactId>
             <version>0.0.9</version>
+            <exclusions>
+                <exclusion>
+                    <artifactId>jakarta.activation</artifactId>
+                    <groupId>com.sun.activation</groupId>
+                </exclusion>
+                <exclusion>
+                    <artifactId>jakarta.activation-api</artifactId>
+                    <groupId>jakarta.activation</groupId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
-            <groupId>com.sun.mail</groupId>
-            <artifactId>jakarta.mail</artifactId>
-            <version>2.0.2</version>
+            <groupId>jakarta.mail</groupId>
+            <artifactId>jakarta.mail-api</artifactId>
+            <version>2.1.3</version>
         </dependency>
         <dependency>
             <groupId>org.jetbrains</groupId>

src/main/java/de/rwth/idsg/steve/JettyServer.java

@@ -19,36 +19,25 @@
 package de.rwth.idsg.steve;
 
 import lombok.extern.slf4j.Slf4j;
+import org.eclipse.jetty.ee10.webapp.WebAppContext;
 import org.eclipse.jetty.http.HttpScheme;
 import org.eclipse.jetty.http.HttpVersion;
-import org.eclipse.jetty.server.Connector;
 import org.eclipse.jetty.server.ForwardedRequestCustomizer;
+import org.eclipse.jetty.server.Handler;
 import org.eclipse.jetty.server.HttpConfiguration;
 import org.eclipse.jetty.server.HttpConnectionFactory;
 import org.eclipse.jetty.server.SecureRequestCustomizer;
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.server.ServerConnector;
 import org.eclipse.jetty.server.SslConnectionFactory;
+import org.eclipse.jetty.server.handler.gzip.GzipHandler;
 import org.eclipse.jetty.util.ssl.SslContextFactory;
 import org.eclipse.jetty.util.thread.QueuedThreadPool;
 import org.eclipse.jetty.util.thread.ScheduledExecutorScheduler;
+import org.springframework.core.io.ClassPathResource;
 
-import java.net.DatagramSocket;
-import java.net.Inet4Address;
-import java.net.InetAddress;
-import java.net.InetSocketAddress;
-import java.net.NetworkInterface;
-import java.net.Socket;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Enumeration;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
+import java.io.IOException;
 import java.util.concurrent.TimeUnit;
-import java.util.stream.Collectors;
 
 import static de.rwth.idsg.steve.SteveConfiguration.CONFIG;
 
@@ -60,18 +49,21 @@
 public class JettyServer {
 
     private Server server;
-    private SteveAppContext steveAppContext;
 
     private static final int MIN_THREADS = 4;
     private static final int MAX_THREADS = 50;
 
     private static final long STOP_TIMEOUT = TimeUnit.SECONDS.toMillis(5);
     private static final long IDLE_TIMEOUT = TimeUnit.MINUTES.toMillis(1);
 
+    // scan all jars in the classpath for ServletContainerInitializers
+    // (e.g. Spring's WebApplicationInitializer)
+    private static final String SCAN_PATTERN = ".*\\.jar$|.*/classes/.*";
+
     /**
      * A fully configured Jetty Server instance
      */
-    private void prepare() {
+    private void prepare() throws IOException {
 
         // === jetty.xml ===
         // Setup Threadpool
@@ -114,8 +106,7 @@ private void prepare() {
             server.addConnector(httpsConnector(httpConfig));
         }
 
-        steveAppContext = new SteveAppContext();
-        server.setHandler(steveAppContext.getHandlers());
+        server.setHandler(getWebApp());
     }
 
     private ServerConnector httpConnector(HttpConfiguration httpConfig) {
@@ -149,6 +140,35 @@ private ServerConnector httpsConnector(HttpConfiguration httpConfig) {
         return https;
     }
 
+    private Handler getWebApp() throws IOException {
+        var webAppContext = new WebAppContext();
+        webAppContext.setContextPath(CONFIG.getContextPath());
+        webAppContext.setBaseResourceAsString(new ClassPathResource("webapp").getURI().toString());
+
+        // if during startup an exception happens, do not swallow it, throw it
+        webAppContext.setThrowUnavailableOnStartupException(true);
+
+        // Disable directory listings if no index.html is found.
+        webAppContext.setInitParameter("org.eclipse.jetty.servlet.Default.dirAllowed", "false");
+
+        // Crucial for Spring's WebApplicationInitializer to be discovered
+        // and for the DispatcherServlet to be initialized.
+        // It tells Jetty to scan for classes implementing WebApplicationInitializer.
+        // The pattern ensures that Jetty finds the Spring classes in the classpath.
+        //
+        // https://jetty.org/docs/jetty/12.1/programming-guide/maven-jetty/jetty-maven-plugin.html
+        // https://jetty.org/docs/jetty/12.1/operations-guide/annotations/index.html#og-container-include-jar-pattern
+        webAppContext.setAttribute("org.eclipse.jetty.server.webapp.ContainerIncludeJarPattern", SCAN_PATTERN);
+
+        if (CONFIG.getJetty().isGzipEnabled()) {
+            // Wraps the whole web app in a gzip handler to make Jetty return compressed content
+            // http://www.eclipse.org/jetty/documentation/current/gzip-filter.html
+            return new GzipHandler(webAppContext);
+        } else {
+            return webAppContext;
+        }
+    }
+
     /**
      * Starts the Jetty Server instance
      */
@@ -157,8 +177,6 @@ public void start() throws Exception {
 
         if (server != null) {
             server.start();
-            steveAppContext.configureWebSocket();
-            populateEndpointInfo();
         }
     }
 
@@ -176,124 +194,4 @@ public void stop() throws Exception {
             server.stop();
         }
     }
-
-    public boolean isStarted() {
-        return server != null && server.isStarted();
-    }
-
-    public void populateEndpointInfo() {
-        List<String> list = getConnectorPathList();
-
-//        EndpointInfo info = EndpointInfo.INSTANCE;
-//
-//        info.getWebInterface().setData(buildList(list, false));
-//        info.getOcppSoap().setData(buildList(list, false));
-//        info.getOcppWebSocket().setData(buildList(list, true));
-    }
-
-    private List<String> getConnectorPathList() {
-        if (server == null) {
-            return Collections.emptyList();
-        }
-
-        return Arrays.stream(server.getConnectors())
-                     .map(JettyServer::getConnectorPath)
-                     .flatMap(Collection::stream)
-                     .collect(Collectors.toList());
-    }
-
-    private static List<String> getConnectorPath(Connector c) {
-        ServerConnector sc = (ServerConnector) c;
-
-        final String prefix;
-        if (sc.getDefaultConnectionFactory() instanceof SslConnectionFactory) {
-            prefix = "https";
-        } else {
-            prefix = "http";
-        }
-
-        Set<String> ips = new HashSet<>();
-        String host = sc.getHost();
-        if (host == null || host.equals("0.0.0.0")) {
-            ips.addAll(getPossibleIpAddresses());
-        } else {
-            ips.add(host);
-        }
-
-        String layout = "%s://%s:%d" + CONFIG.getContextPath();
-
-        return ips.stream()
-                  .map(k -> String.format(layout, prefix, k, sc.getPort()))
-                  .collect(Collectors.toList());
-    }
-
-    private List<String> buildList(List<String> list, boolean replaceHttp) {
-        return list.stream()
-                   .map(s -> getElementPrefix(s, replaceHttp))
-                   .collect(Collectors.toList());
-    }
-
-    private String getElementPrefix(String str, boolean replaceHttp) {
-        if (replaceHttp) {
-            return str.replaceFirst("http", "ws");
-        } else {
-            return str;
-        }
-    }
-
-    /**
-     * Uses different APIs to find out the IP of this machine.
-     */
-    private static List<String> getPossibleIpAddresses() {
-        final String host = "treibhaus.informatik.rwth-aachen.de";
-        final List<String> ips = new ArrayList<>();
-
-        try {
-            ips.add(InetAddress.getLocalHost().getHostAddress());
-        } catch (Exception e) {
-            // fail silently
-        }
-
-        try {
-            Socket socket = new Socket();
-            socket.connect(new InetSocketAddress(host, 80));
-            ips.add(socket.getLocalAddress().getHostAddress());
-        } catch (Exception e) {
-            // fail silently
-        }
-
-        // https://stackoverflow.com/a/38342964
-        try (DatagramSocket socket = new DatagramSocket()) {
-            socket.connect(InetAddress.getByName("8.8.8.8"), 10002);
-            ips.add(socket.getLocalAddress().getHostAddress());
-        } catch (Exception e) {
-            // fail silently
-        }
-
-        // https://stackoverflow.com/a/20418809
-        try {
-            for (Enumeration<NetworkInterface> ifaces = NetworkInterface.getNetworkInterfaces(); ifaces.hasMoreElements();) {
-                NetworkInterface iface = ifaces.nextElement();
-                for (Enumeration<InetAddress> inetAddrs = iface.getInetAddresses(); inetAddrs.hasMoreElements();) {
-                    InetAddress inetAddr = inetAddrs.nextElement();
-                    if (!inetAddr.isLoopbackAddress() && (inetAddr instanceof Inet4Address)) {
-                        ips.add(inetAddr.getHostAddress());
-                    }
-                }
-            }
-
-        } catch (Exception e) {
-            // fail silently
-        }
-
-        ips.removeIf("0.0.0.0"::equals);
-
-        if (ips.isEmpty()) {
-            // Well, we failed to read from system, fall back to application.properties.
-            // Better than nothing
-            ips.add(CONFIG.getJetty().getServerHost());
-        }
-
-        return ips;
-    }
 }