Lifecycle.supportsDynamicLoad (#9013)

jenkinsci · Mar 10, 2024 · 46b0db7 · 46b0db7
1 parent 2dca2b1
commit 46b0db7
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/core/src/main/java/hudson/PluginManager.java b/core/src/main/java/hudson/PluginManager.java
@@ -41,6 +41,7 @@
 import hudson.init.InitMilestone;
 import hudson.init.InitStrategy;
 import hudson.init.InitializerFinder;
+import hudson.lifecycle.Lifecycle;
 import hudson.model.AbstractItem;
 import hudson.model.AbstractModelObject;
 import hudson.model.AdministrativeMonitor;
@@ -924,6 +925,9 @@ public void dynamicLoad(File arc, boolean removeExisting, @CheckForNull List<Plu
                     throw new RestartRequiredException(Messages._PluginManager_PluginIsAlreadyInstalled_RestartRequired(sn));
                 }
             }
+            if (!Lifecycle.get().supportsDynamicLoad()) {
+                throw new RestartRequiredException(Messages._PluginManager_LifecycleDoesNotSupportDynamicLoad_RestartRequired());
+            }
             if (p == null) {
                 p = strategy.createPluginWrapper(arc);
             }

diff --git a/core/src/main/java/hudson/lifecycle/Lifecycle.java b/core/src/main/java/hudson/lifecycle/Lifecycle.java
@@ -28,6 +28,7 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.ExtensionPoint;
 import hudson.Functions;
+import hudson.PluginManager;
 import hudson.Util;
 import hudson.init.InitMilestone;
 import hudson.init.Initializer;
@@ -39,10 +40,12 @@
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import jenkins.RestartRequiredException;
 import jenkins.model.Jenkins;
 import jenkins.util.SystemProperties;
 import org.apache.commons.io.FileUtils;
 import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.Beta;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 
 /**
@@ -310,6 +313,17 @@ public void onStatusUpdate(String status) {
         LOGGER.log(Level.INFO, status);
     }
 
+    /**
+     * Whether {@link PluginManager#dynamicLoad(File)} should be supported at all.
+     * If not, {@link RestartRequiredException} will always be thrown.
+     * @return true by default
+     * @since TODO
+     */
+    @Restricted(Beta.class)
+    public boolean supportsDynamicLoad() {
+        return true;
+    }
+
     @Restricted(NoExternalUse.class)
     public static final class PlaceholderLifecycle extends ExitLifecycle {
 

diff --git a/core/src/main/resources/hudson/Messages.properties b/core/src/main/resources/hudson/Messages.properties
@@ -37,6 +37,7 @@ FilePath.validateRelativePath.notDirectory=‘{0}’ is not a directory
 FilePath.validateRelativePath.noSuchFile=No such file: ‘{0}’
 FilePath.validateRelativePath.noSuchDirectory=No such directory: ‘{0}’
 
+PluginManager.LifecycleDoesNotSupportDynamicLoad.RestartRequired=This Jenkins lifecycle does not support dynamic loading of plugins. Jenkins needs to be restarted for the update to take effect.
 PluginManager.PluginDoesntSupportDynamicLoad.RestartRequired={0} plugin doesn’t support dynamic loading. Jenkins needs to be restarted for the update to take effect.
 PluginManager.PluginIsAlreadyInstalled.RestartRequired={0} plugin is already installed. Jenkins needs to be restarted for the update to take effect.
 Util.millisecond={0} ms