Package io.jenkins.plugins.ranchermanager

Class RancherGlobalConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.ranchermanager.RancherGlobalConfiguration

All Implemented Interfaces:

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

@Extension
@Symbol("rancherManager")
public class RancherGlobalConfiguration
extends GlobalConfiguration

Global Rancher Manager connection settings (Manage Jenkins → System → Rancher Manager).

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

Modifier and Type	Field	Description
static final int	DEFAULT_CONNECT_TIMEOUT_MS
static final int	DEFAULT_READ_TIMEOUT_MS

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
RancherGlobalConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)
FormValidation	doCheckConnectTimeoutMs(String value)
FormValidation	doCheckRancherUrl(String value)
FormValidation	doCheckReadTimeoutMs(String value)
ListBoxModel	doFillCredentialsIdItems(String credentialsId)
static RancherGlobalConfiguration	get()
int	getConnectTimeoutMs()
String	getCredentialsId()
String	getDisplayName()
String	getName()
String	getRancherUrl()
int	getReadTimeoutMs()
boolean	isConfigured()	Whether URL and API token credentials are set (build/step readiness).
void	setConnectTimeoutMs(int connectTimeoutMs)
void	setCredentialsId(String credentialsId)
void	setName(String name)
void	setRancherUrl(String rancherUrl)
void	setReadTimeoutMs(int readTimeoutMs)

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

Field Details

DEFAULT_CONNECT_TIMEOUT_MS

public static final int DEFAULT_CONNECT_TIMEOUT_MS

See Also:

• Constant Field Values

DEFAULT_READ_TIMEOUT_MS

public static final int DEFAULT_READ_TIMEOUT_MS

See Also:

• Constant Field Values

Constructor Details

RancherGlobalConfiguration

public RancherGlobalConfiguration()

Method Details

get

public static RancherGlobalConfiguration get()

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<GlobalConfiguration>

getName

public String getName()

setName

@DataBoundSetter
public void setName(String name)

getRancherUrl

public String getRancherUrl()

setRancherUrl

@DataBoundSetter
public void setRancherUrl(String rancherUrl)

getCredentialsId

public String getCredentialsId()

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

getConnectTimeoutMs

public int getConnectTimeoutMs()

setConnectTimeoutMs

@DataBoundSetter
public void setConnectTimeoutMs(int connectTimeoutMs)

getReadTimeoutMs

public int getReadTimeoutMs()

setReadTimeoutMs

@DataBoundSetter
public void setReadTimeoutMs(int readTimeoutMs)

isConfigured

public boolean isConfigured()

Whether URL and API token credentials are set (build/step readiness). Save does not call Rancher; runtime preflight probes during builds.

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

doCheckRancherUrl

@POST
public FormValidation doCheckRancherUrl(@QueryParameter
 String value)

doCheckConnectTimeoutMs

@POST
public FormValidation doCheckConnectTimeoutMs(@QueryParameter
 String value)

doCheckReadTimeoutMs

@POST
public FormValidation doCheckReadTimeoutMs(@QueryParameter
 String value)

doFillCredentialsIdItems

@POST
public ListBoxModel doFillCredentialsIdItems(@QueryParameter
 String credentialsId)