Package org.jenkinsci.plugins.configfiles

Class ConfigFilesManagement

java.lang.Object

hudson.model.ManagementLink

org.jenkinsci.plugins.configfiles.ConfigFilesManagement

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, ConfigFilesUIContract, org.kohsuke.stapler.StaplerProxy

@Extension
public class ConfigFilesManagement
extends ManagementLink
implements ConfigFilesUIContract, org.kohsuke.stapler.StaplerProxy

Provides a new link in the "Manage Jenkins" view and builds the UI to manage the configfiles.

Author:

domi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.ManagementLink

ManagementLink.Category

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON_PATH

Fields inherited from class hudson.model.ManagementLink

LIST

Fields inherited from interface org.jenkinsci.plugins.configfiles.ConfigFilesUIContract

ID_PATTERN, JELLY_RESOURCES_PATH

Constructor Summary

Constructors

Constructor	Description
ConfigFilesManagement()

Method Summary

Modifier and Type	Method	Description
void	doAddConfig(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String providerId, String configId)	Requests a new config object from provider (defined by the given id) and forwards the request to "edit.jelly".
FormValidation	doCheckConfigId(String configId)
void	doEditConfig(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String configId)	Loads the config by its id and forwards the request to "edit.jelly".
org.kohsuke.stapler.HttpResponse	doRemoveConfig(org.kohsuke.stapler.StaplerRequest2 res, org.kohsuke.stapler.StaplerResponse2 rsp, String configId)	Removes a script from the config and filesystem.
org.kohsuke.stapler.HttpResponse	doSaveConfig(org.kohsuke.stapler.StaplerRequest2 req)	Insert or update
void	doSelectProvider(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doShow(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String configId)
String	getCategoryName()
Collection<Config>	getConfigs()
ContentType	getContentTypeForProvider(String providerId)
String	getDescription()
String	getDisplayName()
Map<ConfigProvider,Collection<Config>>	getGroupedConfigs()
String	getIconFileName()
String	getIconUrl(String rootUrl)	used by configfiles.jelly to resolve the correct path to the icon (see JENKINS-24441)
List<ConfigProvider>	getProviders()
Permission	getRequiredPermission()
Object	getTarget()	The global configuration actions are exclusive to Overall/Manage permission.
String	getUrlName()

Methods inherited from class hudson.model.ManagementLink

all, getBadge, getCategory, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ICON_PATH

public static final String ICON_PATH

See Also:

• Constant Field Values

Constructor Details

ConfigFilesManagement

public ConfigFilesManagement()

Method Details

getTarget

public Object getTarget()

The global configuration actions are exclusive to Overall/Manage permission.

Specified by:

getTarget in interface org.kohsuke.stapler.StaplerProxy

Returns:

The target.

getRequiredPermission

@NonNull
public Permission getRequiredPermission()

Overrides:

getRequiredPermission in class ManagementLink

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

See Also:

• Action.getDisplayName()

getDescription

public String getDescription()

Overrides:

getDescription in class ManagementLink

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

See Also:

• ManagementLink.getIconFileName()

getIconUrl

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getIconUrl(String rootUrl)

used by configfiles.jelly to resolve the correct path to the icon (see JENKINS-24441)

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

See Also:

• ManagementLink.getUrlName()

getCategoryName

public String getCategoryName()

Overrides:

getCategoryName in class ManagementLink

getContentTypeForProvider

public ContentType getContentTypeForProvider(String providerId)

Specified by:

getContentTypeForProvider in interface ConfigFilesUIContract

getGroupedConfigs

public Map<ConfigProvider,Collection<Config>> getGroupedConfigs()

Specified by:

getGroupedConfigs in interface ConfigFilesUIContract

getProviders

public List<ConfigProvider> getProviders()

Specified by:

getProviders in interface ConfigFilesUIContract

getConfigs

public Collection<Config> getConfigs()

doSaveConfig

@POST
public org.kohsuke.stapler.HttpResponse doSaveConfig(org.kohsuke.stapler.StaplerRequest2 req)

Insert or update

Specified by:

doSaveConfig in interface ConfigFilesUIContract

Parameters:

req - request

Returns:

doShow

public void doShow(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter("id")
 String configId)
            throws IOException,
jakarta.servlet.ServletException

Specified by:

doShow in interface ConfigFilesUIContract

Throws:

IOException

jakarta.servlet.ServletException

doEditConfig

public void doEditConfig(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter("id")
 String configId)
                  throws IOException,
jakarta.servlet.ServletException

Loads the config by its id and forwards the request to "edit.jelly".

Specified by:

doEditConfig in interface ConfigFilesUIContract

Parameters:

req - request

rsp - response

configId - the id of the config to be loaded in to the edit view.

Throws:

IOException

jakarta.servlet.ServletException

doAddConfig

@POST
public void doAddConfig(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter("providerId")
 String providerId,
 @QueryParameter("configId")
 String configId)
                 throws IOException,
jakarta.servlet.ServletException

Requests a new config object from provider (defined by the given id) and forwards the request to "edit.jelly".

Specified by:

doAddConfig in interface ConfigFilesUIContract

Parameters:

req - request

rsp - response

providerId - the id of the provider to create a new config instance with

configId - the id of the new config instance

Throws:

IOException

jakarta.servlet.ServletException

doSelectProvider

public void doSelectProvider(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                      throws IOException,
jakarta.servlet.ServletException

Specified by:

doSelectProvider in interface ConfigFilesUIContract

Throws:

IOException

jakarta.servlet.ServletException

doRemoveConfig

public org.kohsuke.stapler.HttpResponse doRemoveConfig(org.kohsuke.stapler.StaplerRequest2 res,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter("id")
 String configId)
                                                throws IOException

Removes a script from the config and filesystem.

Specified by:

doRemoveConfig in interface ConfigFilesUIContract

Parameters:

res - response

rsp - request

configId - the id of the config to be removed

Returns:

forward to 'index'

Throws:

IOException

doCheckConfigId

public FormValidation doCheckConfigId(@QueryParameter("configId")
 String configId)

Specified by:

doCheckConfigId in interface ConfigFilesUIContract