@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) @Extension public class SetupWizard extends PageDecorator
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
ExtensionPoint.LegacyInstancesAreScopedToHudson
Modifier and Type | Field and Description |
---|---|
static String |
initialSetupAdminUserName
The security token parameter name
|
ALL
clazz
Constructor and Description |
---|
SetupWizard() |
Modifier and Type | Method and Description |
---|---|
org.kohsuke.stapler.HttpResponse |
doCompleteInstall()
Remove the setupWizard filter, ensure all updates are written to disk, etc
|
org.kohsuke.stapler.HttpResponse |
doConfigureInstance(org.kohsuke.stapler.StaplerRequest req,
String rootUrl) |
org.kohsuke.stapler.HttpResponse |
doCreateAdminUser(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
Called during the initial setup to create an admin user
|
org.kohsuke.stapler.HttpResponse |
doPlatformPluginList()
Returns the initial plugin list in JSON format
|
org.kohsuke.stapler.HttpResponse |
doRestartStatus()
Returns whether the system needs a restart, and if it is supported
e.g.
|
VersionNumber |
getCurrentLevel()
What is the version the upgrade wizard has run the last time and upgraded to?.
|
String |
getDisplayName()
Human readable name of this kind of configurable object.
|
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). |
FilePath |
getInitialAdminPasswordFile()
Gets the file used to store the initial admin password
|
InstallState |
getInstallState(String name)
Returns an installState by name
|
List<InstallState> |
getInstallStates()
Gets all the install states
|
net.sf.json.JSONArray |
getPlatformPluginUpdates()
Provides the list of platform plugin updates from the last time
the upgrade was run.
|
boolean |
hasSetupWizardFilter()
Returns whether the setup wizard filter is currently registered.
|
boolean |
isUsingSecurityToken()
Indicates a generated password should be used - e.g.
|
void |
onInstallStateUpdate(InstallState state)
Called upon install state update.
|
all, getDescriptor, getUrl
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
public static String initialSetupAdminUserName
@NonNull public String getDisplayName()
Descriptor
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
.getDisplayName
in class Descriptor<PageDecorator>
public boolean isUsingSecurityToken()
@POST @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public org.kohsuke.stapler.HttpResponse doCreateAdminUser(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException
IOException
@POST @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public org.kohsuke.stapler.HttpResponse doConfigureInstance(org.kohsuke.stapler.StaplerRequest req, @QueryParameter String rootUrl)
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) @CheckForNull public VersionNumber getCurrentLevel()
getUpdateStateFile()
is missing, presumes the baseline is 1.0null
if it cannot be retrieved.@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) public org.kohsuke.stapler.HttpResponse doPlatformPluginList() throws IOException
IOException
@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) public org.kohsuke.stapler.HttpResponse doRestartStatus() throws IOException
IOException
@CheckForNull public net.sf.json.JSONArray getPlatformPluginUpdates()
null
if the version range cannot be retrieved.public FilePath getInitialAdminPasswordFile()
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public FilePath getInitialAdminApiTokenFile()
ADMIN_INITIAL_API_TOKEN
is set to "true" (and only in this case).public org.kohsuke.stapler.HttpResponse doCompleteInstall() throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public List<InstallState> getInstallStates()
public InstallState getInstallState(String name)
public void onInstallStateUpdate(InstallState state)
state
- the new install state.public boolean hasSetupWizardFilter()
Copyright © 2004–2022. All rights reserved.