Package org.jenkinsci.lib.configprovider
Class AbstractConfigProviderImpl
- java.lang.Object
-
- hudson.model.Descriptor<Config>
-
- org.jenkinsci.lib.configprovider.ConfigProvider
-
- org.jenkinsci.lib.configprovider.AbstractConfigProviderImpl
-
- All Implemented Interfaces:
ExtensionPoint
,Saveable
,OnMaster
- Direct Known Subclasses:
AbstractConfigProvider
,AbstractCustomProvider
,AbstractMavenSettingsProvider
,AbstractPropertiesProvider
,GroovyScript.GroovyConfigProvider
,JsonConfig.JsonConfigProvider
,MavenToolchainsConfig.MavenToolchainsConfigProvider
,XmlConfig.XmlConfigProvider
public abstract class AbstractConfigProviderImpl extends ConfigProvider
Partial default implementation ofConfigProvider
.- Author:
- Kohsuke Kawaguchi
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description AbstractConfigProviderImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clearOldDataStorage()
<T extends Config>
Tconvert(Config config)
Deprecated.Map<String,Config>
getConfigs()
Deprecated.protected XmlFile
getConfigXml()
Deprecated.String
getProviderId()
An ID uniquely identifying this provider, the id of eachConfig
must start with this ID separated by a '.'!protected String
getXmlFileName()
Deprecated.void
load()
Overridden for backward compatibility to let subtype customize the file name.void
save()
Saves the configuration info to the disk.-
Methods inherited from class org.jenkinsci.lib.configprovider.ConfigProvider
all, configExists, getAllConfigs, getByIdOrNull, getConfigById, getContentType, getSensitiveContentForMasking, newConfig, newConfig, newConfig, remove, save, supplyContent, supportsFolder
-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, self, toArray, toList, toMap
-
-
-
-
Field Detail
-
configs
@Deprecated protected Map<String,Config> configs
Deprecated.
-
-
Method Detail
-
getConfigs
@Deprecated public Map<String,Config> getConfigs()
Deprecated.only used for data migration- See Also:
ConfigFiles
-
convert
@Deprecated public <T extends Config> T convert(Config config)
Deprecated.Only used to convert data from the old (< 1.5) to the new (≥ 1.5) storage format. New implementations of this extension point do not need to implement this.- Type Parameters:
T
- expected type of the returned configuration item.- Parameters:
config
- the configuration to convert
-
getProviderId
public String getProviderId()
Description copied from class:ConfigProvider
An ID uniquely identifying this provider, the id of eachConfig
must start with this ID separated by a '.'!- Specified by:
getProviderId
in classConfigProvider
- Returns:
- the unique id for this provider.
-
save
public void save()
Saves the configuration info to the disk.- Specified by:
save
in interfaceSaveable
- Overrides:
save
in classDescriptor<Config>
-
load
public void load()
Overridden for backward compatibility to let subtype customize the file name.- Overrides:
load
in classDescriptor<Config>
-
getConfigXml
@Deprecated protected XmlFile getConfigXml()
Deprecated.
-
getXmlFileName
@Deprecated protected String getXmlFileName()
Deprecated.
-
clearOldDataStorage
public void clearOldDataStorage()
- Specified by:
clearOldDataStorage
in classConfigProvider
-
-