Package org.jenkinsci.plugins.configfiles.custom

Class AbstractCustomProvider

java.lang.Object

hudson.model.Descriptor<Config>

org.jenkinsci.lib.configprovider.ConfigProvider

org.jenkinsci.lib.configprovider.AbstractConfigProviderImpl

org.jenkinsci.plugins.configfiles.custom.AbstractCustomProvider

All Implemented Interfaces:

ExtensionPoint, Saveable, OnMaster

Direct Known Subclasses:

CustomConfig.CustomConfigProvider

public abstract class AbstractCustomProvider
extends AbstractConfigProviderImpl

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 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
AbstractCustomProvider()

Method Summary

Modifier and Type	Method	Description
ContentType	getContentType()	The content type of the configs this provider manages.
List<String>	getSensitiveContentForMasking(Config configFile, Run<?,?> build)	Obtain a list of sensitive Strings to mask for the given provider and build.
String	supplyContent(Config configFile, Run<?,?> build, FilePath workDir, TaskListener listener, List<String> tempFiles)	Provide the given content file.

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractCustomProvider

public AbstractCustomProvider()

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

Specified by:

getContentType in class ConfigProvider

Returns:

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

supplyContent

public String supplyContent(Config configFile,
 Run<?,?> build,
 FilePath workDir,
 TaskListener listener,
 List<String> tempFiles)
                     throws IOException

Description copied from class: ConfigProvider

Provide the given content file. Implementation Note:If this is overridden in a sub class and credentials are injected into the content - then the implementation must also override ConfigProvider.getSensitiveContentForMasking(Config, Run) to avoid accidental disclosure.

Overrides:

supplyContent in class ConfigProvider

Parameters:

configFile - the file content to be provided

workDir - target workspace directory

listener - the listener

tempFiles - temp files created by this method, these files will be deleted by the caller

Returns:

file content

Throws:

IOException - in case an exception occurs when providing the content or other needed files

See Also:

• ConfigProvider.getSensitiveContentForMasking(Config, Run)

getSensitiveContentForMasking

@NonNull
public List<String> getSensitiveContentForMasking(Config configFile,
 Run<?,?> build)

Description copied from class: ConfigProvider

Obtain a list of sensitive Strings to mask for the given provider and build. For example if a UsernamePasswordCredentials is being injected into a file then the password (and possibly the username) from the resolved credential would need to be masked and should be returned here.

Overrides:

getSensitiveContentForMasking in class ConfigProvider

Parameters:

configFile - the file content to provide sensitive strings for.

build - the build for which the configFile applies.

Returns:

List of Strings that need to be masked in the console.