Package org.jenkinsci.plugins.configfiles

Interface ConfigFilesUIContract

All Known Implementing Classes:

ConfigFilesManagement, FolderConfigFileAction

public interface ConfigFilesUIContract

Defines the contract for actions called by jelly

Author:

domi

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON_PATH
static final Pattern	ID_PATTERN
static final String	JELLY_RESOURCES_PATH

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)
ContentType	getContentTypeForProvider(String providerId)
Map<ConfigProvider,Collection<Config>>	getGroupedConfigs()
List<ConfigProvider>	getProviders()

Field Details

JELLY_RESOURCES_PATH

static final String JELLY_RESOURCES_PATH

See Also:

• Constant Field Values

ICON_PATH

static final String ICON_PATH

See Also:

• Constant Field Values

ID_PATTERN

static final Pattern ID_PATTERN

Method Details

getContentTypeForProvider

ContentType getContentTypeForProvider(String providerId)

getGroupedConfigs

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

getProviders

List<ConfigProvider> getProviders()

doSaveConfig

org.kohsuke.stapler.HttpResponse doSaveConfig(org.kohsuke.stapler.StaplerRequest2 req)
                                       throws IOException,
jakarta.servlet.ServletException

Insert or update

Parameters:

req - request

Returns:

Throws:

IOException

jakarta.servlet.ServletException

doShow

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

Throws:

IOException

jakarta.servlet.ServletException

doEditConfig

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".

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

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".

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

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

Throws:

IOException

jakarta.servlet.ServletException

doRemoveConfig

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.

Parameters:

res - response

rsp - request

configId - the id of the config to be removed

Returns:

forward to 'index'

Throws:

IOException

doCheckConfigId

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