Package jenkins.model

Class JenkinsLocationConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

jenkins.model.JenkinsLocationConfiguration

All Implemented Interfaces:

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

@Extension(ordinal=200.0)
@Symbol("location")
public class JenkinsLocationConfiguration
extends GlobalConfiguration
implements PersistentDescriptor

Stores the location of Jenkins (e-mail address and the HTTP URL.)

Since:

1.494

Author:

Kohsuke Kawaguchi

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 boolean	DISABLE_URL_VALIDATION	If disabled, the application will no longer check for URL validity in the configuration page.
static final int	ORDINAL

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
JenkinsLocationConfiguration()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckAdminAddress(String value)
FormValidation	doCheckUrl(String value)	Checks the URL in global.jelly
static JenkinsLocationConfiguration	get()
String	getAdminAddress()	Gets the service administrator e-mail address.
static JenkinsLocationConfiguration	getOrDie()	Gets local configuration.
String	getUrl()
void	load()	Loads the data from the disk into this object.
void	setAdminAddress(String adminAddress)	Sets the e-mail address of Jenkins administrator.
void	setUrl(String jenkinsUrl)

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

Methods inherited from interface hudson.model.Saveable

save

Field Details

DISABLE_URL_VALIDATION

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean DISABLE_URL_VALIDATION

If disabled, the application will no longer check for URL validity in the configuration page. This will lead to an instance vulnerable to SECURITY-1471.

Since:

2.176.4 / 2.197

ORDINAL

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final int ORDINAL

See Also:

• Constant Field Values

Constructor Details

JenkinsLocationConfiguration

public JenkinsLocationConfiguration()

Method Details

get

@NonNull
public static JenkinsLocationConfiguration get()

getOrDie

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@NonNull
public static JenkinsLocationConfiguration getOrDie()

Gets local configuration. For explanation when it could die, see get()

load

public void load()

Description copied from class: Descriptor

Loads the data from the disk into this object.

The constructor of the derived class must call this method. (If we do that in the base class, the derived class won't get a chance to set default values.)

Specified by:

load in interface Loadable

Specified by:

load in interface PersistentDescriptor

Overrides:

load in class Descriptor<GlobalConfiguration>

getAdminAddress

@NonNull
public String getAdminAddress()

Gets the service administrator e-mail address.

Returns:

Admin address or "address not configured" stub

setAdminAddress

public void setAdminAddress(@CheckForNull
 String adminAddress)

Sets the e-mail address of Jenkins administrator.

Parameters:

adminAddress - Admin address. Use null to reset the value to default.

getUrl

@CheckForNull
public String getUrl()

setUrl

public void setUrl(@CheckForNull
 String jenkinsUrl)

doCheckUrl

public FormValidation doCheckUrl(@QueryParameter
 String value)

Checks the URL in global.jelly

doCheckAdminAddress

public FormValidation doCheckAdminAddress(@QueryParameter
 String value)