com.rackspace.jenkins_nodepool

Class NodePools

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

com.rackspace.jenkins_nodepool.NodePools

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable, Iterable<NodePool>, jenkins.util.io.OnMaster

@Extension
public class NodePools
extends jenkins.model.GlobalConfiguration
implements Iterable<NodePool>

Top level Jenkins configuration class to manage all NodePool configuration

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
NodePools()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
static NodePools	get()
Lock	getCleanupLock()
NodePoolJobHistory	getJobHistory()
List<NodePool>	getNodePools()
Iterator<NodePool>	iterator()
List<NodePool>	nodePoolsForLabel(hudson.model.Label label) Returns a list of NodePool objects that match the specified label.
void	provisionNode(hudson.model.Label label, hudson.model.Queue.Task task, long queueID) Submit request for node(s) required to execute the given task based on the nodes associated with the specified label.
void	readObject(ObjectInputStream in)
void	setNodePools(List<NodePool> nodePools)
Stream<NodePool>	stream()

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, 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, 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 java.lang.Iterable

forEach, spliterator

Constructor Detail

NodePools

public NodePools()

Method Detail

get

public static NodePools get()

readObject

public void readObject(ObjectInputStream in)
                throws IOException,
                       ClassNotFoundException

Throws:

IOException

ClassNotFoundException

configure

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

Overrides:

configure in class jenkins.model.GlobalConfiguration

Throws:

hudson.model.Descriptor.FormException

getNodePools

public List<NodePool> getNodePools()

getCleanupLock

public Lock getCleanupLock()

iterator

public Iterator<NodePool> iterator()

Specified by:

iterator in interface Iterable<NodePool>

nodePoolsForLabel

public List<NodePool> nodePoolsForLabel(hudson.model.Label label)

Returns a list of NodePool objects that match the specified label.

Parameters:

label - the label to match

Returns:

a list of zero or more matching NodePool objects

provisionNode

public void provisionNode(hudson.model.Label label,
                          hudson.model.Queue.Task task,
                          long queueID)
                   throws IllegalArgumentException,
                          Exception

Submit request for node(s) required to execute the given task based on the nodes associated with the specified label.

Parameters:

label - the label attribute to filter the list of available nodes

task - the task the node is being provisioned for

queueID - the Queue id for the supplied task

Throws:

IllegalArgumentException - if timeout is less than 1 second

Exception - if an error occurs managing the provision components

setNodePools

@DataBoundSetter
public void setNodePools(List<NodePool> nodePools)

stream

public Stream<NodePool> stream()

getJobHistory

public NodePoolJobHistory getJobHistory()