Package jenkins.console

Class ConsoleUrlProviderGlobalConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

jenkins.console.ConsoleUrlProviderGlobalConfiguration

All Implemented Interfaces:

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

@Extension
@Symbol("consoleUrlProvider")
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class ConsoleUrlProviderGlobalConfiguration
extends GlobalConfiguration

Allows administrators to activate and sort ConsoleUrlProvider extensions to set defaults for all users.

Since:

2.433

See Also:

• ConsoleUrlProviderUserProperty

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

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)	By default, calls StaplerRequest2.bindJSON(Object, JSONObject), appropriate when your implementation has getters and setters for all fields.
static ConsoleUrlProviderGlobalConfiguration	get()
GlobalConfigurationCategory	getCategory()	Define the global configuration category the global config of this Descriptor is in.
List<ConsoleUrlProvider>	getProviders()
List<? extends Descriptor<ConsoleUrlProvider>>	getProvidersDescriptors()
boolean	isEnabled()
void	setProviders(List<ConsoleUrlProvider> providers)

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

ConsoleUrlProviderGlobalConfiguration

public ConsoleUrlProviderGlobalConfiguration()

Method Details

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Description copied from class: Descriptor

Define the global configuration category the global config of this Descriptor is in.

Overrides:

getCategory in class Descriptor<GlobalConfiguration>

Returns:

never null, always the same value for a given instance of Descriptor.

getProviders

public List<ConsoleUrlProvider> getProviders()

setProviders

@DataBoundSetter
public void setProviders(List<ConsoleUrlProvider> providers)

configure

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

Description copied from class: GlobalConfiguration

By default, calls StaplerRequest2.bindJSON(Object, JSONObject), appropriate when your implementation has getters and setters for all fields.

Invoked when the global configuration page is submitted. Can be overridden to store descriptor-specific information.

Overrides:

configure in class GlobalConfiguration

json - The JSON object that captures the configuration data for this Descriptor. See the developer documentation.

Returns:

false to keep the client in the same config page.

Throws:

Descriptor.FormException

isEnabled

public boolean isEnabled()

get

public static ConsoleUrlProviderGlobalConfiguration get()

getProvidersDescriptors

public List<? extends Descriptor<ConsoleUrlProvider>> getProvidersDescriptors()