Issue #10437 - Unify Deployer ContextProvider

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,28 @@
 
   <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>
         <artifactId>maven-surefire-plugin</artifactId>
         <configuration>

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

@@ -2,30 +2,43 @@
 <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "https://jetty.org/configure_10_0.dtd">
 
 <!-- =============================================================== -->
-<!-- Create the deployment manager                                   -->
-<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-<!-- The deplyment manager handles the lifecycle of deploying web    -->
-<!-- applications. Apps are provided by instances of the             -->
-<!-- AppProvider interface.                                          -->
+<!-- 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="Server" class="org.eclipse.jetty.server.Server">
-  <Call name="addBean">
+<Configure id="defaultDeployer" class="org.eclipse.jetty.deploy.providers.DefaultProvider">
+  <Call name="addMonitoredDirectory">
     <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 AppLifeCycle.Binding class
-        <Call name="insertLifeCycleNode">
-          <Arg>deployed</Arg>
-          <Arg>starting</Arg>
-          <Arg>customise</Arg>
-        </Call>
-         -->
-
-      </New>
+      <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" />
+
+  <Ref refid="DeploymentManager">
+    <Call name="addAppProvider">
+      <Arg>
+        <Ref refid="defaultDeployer" />
+      </Arg>
+    </Call>
+  </Ref>
 </Configure>

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

@@ -0,0 +1,29 @@
+<?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. Apps are provided by instances of the             -->
+<!-- AppProvider interface.                                          -->
+<!-- =============================================================== -->
+<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 AppLifeCycle.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/modules/deploy.mod

@@ -1,8 +1,9 @@
 [description]
-This module enables web application deployment from the `$JETTY_BASE/webapps` directory.
+This module enables web application context deployment from the `$JETTY_BASE/webapps` directory.
 
 [depend]
 server
+deployment-manager
 
 [lib]
 lib/jetty-deploy-${jetty.version}.jar
@@ -13,3 +14,15 @@ webapps/
 [xml]
 etc/jetty-deploy.xml
 
+[ini-template]
+## Monitored directory name (relative to $jetty.base)
+# jetty.deploy.monitoredDir=webapps
+
+# Defer Initial Scan
+# true to have the initial scan deferred until the Server component is started.
+#      Note: deploy failures do not fail server startup in a deferred initial scan mode.
+# false (default) to have initial scan occur as normal.
+# jetty.deploy.deferInitialScan=false
+
+## Monitored directory scan period (seconds)
+# jetty.deploy.scanInterval=0

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

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

jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/App.java

@@ -13,136 +13,24 @@
 
 package org.eclipse.jetty.deploy;
 
-import java.io.InputStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Properties;
-
-import org.eclipse.jetty.server.Deployable;
 import org.eclipse.jetty.server.handler.ContextHandler;
-import org.eclipse.jetty.util.FileID;
 
 /**
- * The information about an App that is managed by the {@link DeploymentManager}.
+ * An abstract App, the component that moves through the DeploymentManager.
  */
-public class App
+public interface App
 {
-    private final DeploymentManager _manager;
-    private final AppProvider _provider;
-    private final Path _path;
-    private final Map<String, String> _properties = new HashMap<>();
-    private ContextHandler _context;
-
-    /**
-     * Create an App with specified Origin ID and archivePath
-     * <p>
-     * Any properties file that exists with the same {@link FileID#getBasename(Path)} as the
-     * filename passed will be used to initialize the properties returned by {@link #getProperties()}.
-     * @param manager the deployment manager
-     * @param provider the app provider
-     * @param path the path to the application directory, war file or XML descriptor
-     * @see App#getContextPath()
-     */
-    public App(DeploymentManager manager, AppProvider provider, Path path)
-    {
-        _manager = manager;
-        _provider = provider;
-        _path = path;
-
-        try
-        {
-            String basename = FileID.getBasename(path);
-            Path properties = path.getParent().resolve(basename + ".properties");
-            if (Files.exists(properties))
-            {
-                try (InputStream stream = Files.newInputStream(properties))
-                {
-                    Properties p = new Properties();
-                    p.load(stream);
-                    p.stringPropertyNames().forEach(k -> _properties.put(k, p.getProperty(k)));
-                }
-            }
-        }
-        catch (Exception e)
-        {
-            throw new RuntimeException(e);
-        }
-    }
-
-    /**
-     * @return The deployment manager
-     */
-    public DeploymentManager getDeploymentManager()
-    {
-        return _manager;
-    }
-
-    /**
-     * @return The AppProvider
-     */
-    public AppProvider getAppProvider()
-    {
-        return _provider;
-    }
-
-    public Map<String, String> getProperties()
-    {
-        return _properties;
-    }
-
     /**
-     * Get ContextHandler for the App.
-     *
-     * Create it if needed.
+     * The application name.
      *
-     * @return the {@link ContextHandler} to use for the App when fully started.
-     * (Portions of which might be ignored when App is not yet
-     * {@link AppLifeCycle#DEPLOYED} or {@link AppLifeCycle#STARTED})
-     * @throws Exception if unable to get the context handler
+     * @return the application name.
      */
-    public ContextHandler getContextHandler() throws Exception
-    {
-        if (_context == null)
-            _context = getAppProvider().createContextHandler(this);
-        return _context;
-    }
+    String getName();
 
     /**
-     * The context path {@link App} relating to how it is installed on the
-     * jetty server side.
+     * Get the active ContextHandler for this App.
      *
-     * @return the contextPath for the App
-     */
-    public String getContextPath()
-    {
-        return _context == null ? null : _context.getContextPath();
-    }
-
-    /**
-     * Get the environment name.
-     * @return The {@link org.eclipse.jetty.util.component.Environment} name for the application
-     * if set with the {@link Deployable#ENVIRONMENT} property, else null.
+     * @return the ContextHandler for the App.  null means the ContextHandler hasn't been created yet.
      */
-    public String getEnvironmentName()
-    {
-        return getProperties().get(Deployable.ENVIRONMENT);
-    }
-
-    /**
-     * The origin of this {@link App} as specified by the {@link AppProvider}
-     *
-     * @return String representing the origin of this app.
-     */
-    public Path getPath()
-    {
-        return _path;
-    }
-
-    @Override
-    public String toString()
-    {
-        return "App@%x[%s,%s,%s]".formatted(hashCode(), getEnvironmentName(), _context, _path);
-    }
+    ContextHandler getContextHandler();
 }