Class ConfigFileSource

java.lang.Object

com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonSource

com.github.cyanbaz.jenkins.plugins.jsonparameter.ConfigFileSource

All Implemented Interfaces:

ExtensionPoint, Describable<JsonSource>, Serializable

public class ConfigFileSource
extends JsonSource

A JsonSource implementation that loads JSON content from a Jenkins Config File.

Resolution is hierarchical: Jenkins searches the current folder and its parents, falling back to globally defined configuration files if no folder-local match is found.

This class uses the Config File Provider plugin for resolution and validation.

Author:

Caner Yanbaz

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigFileSource.DescriptorImpl	Descriptor for ConfigFileSource, shown as an option in the dropdown selector.

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ConfigFileSource(String configId)	Constructs a new ConfigFileSource instance.

Method Summary

Modifier and Type	Method	Description
String	getConfigId()
String	loadJson()	Loads the JSON content from the configured Jenkins config file.

Methods inherited from class JsonSource

loadOptions

Methods inherited from class Object

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

Methods inherited from interface Describable

getDescriptor

Constructor Details

ConfigFileSource

@DataBoundConstructor
public ConfigFileSource(@NonNull
 String configId)

Constructs a new ConfigFileSource instance.

Parameters:

configId - the ID of the config file as defined in the Config File Provider plugin

Method Details

getConfigId

public String getConfigId()

loadJson

public String loadJson()

Loads the JSON content from the configured Jenkins config file.

The config is resolved hierarchically in the context of the current Jenkins item: nearest folder → parent folders → global.

Specified by:

loadJson in class JsonSource

Returns:

the raw JSON content as a string

Throws:

IllegalArgumentException - if the config file or Jenkins item is not found

IllegalStateException - if no Jenkins item is available in the current request context