org.jvnet.jenkins.plugins.nodelabelparameter

Class NodeParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

org.jvnet.jenkins.plugins.nodelabelparameter.NodeParameterDefinition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, Serializable

public class NodeParameterDefinition
extends hudson.model.SimpleParameterDefinition

Defines a build parameter used to select the node where a job should be executed on. Although it is possible to define the node name in the UI at "restrict where this job should run", but that would tide a job to a fix node. This parameter actually allows to define a list of possible nodes and ask the user before execution.

Author:

domi

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeParameterDefinition.DescriptorImpl

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

hudson.model.ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_NODES
List<String>	allowedSlaves
String	defaultValue Deprecated.

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor and Description
NodeParameterDefinition(String name, String description, List<String> defaultSlaves, List<String> allowedSlaves, String triggerIfResult, boolean ignoreOfflineNodes)
NodeParameterDefinition(String name, String description, String defaultValue, List<String> allowedSlaves, String triggerIfResult) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.model.ParameterDefinition	copyWithDefaultValue(hudson.model.ParameterValue defaultValueObj)
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo)
hudson.model.ParameterValue	createValue(String value)
List<String>	getAllowedNodesOrAll() Returns a list of nodes the job could run on.
boolean	getAllowMultiNodeSelection()
NodeParameterValue	getDefaultParameterValue() e.g.
List<String>	getDefaultSlaves()
static List<String>	getSlaveNames() Gets the names of all configured slaves, regardless whether they are online.
static List<String>	getSlaveNamesForSelection() returns all available nodes plus an identifier to identify all slaves at position one.
String	getTriggerIfResult()
boolean	isIgnoreOfflineNodes()
boolean	isTriggerConcurrentBuilds()
Object	readResolve()

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

all, equals, getDescription, getDescriptor, getName, getType, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_NODES

public static final String ALL_NODES

See Also:

Constant Field Values

allowedSlaves

public final List<String> allowedSlaves

defaultValue

@Deprecated
public transient String defaultValue

Deprecated.

Constructor Detail

NodeParameterDefinition

@DataBoundConstructor
public NodeParameterDefinition(String name,
                                            String description,
                                            List<String> defaultSlaves,
                                            List<String> allowedSlaves,
                                            String triggerIfResult,
                                            boolean ignoreOfflineNodes)

NodeParameterDefinition

@Deprecated
public NodeParameterDefinition(String name,
                                  String description,
                                  String defaultValue,
                                  List<String> allowedSlaves,
                                  String triggerIfResult)

Deprecated.

Method Detail

getDefaultSlaves

public List<String> getDefaultSlaves()

isIgnoreOfflineNodes

public boolean isIgnoreOfflineNodes()

getDefaultParameterValue

public NodeParameterValue getDefaultParameterValue()

e.g. what to show if a build is triggered by hand?

Overrides:

getDefaultParameterValue in class hudson.model.ParameterDefinition

createValue

public hudson.model.ParameterValue createValue(String value)

Specified by:

createValue in class hudson.model.SimpleParameterDefinition

copyWithDefaultValue

public hudson.model.ParameterDefinition copyWithDefaultValue(hudson.model.ParameterValue defaultValueObj)

Overrides:

copyWithDefaultValue in class hudson.model.ParameterDefinition

getAllowedNodesOrAll

public List<String> getAllowedNodesOrAll()

Returns a list of nodes the job could run on. If allowed nodes is empty, it falls back to all nodes

Returns:

list of nodenames.

getTriggerIfResult

public String getTriggerIfResult()

Returns:

the triggerIfResult

getSlaveNamesForSelection

public static List<String> getSlaveNamesForSelection()

returns all available nodes plus an identifier to identify all slaves at position one.

Returns:

list of node names

getSlaveNames

public static List<String> getSlaveNames()

Gets the names of all configured slaves, regardless whether they are online.

Returns:

list with all slave names

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req,
                                      net.sf.json.JSONObject jo)

Specified by:

createValue in class hudson.model.ParameterDefinition

getAllowMultiNodeSelection

public boolean getAllowMultiNodeSelection()

Returns:

the allowMultiNodeSelection

isTriggerConcurrentBuilds

public boolean isTriggerConcurrentBuilds()

Returns:

the triggerConcurrentBuilds

readResolve

public Object readResolve()