Package jenkins.install

Class SetupWizard

java.lang.Object
hudson.model.Descriptor<PageDecorator>
hudson.model.PageDecorator
jenkins.install.SetupWizard
All Implemented Interfaces:
ExtensionPoint, Describable<PageDecorator>, Saveable, Loadable, OnMaster
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) @Extension public class SetupWizard extends PageDecorator
A Jenkins instance used during first-run to provide a limited set of services while initial installation is in progress
Since:
2.0

  • Field Details

    • initialSetupAdminUserName

      public static String initialSetupAdminUserName
      The security token parameter name

  • Constructor Details

    • SetupWizard

      public SetupWizard()

  • Method Details

    • getDisplayName

      @NonNull public String getDisplayName()
      Description copied from class: Descriptor
      Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses Class.getSimpleName() on Descriptor.clazz, so for example MyThing from some.pkg.MyThing.DescriptorImpl. Historically some implementations returned null as a way of hiding the descriptor from the UI, but this is generally managed by an explicit method such as isEnabled or isApplicable.
      Overrides:
      getDisplayName in class Descriptor<PageDecorator>

    • isUsingSecurityToken

      public boolean isUsingSecurityToken()
      Indicates a generated password should be used - e.g. this is a new install, no security realm set up

    • doCreateAdminUser

      @POST @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public org.kohsuke.stapler.HttpResponse doCreateAdminUser(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      Called during the initial setup to create an admin user
      Throws:
      IOException

    • doConfigureInstance

      @POST @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public org.kohsuke.stapler.HttpResponse doConfigureInstance(org.kohsuke.stapler.StaplerRequest2 req, @QueryParameter String rootUrl)

    • getCurrentLevel

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) @CheckForNull public VersionNumber getCurrentLevel()
      What is the version the upgrade wizard has run the last time and upgraded to?. If getUpdateStateFile() is missing, presumes the baseline is 1.0
      Returns:
      Current baseline. null if it cannot be retrieved.

    • doPlatformPluginList

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public org.kohsuke.stapler.HttpResponse doPlatformPluginList() throws IOException
      Returns the initial plugin list in JSON format
      Throws:
      IOException

    • doRestartStatus

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public org.kohsuke.stapler.HttpResponse doRestartStatus() throws IOException
      Returns whether the system needs a restart, and if it is supported e.g. { restartRequired: true, restartSupported: false }
      Throws:
      IOException

    • getPlatformPluginUpdates

      @CheckForNull public net.sf.json.JSONArray getPlatformPluginUpdates()
      Provides the list of platform plugin updates from the last time the upgrade was run.
      Returns:
      null if the version range cannot be retrieved.

    • getInitialAdminPasswordFile

      public FilePath getInitialAdminPasswordFile()
      Gets the file used to store the initial admin password

    • getInitialAdminApiTokenFile

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public FilePath getInitialAdminApiTokenFile()
      Gets the file used to store the initial admin API Token, in case the system property ADMIN_INITIAL_API_TOKEN is set to "true" (and only in this case).

    • doCompleteInstall

      public org.kohsuke.stapler.HttpResponse doCompleteInstall() throws IOException, jakarta.servlet.ServletException
      Remove the setupWizard filter, ensure all updates are written to disk, etc
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getInstallStates

      public List<InstallState> getInstallStates()
      Gets all the install states

    • getInstallState

      public InstallState getInstallState(String name)
      Returns an installState by name

    • onInstallStateUpdate

      public void onInstallStateUpdate(InstallState state)
      Called upon install state update.
      Parameters:
      state - the new install state.
      Since:
      2.94

    • hasSetupWizardFilter

      public boolean hasSetupWizardFilter()
      Returns whether the setup wizard filter is currently registered.
      Since:
      2.94