Package io.jenkins.plugins.har.cli

Class HarnessGlobalConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.har.cli.HarnessGlobalConfiguration

All Implemented Interfaces:

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

@Extension
@Symbol("harnessCliConfig")
public class HarnessGlobalConfiguration
extends GlobalConfiguration

Global Jenkins configuration for the Harness CLI plugin. Appears under Manage Jenkins → Configure System → Harness CLI Configuration.

These credentials are used by the HcStep pipeline step to automatically run hc auth login before the first hc command in each build, so individual pipeline steps do not need to handle authentication themselves.

TODO: Open Manage Jenkins → Configure System and fill in:

• API URL — Harness API endpoint (default: https://app.harness.io)
• API Token — a Personal Access Token (PAT) from Harness (mandatory)
• Org ID — Harness organisation ID (optional)
• Project ID — Harness project ID (optional)

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
HarnessGlobalConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)
FormValidation	doCheckApiToken(String value)
FormValidation	doCheckApiUrl(String value)
static HarnessGlobalConfiguration	get()	Returns the singleton instance registered by Jenkins.
Secret	getApiToken()
String	getApiUrl()
String	getDisplayName()
String	getOrgId()
String	getProjectId()
void	setApiToken(Secret apiToken)
void	setApiUrl(String apiUrl)
void	setOrgId(String orgId)
void	setProjectId(String projectId)

Methods inherited from class jenkins.model.GlobalConfiguration

all, 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, 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

HarnessGlobalConfiguration

public HarnessGlobalConfiguration()

Method Details

get

public static HarnessGlobalConfiguration get()

Returns the singleton instance registered by Jenkins.

getApiUrl

public String getApiUrl()

getApiToken

public Secret getApiToken()

getOrgId

public String getOrgId()

getProjectId

public String getProjectId()

setApiUrl

@DataBoundSetter
public void setApiUrl(String apiUrl)

setApiToken

@DataBoundSetter
public void setApiToken(Secret apiToken)

setOrgId

@DataBoundSetter
public void setOrgId(String orgId)

setProjectId

@DataBoundSetter
public void setProjectId(String projectId)

doCheckApiUrl

@POST
public FormValidation doCheckApiUrl(@QueryParameter
 String value)

doCheckApiToken

@POST
public FormValidation doCheckApiToken(@QueryParameter
 String value)

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Overrides:

configure in class GlobalConfiguration

Throws:

Descriptor.FormException

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<GlobalConfiguration>