Package com.github.cyanbaz.jenkins.plugins.jsonparameter

Class ConfigFileSource

java.lang.Object

hudson.model.AbstractDescribableImpl<JsonSource>

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, either globally scoped or folder-scoped.

When folder-scoped, the parameter is only available to jobs located within the specified folder or its subfolders.

This class supports validation to prevent unauthorized access to configuration files outside the designated folder path.

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 hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ConfigFileSource(boolean folderScoped, String folderPath, String configId)	Constructs a new ConfigFileSource instance.

Method Summary

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

Methods inherited from class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonSource

loadOptions

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigFileSource

@DataBoundConstructor
public ConfigFileSource(boolean folderScoped,
 String folderPath,
 String configId)

Constructs a new ConfigFileSource instance.

Parameters:

folderScoped - whether the config file is folder-scoped

folderPath - the full Jenkins path of the folder (only relevant if folderScoped is true)

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

Method Details

isFolderScoped

public boolean isFolderScoped()

getFolderPath

public String getFolderPath()

getConfigId

public String getConfigId()

loadJson

public String loadJson()

Loads the JSON content from the configured Jenkins config file.

If folder-scoped, it checks that the current job is located within the configured folder path.

Specified by:

loadJson in class JsonSource

Returns:

the raw JSON content as a string

Throws:

IllegalArgumentException - if the config file is not found or not accessible

IllegalStateException - if the current job is not within the allowed folder scope