Package jenkins.security

Class QueueItemAuthenticatorConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

jenkins.security.QueueItemAuthenticatorConfiguration

All Implemented Interfaces:

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

@Extension
@Symbol("queueItemAuthenticator")
public class QueueItemAuthenticatorConfiguration
extends GlobalConfiguration
implements PersistentDescriptor

Show the QueueItemAuthenticator configurations on the system config page.

Since:

1.520

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueItemAuthenticatorConfiguration.ProviderImpl

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

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)	By default, calls StaplerRequest.bindJSON(Object, JSONObject), appropriate when your implementation has getters and setters for all fields.
static QueueItemAuthenticatorConfiguration	get()
DescribableList<QueueItemAuthenticator,QueueItemAuthenticatorDescriptor>	getAuthenticators()	Provides all user-configured authenticators.
GlobalConfigurationCategory	getCategory()	Define the global configuration category the global config of this Descriptor is in.

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, 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, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, 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.PersistentDescriptor

load

Methods inherited from interface hudson.model.Saveable

save

Constructor Detail

QueueItemAuthenticatorConfiguration

public QueueItemAuthenticatorConfiguration()

Method Detail

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.

getAuthenticators

public DescribableList<QueueItemAuthenticator,QueueItemAuthenticatorDescriptor> getAuthenticators()

Provides all user-configured authenticators. Note that if you are looking to determine all effective authenticators, including any potentially supplied by plugins rather than user configuration, you should rather call QueueItemAuthenticatorProvider.authenticators(); or if you are looking for the authentication of an actual project, build, etc., use Queue.Item.authenticate() or Tasks.getAuthenticationOf(hudson.model.Queue.Task).

configure

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

Description copied from class: GlobalConfiguration

By default, calls StaplerRequest.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

get

@NonNull
public static QueueItemAuthenticatorConfiguration get()