org.jenkinsci.plugins.pipeline.modeldefinition.agent

Class DeclarativeAgentDescriptor

java.lang.Object

hudson.model.Descriptor<DeclarativeAgent>

org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgentDescriptor

All Implemented Interfaces:

hudson.model.Saveable

public abstract class DeclarativeAgentDescriptor
extends hudson.model.Descriptor<DeclarativeAgent>

Descriptor for DeclarativeAgent.

Author:

Andrew Bayer

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DeclarativeAgentDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.ExtensionList<DeclarativeAgentDescriptor>	all() Get all DeclarativeAgentDescriptors.
static DeclarativeAgentDescriptor	byName(String name) Get the descriptor for a given name or null if not found.
String	getDeclarativeAgentScriptClass() The full package and class name for the DeclarativeAgentScript class corresponding to this.
static Map<String,org.jenkinsci.plugins.structs.describable.DescribableModel>	getDescribableModels() Get a map of name-to-DescribableModel of all known/registered descriptors.
String	getName() The name for this agent type.
static DeclarativeAgent	instanceForDescriptor(DeclarativeAgentDescriptor descriptor, Map<String,Object> arguments) For a given descriptor and map of arguments, return an instance using those arguments.
static DeclarativeAgent	instanceForName(String name, Map<String,Object> arguments) For a given name and map of arguments, find the corresponding descriptor and return an instance using those arguments.
DeclarativeAgent	newInstance() Creates an instance of the corresponding DeclarativeAgent with no arguments.
DeclarativeAgent	newInstance(Map<String,Object> arguments) Creates an instance of the corresponding DeclarativeAgent from the given arguments.
static Map<String,org.jenkinsci.plugins.structs.describable.DescribableModel>	zeroArgModels() Get the map of the subset of descriptors with no additional arguments - i.e., "none" and "any".

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, 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

Constructor Detail

DeclarativeAgentDescriptor

public DeclarativeAgentDescriptor()

Method Detail

getName

@Nonnull
public String getName()

The name for this agent type. Defaults to the first string in the Symbol on the class.

Returns:

The name.

getDeclarativeAgentScriptClass

@Nonnull
public String getDeclarativeAgentScriptClass()

The full package and class name for the DeclarativeAgentScript class corresponding to this. Defaults to the DeclarativeAgent class name with "Script" appended to the end.

Returns:

The class name, defaulting to the DeclarativeAgent Descriptor.clazz class name with "Script" appended.

newInstance

public DeclarativeAgent newInstance(Map<String,Object> arguments)
                             throws Exception

Creates an instance of the corresponding DeclarativeAgent from the given arguments.

Parameters:

arguments - A map of strings/objects to be passed to the constructor.

Returns:

An instantiated DeclarativeAgent

Throws:

Exception

newInstance

public DeclarativeAgent newInstance()
                             throws Exception

Creates an instance of the corresponding DeclarativeAgent with no arguments.

Returns:

An instantiated DeclarativeAgent

Throws:

Exception

all

public static hudson.ExtensionList<DeclarativeAgentDescriptor> all()

Get all DeclarativeAgentDescriptors.

Returns:

a list of all DeclarativeAgentDescriptors registered.`

getDescribableModels

public static Map<String,org.jenkinsci.plugins.structs.describable.DescribableModel> getDescribableModels()

Get a map of name-to-DescribableModel of all known/registered descriptors.

Returns:

A map of name-to-DescribableModels

zeroArgModels

public static Map<String,org.jenkinsci.plugins.structs.describable.DescribableModel> zeroArgModels()

Get the map of the subset of descriptors with no additional arguments - i.e., "none" and "any".

Returns:

A map of descriptors with no arguments.

byName

@Nullable
public static DeclarativeAgentDescriptor byName(@Nonnull
                                         String name)

Get the descriptor for a given name or null if not found.

Parameters:

name - The name for the descriptor to look up

Returns:

The corresponding descriptor or null if not found.

instanceForName

@Nullable
public static DeclarativeAgent instanceForName(@Nonnull
                                        String name,
                                        Map<String,Object> arguments)
                                        throws Exception

For a given name and map of arguments, find the corresponding descriptor and return an instance using those arguments.

Parameters:

name - The name of the descriptor

arguments - A map of arguments

Returns:

The instantiated DeclarativeAgent instance, or null if the name isn't found.

Throws:

Exception

instanceForDescriptor

@Nonnull
public static DeclarativeAgent instanceForDescriptor(@Nonnull
                                             DeclarativeAgentDescriptor descriptor,
                                             Map<String,Object> arguments)
                                              throws Exception

For a given descriptor and map of arguments, return an instance using those arguments.

Parameters:

descriptor - The descriptor instance

arguments - A map of arguments

Returns:

The instantiated DeclarativeAgent instance.

Throws:

Exception