Package org.jenkinsci.plugins.cortexcloud.global

Class Config

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.plugins.cortexcloud.global.Config

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
public final class Config
extends GlobalConfiguration

Global configuration for the Cortex Cloud Jenkins plugin. This mirrors the role of the legacy Prisma Cloud Compute plugin's Config (a singleton GlobalConfiguration shown under Manage Jenkins -> System), but the authentication model is different to match the verified Cortex CLI contract: - Legacy console address -> Cortex API base URL (CORTEX_API_BASE_URL) - Legacy username/password -> Cortex API key (CORTEX_API_KEY) + API key ID (CORTEX_API_KEY_ID) The API key is stored as a Secret so it is encrypted at rest and never rendered back to the UI in plain text.

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 hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
Config()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckApiBaseUrl(String value)
FormValidation	doCheckApiKey(String value)
FormValidation	doCheckApiKeyId(String value)
FormValidation	doTestConnection(String apiBaseUrl, String apiKey, String apiKeyId)	Validates connectivity to the tenant API using the supplied credentials.
static Config	get()	Convenience accessor for the singleton instance.
String	getApiBaseUrl()
Secret	getApiKey()
String	getApiKeyId()
String	getApiKeyPlainText()
String	getCliPath()
boolean	isDebug()
void	setApiBaseUrl(String apiBaseUrl)
void	setApiKey(Secret apiKey)
void	setApiKeyId(String apiKeyId)
void	setCliPath(String cliPath)
void	setDebug(boolean debug)

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

Config

public Config()

Method Details

get

public static Config get()

Convenience accessor for the singleton instance.

getApiBaseUrl

@CheckForNull
public String getApiBaseUrl()

getApiKey

@CheckForNull
public Secret getApiKey()

Returns:

the API key as a Secret (for binding the password field), or null.

getApiKeyPlainText

@CheckForNull
public String getApiKeyPlainText()

Returns:

the plain-text API key for passing to the CLI/REST call, or null.

getApiKeyId

@CheckForNull
public String getApiKeyId()

getCliPath

@CheckForNull
public String getCliPath()

isDebug

public boolean isDebug()

setApiBaseUrl

@DataBoundSetter
public void setApiBaseUrl(String apiBaseUrl)

setApiKey

@DataBoundSetter
public void setApiKey(Secret apiKey)

setApiKeyId

@DataBoundSetter
public void setApiKeyId(String apiKeyId)

setCliPath

@DataBoundSetter
public void setCliPath(String cliPath)

setDebug

@DataBoundSetter
public void setDebug(boolean debug)

doCheckApiBaseUrl

@POST
public FormValidation doCheckApiBaseUrl(@QueryParameter
 String value)

doCheckApiKey

@POST
public FormValidation doCheckApiKey(@QueryParameter
 String value)

doCheckApiKeyId

@POST
public FormValidation doCheckApiKeyId(@QueryParameter
 String value)

doTestConnection

@POST
public FormValidation doTestConnection(@QueryParameter("apiBaseUrl")
 String apiBaseUrl,
 @QueryParameter("apiKey")
 String apiKey,
 @QueryParameter("apiKeyId")
 String apiKeyId)

Validates connectivity to the tenant API using the supplied credentials. Annotated @POST and gated on Jenkins.ADMINISTER so the stored/entered secret cannot be probed via a crafted GET request - this is the modern, CSRF-safe equivalent of the legacy plugin's Test Connection.