Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractJsonParameterDefinition - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Base class for JSON-backed build parameters.
- AbstractJsonParameterDefinition(String, String, JsonSource, String) - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
-
Creates a new JSON-backed parameter definition.
C
- com.github.cyanbaz.jenkins.plugins.jsonparameter - package com.github.cyanbaz.jenkins.plugins.jsonparameter
- ConfigFileSource - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
A
JsonSource
implementation that loads JSON content from a Jenkins Config File. - ConfigFileSource(String) - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.ConfigFileSource
-
Constructs a new
ConfigFileSource
instance. - ConfigFileSource.DescriptorImpl - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Descriptor for
ConfigFileSource
, shown as an option in the dropdown selector. - createValue(CLICommand, String) - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
-
Creates a parameter value from a CLI command.
- createValue(StaplerRequest2) - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
-
Creates a parameter value from a standard web form submission.
- createValue(StaplerRequest2, JSONObject) - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
-
Creates a parameter value from a JSON-backed web form submission.
D
- DescriptorImpl() - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.ConfigFileSource.DescriptorImpl
- DescriptorImpl() - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterDefinition.DescriptorImpl
- DescriptorImpl() - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterReferenceDefinition.DescriptorImpl
- DescriptorImpl() - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource.DescriptorImpl
- doFillConfigIdItems(Item) - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.ConfigFileSource.DescriptorImpl
-
Provides a list of available config file IDs for selection in the UI.
- doFillCredentialsIdItems(Item) - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource.DescriptorImpl
-
Populates the credentials dropdown in the UI with available username/password credentials.
- doLoadOptions(Job<?, ?>, String, String) - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterReferenceDefinition.DescriptorImpl
-
AJAX endpoint used by the build form to populate the dropdown of a
JsonParameterReferenceDefinition
.
E
- error_config_id_not_found(Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.config_id_not_found
:The selected config ID "{0}" does not exist.
. - error_empty_username() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.empty_username
:Empty username in Username/Password credentials. If you need to use a bearer token, configure Secret Text credentials instead.
. - error_http_request_failed(Object, Object, Object, Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.http_request_failed
:Failed to fetch JSON from URL "{0}" using credentials "{1}": HTTP {2} - {3}
. - error_jenkins_item_not_found() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.jenkins_item_not_found
:No Jenkins item found in the current request context.
. - error_missing_query() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.missing_query
:Missing query in parameter definition
. - error_missing_refName() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.missing_refName
:Missing refName in parameter definition
. - error_no_data() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.no_data
:No data found. Check your JSON source or query.
. - error_no_job_context() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.no_job_context
:No job context
. - error_no_parameter() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.no_parameter
:Job has no parameters
. - error_parameter_not_found(Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.parameter_not_found
:Parameter not found or wrong type: {0}
. - error_unsupported_credential_type(Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.unsupported_credential_type
:Unsupported credential type: {0}
.
F
- failure(String) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonResult
G
- getConfigId() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.ConfigFileSource
- getCredentialsId() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource
- getDefaultParameterValue() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
-
Returns the default parameter value as configured.
- getDefaultValue() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
- getDisplayName() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.ConfigFileSource.DescriptorImpl
-
Returns the display name shown in the dropdown for this source type.
- getDisplayName() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterDefinition.DescriptorImpl
-
Returns the display name shown in the Jenkins UI.
- getDisplayName() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterReferenceDefinition.DescriptorImpl
-
Returns the display name shown in the Jenkins UI.
- getDisplayName() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource.DescriptorImpl
-
Returns the display name shown in the dropdown for this source type.
- getErrorMessage() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonResult
- getPlaceholderMessage() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterDefinition
-
Returns a localized message used when no options are available in the dropdown.
- getQuery() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
- getRef() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterReferenceDefinition
- getSource() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.AbstractJsonParameterDefinition
- getUrl() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource
- getValue() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonResult
I
- isSuccess() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonResult
J
- JsonParameterDefinition - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Represents a custom Jenkins parameter definition that extracts values from a JSON source (either from a local config file or a remote URL) using a JSONPath expression.
- JsonParameterDefinition(String, String, JsonSource, String) - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterDefinition
-
Data-bound constructor called by Jenkins when binding UI input.
- JsonParameterDefinition.DescriptorImpl - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Descriptor for this parameter type, defines how it is represented in Jenkins UI.
- JsonParameterReferenceDefinition - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
A JSON-backed Jenkins parameter that can reference the value of another parameter.
- JsonParameterReferenceDefinition(String, String, JsonSource, String, String) - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonParameterReferenceDefinition
-
Data-bound constructor called by Jenkins when binding UI input.
- JsonParameterReferenceDefinition.DescriptorImpl - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Descriptor for
JsonParameterReferenceDefinition
. - JsonResult<T> - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
A generic result container used to wrap the outcome of loading JSON data.
- JsonResult(boolean, T, String) - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonResult
- JsonSource - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Base class for all JSON data sources used in the
json-parameter-plugin
. - JsonSource() - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonSource
L
- loadJson() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.ConfigFileSource
-
Loads the JSON content from the configured Jenkins config file.
- loadJson() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonSource
-
Loads the raw JSON string from the configured data source.
- loadJson() - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource
-
Fetches the JSON content from the configured remote URL using Java's
HttpClient
. - loadOptions(String) - Method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonSource
-
Extracts a list of values from the loaded JSON using the given JSONPath query.
M
- Messages - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Generated localization support class.
- Messages() - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
P
- placeholder_config_file_id() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
placeholder.config_file_id
:-- Select --
. - placeholder_no_reference_value() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
placeholder.no_reference_value
:-- No reference value --
. - placeholder_select_option() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
placeholder.select_option
:-- Choose an option --
.
R
- RemoteSource - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
A
JsonSource
implementation that retrieves JSON content from a remote HTTP(S) endpoint. - RemoteSource(String, String) - Constructor for class com.github.cyanbaz.jenkins.plugins.jsonparameter.RemoteSource
-
Constructs a new
RemoteSource
. - RemoteSource.DescriptorImpl - Class in com.github.cyanbaz.jenkins.plugins.jsonparameter
-
Descriptor for the
RemoteSource
, used to display this option in the Jenkins UI dropdown.
S
- success(T) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.JsonResult
_
- _error_config_id_not_found(Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.config_id_not_found
:The selected config ID "{0}" does not exist.
. - _error_empty_username() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.empty_username
:Empty username in Username/Password credentials. If you need to use a bearer token, configure Secret Text credentials instead.
. - _error_http_request_failed(Object, Object, Object, Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.http_request_failed
:Failed to fetch JSON from URL "{0}" using credentials "{1}": HTTP {2} - {3}
. - _error_jenkins_item_not_found() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.jenkins_item_not_found
:No Jenkins item found in the current request context.
. - _error_missing_query() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.missing_query
:Missing query in parameter definition
. - _error_missing_refName() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.missing_refName
:Missing refName in parameter definition
. - _error_no_data() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.no_data
:No data found. Check your JSON source or query.
. - _error_no_job_context() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.no_job_context
:No job context
. - _error_no_parameter() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.no_parameter
:Job has no parameters
. - _error_parameter_not_found(Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.parameter_not_found
:Parameter not found or wrong type: {0}
. - _error_unsupported_credential_type(Object) - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
error.unsupported_credential_type
:Unsupported credential type: {0}
. - _placeholder_config_file_id() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
placeholder.config_file_id
:-- Select --
. - _placeholder_no_reference_value() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
placeholder.no_reference_value
:-- No reference value --
. - _placeholder_select_option() - Static method in class com.github.cyanbaz.jenkins.plugins.jsonparameter.Messages
-
Key
placeholder.select_option
:-- Choose an option --
.
All Classes and Interfaces|All Packages|Serialized Form