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, Loadable, 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 of ConfigProvider.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Config>	configs	Deprecated.

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
AbstractConfigProviderImpl()

Method Summary

Modifier and Type	Method	Description
void	clearOldDataStorage()
<T extends Config> T	convert(Config config)	Deprecated.
Map<String,Config>	getConfigs()	Deprecated.
protected XmlFile	getConfigXml()	Deprecated.
String	getProviderId()	An ID uniquely identifying this provider, the id of each Config 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, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, 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, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Details

configs

@Deprecated
protected Map<String,Config> configs

Deprecated.

Constructor Details

AbstractConfigProviderImpl

public AbstractConfigProviderImpl()

Method Details

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 each Config must start with this ID separated by a '.'!

Specified by:

getProviderId in class ConfigProvider

Returns:

the unique id for this provider.

save

public void save()

Saves the configuration info to the disk.

Specified by:

save in interface Saveable

Overrides:

save in class Descriptor<Config>

load

public void load()

Overridden for backward compatibility to let subtype customize the file name.

Specified by:

load in interface Loadable

Overrides:

load in class Descriptor<Config>

getConfigXml

@Deprecated
protected XmlFile getConfigXml()

Deprecated.

getXmlFileName

@Deprecated
protected String getXmlFileName()

Deprecated.

clearOldDataStorage

public void clearOldDataStorage()

Specified by:

clearOldDataStorage in class ConfigProvider