Package org.jenkinsci.plugins.configfiles.custom

Class CustomConfig.CustomConfigProvider

java.lang.Object

hudson.model.Descriptor<Config>

org.jenkinsci.lib.configprovider.ConfigProvider

org.jenkinsci.lib.configprovider.AbstractConfigProviderImpl

org.jenkinsci.plugins.configfiles.custom.AbstractCustomProvider

org.jenkinsci.plugins.configfiles.custom.CustomConfig.CustomConfigProvider

All Implemented Interfaces:

ExtensionPoint, Saveable, OnMaster

Enclosing class:

CustomConfig

@Extension(ordinal=50.0)
public static class CustomConfig.CustomConfigProvider
extends AbstractCustomProvider

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 String	ID_PREFIX

Fields inherited from class org.jenkinsci.lib.configprovider.AbstractConfigProviderImpl

configs

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
CustomConfigProvider()

Method Summary

Modifier and Type	Method	Description
ContentType	getContentType()	The content type of the configs this provider manages.
String	getDisplayName()
protected String	getXmlFileName()
CustomConfig	newConfig(String id)	Returns a new Config object.

Methods inherited from class org.jenkinsci.plugins.configfiles.custom.AbstractCustomProvider

getSensitiveContentForMasking, supplyContent

Methods inherited from class org.jenkinsci.lib.configprovider.AbstractConfigProviderImpl

clearOldDataStorage, convert, getConfigs, getConfigXml, getProviderId, load, save

Methods inherited from class org.jenkinsci.lib.configprovider.ConfigProvider

all, configExists, getAllConfigs, getByIdOrNull, getConfigById, newConfig, newConfig, remove, save, 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, 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

Methods inherited from class java.lang.Object

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

Field Details

ID_PREFIX

protected transient String ID_PREFIX

Constructor Details

CustomConfigProvider

public CustomConfigProvider()

Method Details

getContentType

public ContentType getContentType()

Description copied from class: ConfigProvider

The content type of the configs this provider manages. e.g. can be used to display the content in the UI (editor).

Overrides:

getContentType in class AbstractCustomProvider

Returns:

the type. null if no specific formatting should be supported.

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Config>

newConfig

@NonNull
public CustomConfig newConfig(@NonNull
 String id)

Description copied from class: ConfigProvider

Returns a new Config object.

Overrides:

newConfig in class ConfigProvider

Parameters:

id - desired id

Returns:

the created configuration

getXmlFileName

protected String getXmlFileName()

Overrides:

getXmlFileName in class AbstractConfigProviderImpl