[JENKINS-72107] Introduce Loadable interface

core/src/main/java/hudson/Plugin.java

@@ -44,6 +44,7 @@
 import javax.servlet.http.HttpServletResponse;
 import jenkins.model.GlobalConfiguration;
 import jenkins.model.Jenkins;
+import jenkins.model.Loadable;
 import jenkins.util.SystemProperties;
 import net.sf.json.JSONObject;
 import org.kohsuke.accmod.Restricted;
@@ -84,7 +85,7 @@
  * @author Kohsuke Kawaguchi
  * @since 1.42
  */
-public abstract class Plugin implements Saveable, StaplerProxy {
+public abstract class Plugin implements Loadable, Saveable, StaplerProxy {
 
     private static final Logger LOGGER = Logger.getLogger(Plugin.class.getName());
 
@@ -265,7 +266,8 @@ public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws IOExceptio
      *
      * @since 1.245
      */
-    protected void load() throws IOException {
+    @Override
+    public void load() throws IOException {
         XmlFile xml = getConfigXml();
         if (xml.exists())
             xml.unmarshal(this);

core/src/main/java/hudson/logging/LogRecorder.java

@@ -73,6 +73,7 @@
 import java.util.logging.Logger;
 import javax.servlet.ServletException;
 import jenkins.model.Jenkins;
+import jenkins.model.Loadable;
 import jenkins.security.MasterToSlaveCallable;
 import jenkins.util.MemoryReductionUtil;
 import net.sf.json.JSONObject;
@@ -99,7 +100,7 @@
  * @author Kohsuke Kawaguchi
  * @see LogRecorderManager
  */
-public class LogRecorder extends AbstractModelObject implements Saveable {
+public class LogRecorder extends AbstractModelObject implements Loadable, Saveable {
     private volatile String name;
 
     /**
@@ -476,6 +477,7 @@ public HttpResponse doClear() throws IOException {
     /**
      * Loads the settings from a file.
      */
+    @Override
     public synchronized void load() throws IOException {
         getConfigFile().unmarshal(this);
         loggers.forEach(Target::enable);

core/src/main/java/hudson/model/AbstractItem.java

@@ -76,6 +76,7 @@
 import javax.xml.transform.stream.StreamSource;
 import jenkins.model.DirectlyModifiableTopLevelItemGroup;
 import jenkins.model.Jenkins;
+import jenkins.model.Loadable;
 import jenkins.model.queue.ItemDeletion;
 import jenkins.security.NotReallyRoleSensitiveCallable;
 import jenkins.util.SystemProperties;
@@ -111,7 +112,7 @@
 // Item doesn't necessarily have to be Actionable, but
 // Java doesn't let multiple inheritance.
 @ExportedBean
-public abstract class AbstractItem extends Actionable implements Item, HttpDeletable, AccessControlled, DescriptorByNameOwner, StaplerProxy {
+public abstract class AbstractItem extends Actionable implements Loadable, Item, HttpDeletable, AccessControlled, DescriptorByNameOwner, StaplerProxy {
 
     private static final Logger LOGGER = Logger.getLogger(AbstractItem.class.getName());
 
@@ -934,6 +935,11 @@ public void updateByXml(Source source) throws IOException {
      */
     @RequirePOST
     public void doReload() throws IOException {
+        load();
+    }
+
+    @Override
+    public void load() throws IOException {
         checkPermission(CONFIGURE);
 
         // try to reflect the changes by reloading

core/src/main/java/hudson/model/Descriptor.java

@@ -75,6 +75,7 @@
 import jenkins.model.GlobalConfiguration;
 import jenkins.model.GlobalConfigurationCategory;
 import jenkins.model.Jenkins;
+import jenkins.model.Loadable;
 import jenkins.security.RedactSecretJsonInErrorMessageSanitizer;
 import jenkins.util.io.OnMaster;
 import net.sf.json.JSONArray;
@@ -143,7 +144,7 @@
  * @author Kohsuke Kawaguchi
  * @see Describable
  */
-public abstract class Descriptor<T extends Describable<T>> implements Saveable, OnMaster {
+public abstract class Descriptor<T extends Describable<T>> implements Loadable, Saveable, OnMaster {
     /**
      * The class being described by this descriptor.
      */
@@ -924,6 +925,7 @@ public synchronized void save() {
      * (If we do that in the base class, the derived class won't
      * get a chance to set default values.)
      */
+    @Override
     public synchronized void load() {
         XmlFile file = getConfigFile();
         if (!file.exists())

core/src/main/java/hudson/model/PersistentDescriptor.java

@@ -1,6 +1,7 @@
 package hudson.model;
 
 import jakarta.annotation.PostConstruct;
+import jenkins.model.Loadable;
 
 /**
  * Marker interface for Descriptors which use xml persistent data, and as such need to load from disk when instantiated.
@@ -10,8 +11,9 @@
  * @author <a href="mailto:[email protected]">Nicolas De Loof</a>
  * @since 2.140
  */
-public interface PersistentDescriptor extends Saveable {
+public interface PersistentDescriptor extends Loadable, Saveable {
 
     @PostConstruct
+    @Override
     void load();
 }

core/src/main/java/hudson/model/UpdateCenter.java

@@ -108,6 +108,7 @@
 import jenkins.install.InstallUtil;
 import jenkins.management.Badge;
 import jenkins.model.Jenkins;
+import jenkins.model.Loadable;
 import jenkins.security.stapler.StaplerDispatchable;
 import jenkins.util.SystemProperties;
 import jenkins.util.Timer;
@@ -154,7 +155,7 @@
  * @since 1.220
  */
 @ExportedBean
-public class UpdateCenter extends AbstractModelObject implements Saveable, OnMaster, StaplerProxy {
+public class UpdateCenter extends AbstractModelObject implements Loadable, Saveable, OnMaster, StaplerProxy {
 
     private static final Logger LOGGER;
     private static final String UPDATE_CENTER_URL;
@@ -984,6 +985,7 @@ public synchronized void save() {
     /**
      * Loads the data from the disk into this object.
      */
+    @Override
     public synchronized void load() throws IOException {
         XmlFile file = getConfigFile();
         if (file.exists()) {

core/src/main/java/hudson/model/User.java

@@ -70,6 +70,7 @@
 import javax.servlet.http.HttpServletResponse;
 import jenkins.model.IdStrategy;
 import jenkins.model.Jenkins;
+import jenkins.model.Loadable;
 import jenkins.model.ModelObjectWithContextMenu;
 import jenkins.scm.RunWithSCM;
 import jenkins.security.ImpersonatingUserDetailsService2;
@@ -120,7 +121,7 @@
  * @author Kohsuke Kawaguchi
  */
 @ExportedBean
-public class User extends AbstractModelObject implements AccessControlled, DescriptorByNameOwner, Saveable, Comparable<User>, ModelObjectWithContextMenu, StaplerProxy {
+public class User extends AbstractModelObject implements AccessControlled, DescriptorByNameOwner, Loadable, Saveable, Comparable<User>, ModelObjectWithContextMenu, StaplerProxy {
 
     public static final XStream2 XSTREAM = new XStream2();
     private static final Logger LOGGER = Logger.getLogger(User.class.getName());
@@ -191,6 +192,11 @@
         load(id);
     }
 
+    @Override
+    public void load() {
+        load(id);
+    }
+
     private void load(String userId) {
         clearExistingProperties();
         loadFromUserConfigFile(userId);

core/src/main/java/jenkins/model/Jenkins.java

@@ -344,7 +344,7 @@
 @ExportedBean
 public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLevelItemGroup, StaplerProxy, StaplerFallback,
         ModifiableViewGroup, AccessControlled, DescriptorByNameOwner,
-        ModelObjectWithContextMenu, ModelObjectWithChildren, OnMaster {
+        ModelObjectWithContextMenu, ModelObjectWithChildren, OnMaster, Loadable {
     private final transient Queue queue;
 
     // flag indicating if we have loaded the jenkins configuration or not yet.
@@ -3367,7 +3367,8 @@ public Computer createComputer() {
         return new Hudson.MasterComputer();
     }
 
-    private void loadConfig() throws IOException {
+    @Override
+    public void load() throws IOException {
         XmlFile cfg = getConfigFile();
         if (cfg.exists()) {
             // reset some data that may not exist in the disk file
@@ -3488,7 +3489,7 @@ private synchronized TaskBuilder loadTasks() throws IOException {
         Handle loadJenkins = g.requires(EXTENSIONS_AUGMENTED).attains(SYSTEM_CONFIG_LOADED).add("Loading global config", new Executable() {
             @Override
             public void run(Reactor session) throws Exception {
-                loadConfig();
+                load();
                 // if we are loading old data that doesn't have this field
                 if (slaves != null && !slaves.isEmpty() && nodes.isLegacy()) {
                     nodes.setNodes(slaves);

core/src/main/java/jenkins/model/Loadable.java

@@ -0,0 +1,19 @@
+package jenkins.model;
+
+import hudson.model.Saveable;
+import java.io.IOException;
+
+/**
+ * Object whose state can be loaded from disk. In general, also implements {@link Saveable}.
+ *
+ * @since TODO
+ */
+public interface Loadable {
+
+    /**
+     * Loads the state of this object from disk.
+     *
+     * @throws IOException The state could not be loaded.
+     */
+    void load() throws IOException;
+}