com.rackspace.jenkins_nodepool

Class NodePoolSlave

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Node

hudson.model.Slave

com.rackspace.jenkins_nodepool.NodePoolSlave

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.Node>, hudson.model.ModelObject, hudson.model.ReconfigurableDescribable<hudson.model.Node>, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled, Serializable, jenkins.util.io.OnMaster

public class NodePoolSlave
extends hudson.model.Slave

Representation of a Jenkins slave sourced from NodePool.

Author:

hughsaunders

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodePoolSlave.NodePoolSlaveDescriptor It makes jelly rendering on the node configuration page happy to have this defined.

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

hudson.model.Slave.JnlpJar, hudson.model.Slave.SlaveDescriptor

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

hudson.model.Node.InternalComputerListener, hudson.model.Node.Mode

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Slave

name, remoteFS

Fields inherited from class hudson.model.Node

holdOffLaunchUntilSave

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
NodePoolSlave(NodePoolNode nodePoolNode, String credentialsId) Create a new slave

Method Summary

Modifier and Type	Method and Description
hudson.model.Computer	createComputer() Returns a new computer based on the nodepool node object associated with this class instance.
hudson.model.Slave.SlaveDescriptor	getDescriptor()
String	getHoldReason() Returns the hold reason value.
String	getHoldUser() Returns the user requesting the hold.
NodePoolNode	getNodePoolNode()
boolean	isHeld() If true, hold onto the node after the associated build is completed.
hudson.model.Node	reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form) This gets invoked when the user clicks "Save" while editing the "Node" in the UI.
void	setHeld(boolean held) Set to true in order to hold the node after the build is completed.
void	setHoldReason(String holdReason) Sets the hold reason value.
void	setHoldUser(String holdUser) Sets the user id for the user requesting the node hold.

Methods inherited from class hudson.model.Slave

createLauncher, equals, getClockDifferenceCallable, getComputer, getLabelString, getLauncher, getMode, getNodeDescription, getNodeName, getNodeProperties, getNumExecutors, getRemoteFS, getRetentionStrategy, getRootPath, getUserId, getWorkspaceFor, getWorkspaceRoot, hashCode, readResolve, setLabelString, setLauncher, setMode, setNodeDescription, setNodeName, setNodeProperties, setNumExecutors, setRetentionStrategy, setUserId, toString

Methods inherited from class hudson.model.Node

canTake, canTake, checkPermission, createPath, getACL, getAssignedLabels, getChannel, getClockDifference, getDisplayName, getFileSystemProvisioner, getLabelCloud, getNodeProperty, getNodeProperty, getNodePropertyDescriptors, getSearchUrl, getSelfLabel, hasPermission, isAcceptingTasks, isHoldOffLaunchUntilSave, save, toComputer

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Constructor Detail

NodePoolSlave

@DataBoundConstructor
public NodePoolSlave(NodePoolNode nodePoolNode,
                                           String credentialsId)
                                    throws hudson.model.Descriptor.FormException,
                                           IOException

Create a new slave

Parameters:

nodePoolNode - the node from NodePool

credentialsId - the Jenkins credential identifier

Throws:

Descriptor.FormException - on configuration exception

IOException - on configuration exception

Method Detail

getNodePoolNode

public NodePoolNode getNodePoolNode()

createComputer

public hudson.model.Computer createComputer()

Returns a new computer based on the nodepool node object associated with this class instance.

Overrides:

createComputer in class hudson.model.Slave

Returns:

a new computer based on the nodepool node object associated with this class instance.

reconfigure

public hudson.model.Node reconfigure(org.kohsuke.stapler.StaplerRequest req,
                                     net.sf.json.JSONObject form)
                              throws hudson.model.Descriptor.FormException

This gets invoked when the user clicks "Save" while editing the "Node" in the UI.

Specified by:

reconfigure in interface hudson.model.ReconfigurableDescribable<hudson.model.Node>

Overrides:

reconfigure in class hudson.model.Node

Parameters:

req - stapler request

form - form data to update slave with

Returns:

new slave object

Throws:

Descriptor.FormException - if things go sideways

isHeld

public boolean isHeld()

If true, hold onto the node after the associated build is completed. Do not release it to NodePool to get cleaned up.

Returns:

true if node should be held.

setHeld

public void setHeld(boolean held)

Set to true in order to hold the node after the build is completed.

Parameters:

held - whether to hold the node after the build completes

getHoldReason

public String getHoldReason()

Returns the hold reason value.

Returns:

the value of the hold reason - typically a justification for the hold.

setHoldReason

public void setHoldReason(String holdReason)

Sets the hold reason value.

Parameters:

holdReason - the hold reason - typically a justification for the hold.

getHoldUser

public String getHoldUser()

Returns the user requesting the hold.

Returns:

the user requesting the hold.

setHoldUser

public void setHoldUser(String holdUser)

Sets the user id for the user requesting the node hold.

Parameters:

holdUser - the user id of the user requesting the node hold

getDescriptor

public hudson.model.Slave.SlaveDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.model.Node>

Overrides:

getDescriptor in class hudson.model.Slave