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 String
ICON_PATH
static Pattern
ID_PATTERN
static String
JELLY_RESOURCES_PATH
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
doAddConfig(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse 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.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String configId)
Loads the config by its id and forwards the request to "edit.jelly".org.kohsuke.stapler.HttpResponse
doRemoveConfig(org.kohsuke.stapler.StaplerRequest res, org.kohsuke.stapler.StaplerResponse rsp, String configId)
Removes a script from the config and filesystem.org.kohsuke.stapler.HttpResponse
doSaveConfig(org.kohsuke.stapler.StaplerRequest req)
Insert or updatevoid
doSelectProvider(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void
doShow(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String configId)
ContentType
getContentTypeForProvider(String providerId)
Map<ConfigProvider,Collection<Config>>
getGroupedConfigs()
List<ConfigProvider>
getProviders()
-
-
-
Field Detail
-
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 Detail
-
getContentTypeForProvider
ContentType getContentTypeForProvider(String providerId)
-
getGroupedConfigs
Map<ConfigProvider,Collection<Config>> getGroupedConfigs()
-
getProviders
List<ConfigProvider> getProviders()
-
doSaveConfig
org.kohsuke.stapler.HttpResponse doSaveConfig(org.kohsuke.stapler.StaplerRequest req) throws IOException, javax.servlet.ServletException
Insert or update- Parameters:
req
- request- Returns:
- Throws:
IOException
javax.servlet.ServletException
-
doShow
void doShow(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter("id") String configId) throws IOException, javax.servlet.ServletException
- Throws:
IOException
javax.servlet.ServletException
-
doEditConfig
void doEditConfig(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter("id") String configId) throws IOException, javax.servlet.ServletException
Loads the config by its id and forwards the request to "edit.jelly".- Parameters:
req
- requestrsp
- responseconfigId
- the id of the config to be loaded in to the edit view.- Throws:
IOException
javax.servlet.ServletException
-
doAddConfig
void doAddConfig(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter("providerId") String providerId, @QueryParameter("configId") String configId) throws IOException, javax.servlet.ServletException
Requests a new config object from provider (defined by the given id) and forwards the request to "edit.jelly".- Parameters:
req
- requestrsp
- responseproviderId
- the id of the provider to create a new config instance withconfigId
- the id of the new config instance- Throws:
IOException
javax.servlet.ServletException
-
doSelectProvider
void doSelectProvider(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
- Throws:
IOException
javax.servlet.ServletException
-
doRemoveConfig
org.kohsuke.stapler.HttpResponse doRemoveConfig(org.kohsuke.stapler.StaplerRequest res, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter("id") String configId) throws IOException
Removes a script from the config and filesystem.- Parameters:
res
- responsersp
- requestconfigId
- the id of the config to be removed- Returns:
- forward to 'index'
- Throws:
IOException
-
doCheckConfigId
FormValidation doCheckConfigId(@QueryParameter("configId") String configId)
-
-