Class RemoteSource

java.lang.Object

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

com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource

All Implemented Interfaces:

ExtensionPoint, Describable<JsonSource>, Serializable

public class RemoteSource
extends JsonSource

A JsonSource implementation that retrieves JSON content from a remote HTTP(S) endpoint.

Supports Jenkins proxy configuration automatically via ProxyConfiguration.

Authentication is optional: - If no credentials are provided, a plain HTTP(S) request is sent. - If a credentials ID is provided, the plugin supports: - StandardUsernamePasswordCredentials: Sent as HTTP Basic Auth. - StringCredentials: Sent as Bearer token in the Authorization header.

The configured URL must return a valid JSON response body. This source type is ideal for external services that expose dynamic data for parameter injection.

Author:

Caner Yanbaz

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteSource.DescriptorImpl	Descriptor for the RemoteSource, used to display this option in the Jenkins UI dropdown.

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RemoteSource(String url, String credentialsId)	Constructs a new RemoteSource.

Method Summary

Modifier and Type	Method	Description
String	getCredentialsId()
String	getUrl()
String	loadJson()	Fetches the JSON content from the configured remote URL using Java's HttpClient.

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

RemoteSource

@DataBoundConstructor
public RemoteSource(@NonNull
 String url,
 String credentialsId)

Constructs a new RemoteSource.

Parameters:

url - the remote URL returning JSON content

credentialsId - optional credentials ID for authentication (username/password)

Method Details

getUrl

public String getUrl()

getCredentialsId

public String getCredentialsId()

loadJson

public String loadJson()
                throws IOException,
InterruptedException

Fetches the JSON content from the configured remote URL using Java's HttpClient.

- If credentialsId is defined, the appropriate Authorization header is added based on the resolved credentials type (username/password or secret text). - Jenkins global proxy configuration is used automatically. - Throws an IOException if the response code is 400 or higher.

Specified by:

loadJson in class JsonSource

Returns:

the raw JSON response body as a string

Throws:

IOException - if the HTTP request fails or the status code indicates an error

InterruptedException - if the request is interrupted

IllegalArgumentException - if the credentials ID is invalid or not found