Issue #10437 - Refactor Local Deployment Scanning

jetty-core/jetty-deploy/pom.xml

@@ -44,6 +44,15 @@
       <artifactId>jetty-slf4j-impl</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <!-- Using as ZIP to avoid having classes and dependencies live in test classloader -->
+      <groupId>org.eclipse.jetty</groupId>
+      <artifactId>jetty-test-core-example-webapp</artifactId>
+      <version>${project.version}</version>
+      <classifier>core-webapp</classifier>
+      <type>zip</type>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.eclipse.jetty.toolchain</groupId>
       <artifactId>jetty-test-helper</artifactId>
@@ -53,6 +62,35 @@
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-dependency-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>copy-core-webapps</id>
+            <goals>
+              <goal>copy-dependencies</goal>
+            </goals>
+            <phase>generate-resources</phase>
+            <configuration>
+              <includeClassifiers>core-webapp</includeClassifiers>
+              <includeTypes>zip</includeTypes>
+              <outputDirectory>${project.build.directory}/core-webapps/</outputDirectory>
+              <overWriteReleases>false</overWriteReleases>
+              <overWriteSnapshots>true</overWriteSnapshots>
+              <stripClassifier>true</stripClassifier>
+              <stripVersion>true</stripVersion>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <configuration>
+          <excludePackageNames>*.internal,*.internal.*</excludePackageNames>
+        </configuration>
+      </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
         <configuration>

jetty-core/jetty-deploy/src/main/config/etc/jetty-deployment-manager.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0"?><!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "https://jetty.org/configure_10_0.dtd">
+
+<!-- =============================================================== -->
+<!-- Create the deployment manager                                   -->
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<!-- The deployment manager handles the lifecycle of deploying web   -->
+<!-- applications via instances of ContextHandler.                   -->
+<!-- =============================================================== -->
+<Configure id="Server" class="org.eclipse.jetty.server.Server">
+  <Call name="addBean">
+    <Arg>
+      <New id="deploymentManager" class="org.eclipse.jetty.deploy.DeploymentManager">
+        <Set name="contexts">
+          <Ref refid="Contexts" />
+        </Set>
+
+        <!-- Add a customize step to the deployment lifecycle -->
+        <!-- uncomment and replace DebugBinding with your extended ContextHandlerLifeCycle.Binding class
+        <Call name="insertLifeCycleNode">
+          <Arg>deployed</Arg>
+          <Arg>starting</Arg>
+          <Arg>customise</Arg>
+        </Call>
+         -->
+      </New>
+    </Arg>
+  </Call>
+</Configure>

jetty-core/jetty-deploy/src/main/config/etc/jetty-deployment-scanner.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0"?>
+<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "https://jetty.org/configure_10_0.dtd">
+
+<!-- =============================================================== -->
+<!-- Create Default Deployment Provider                              -->
+<!--                                                                 -->
+<!-- The Default Deployment Provider is responsible for monitoring   -->
+<!-- provided directories for web applications and hot deploying     -->
+<!-- through the DeploymentManager.                                  -->
+<!-- =============================================================== -->
+<Configure id="deploymentScanner" class="org.eclipse.jetty.deploy.DeploymentScanner">
+  <Arg name="server">
+    <Ref refid="Server" />
+  </Arg>
+  <Arg name="deploymentManager">
+    <Ref refid="deploymentManager" />
+  </Arg>
+  <Call name="addMonitoredDirectory">
+    <Arg>
+      <Call name="resolvedPath" class="org.eclipse.jetty.xml.XmlConfiguration">
+        <Arg>
+          <Property name="jetty.base" />
+        </Arg>
+        <Arg>
+          <Property name="jetty.deploy.monitoredDir" default="webapps" />
+        </Arg>
+      </Call>
+    </Arg>
+  </Call>
+  <Set name="environmentsDirectory">
+    <Call name="resolvedPath" class="org.eclipse.jetty.xml.XmlConfiguration">
+      <Arg>
+        <Property name="jetty.base" />
+      </Arg>
+      <Arg>
+        <Property name="jetty.deploy.environmentsDir" default="environments" />
+      </Arg>
+    </Call>
+  </Set>
+  <Set name="deferInitialScan" property="jetty.deploy.deferInitialScan" />
+  <Set name="scanInterval" property="jetty.deploy.scanInterval" />
+</Configure>

jetty-core/jetty-deploy/src/main/config/modules/deploy.mod

@@ -1,15 +1,13 @@
 [description]
-This module enables web application deployment from the `$JETTY_BASE/webapps` directory.
+Deprecated `deploy` module (does nothing on its own)
 
-[depend]
-server
+[deprecated]
+Module 'deploy' is deprecated and does nothing on its own.
+Use one of the environment specific modules '<env>-deploy' instead.
 
-[lib]
-lib/jetty-deploy-${jetty.version}.jar
-
-[files]
-webapps/
-
-[xml]
-etc/jetty-deploy.xml
+[tags]
+deployment
+deprecated
 
+[depends]
+deployment/deployment-scanner

jetty-core/jetty-deploy/src/main/config/modules/deployment/deployment-manager.mod

@@ -0,0 +1,15 @@
+[description]
+This module enables the DeploymentManager
+
+[tags]
+deployment
+
+[depend]
+server
+
+[lib]
+lib/jetty-deploy-${jetty.version}.jar
+
+[xml]
+etc/jetty-deployment-manager.xml
+

jetty-core/jetty-deploy/src/main/config/modules/core-deploy.mod → jetty-core/jetty-deploy/src/main/config/modules/deployment/deployment-scanner.mod

@@ -1,22 +1,21 @@
 [description]
-Enables application based on core handlers deployed from the $JETTY_BASE/webapps/ directory.
+This module enables web application context scanning of the `$JETTY_BASE/webapps` directory.
 
-[environment]
-core
+[tags]
+deployment
 
 [depend]
-deploy
+server
+deployment/deployment-manager
 
 [lib]
+lib/jetty-deploy-${jetty.version}.jar
 
 [files]
 webapps/
 
 [xml]
-etc/jetty-core-deploy.xml
-
-[ini]
-contextHandlerClass?=org.eclipse.jetty.server.handler.ResourceHandler$ResourceContext
+etc/jetty-deployment-scanner.xml
 
 [ini-template]
 ## Monitored directory name (relative to $jetty.base)
@@ -30,6 +29,3 @@ contextHandlerClass?=org.eclipse.jetty.server.handler.ResourceHandler$ResourceCo
 
 ## Monitored directory scan period (seconds)
 # jetty.deploy.scanInterval=0
-
-## Default ContextHandler class for core deployments
-# contextHandlerClass=org.eclipse.jetty.server.handler.ResourceHandler$ResourceContext

jetty-core/jetty-deploy/src/main/java/module-info.java

@@ -15,6 +15,7 @@
 {
     requires java.xml;
     requires org.eclipse.jetty.xml;
+    requires transitive org.eclipse.jetty.util;
     requires transitive org.eclipse.jetty.server;
     requires org.slf4j;
 
@@ -23,9 +24,8 @@
 
     exports org.eclipse.jetty.deploy;
     exports org.eclipse.jetty.deploy.bindings;
-    exports org.eclipse.jetty.deploy.graph;
-    exports org.eclipse.jetty.deploy.providers;
 
     exports org.eclipse.jetty.deploy.jmx to
         org.eclipse.jetty.jmx;
+    exports org.eclipse.jetty.deploy.internal;
 }