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

Modifier and Type	Field and Description
static long	DEFAULT_HOLD_DURATION_MS The default hold duration expressed in milliseconds.
static String	DEFAULT_HOLD_UNTIL_VALUE
static long	MAX_HOLD_DURATION_MS The maximum hold duration currently allowed expressed in milliseconds.

Fields inherited from class hudson.model.Slave

name, remoteFS

Fields inherited from class hudson.model.Node

holdOffLaunchUntilSave, SKIP_BUILD_CHECK_ON_FLYWEIGHTS

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
NodePoolSlave(NodePoolNode nodePoolNode, String credentialsId, NodePoolJob npj, String jdkHome, String jdkInstallationScript) 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.
String	getBuildUrl()
hudson.model.Slave.SlaveDescriptor	getDescriptor()
String	getHoldReason() Returns the hold reason value.
long	getHoldUnitEpochMs() Returns the hold until time as the number of milliseconds since epoch.
String	getHoldUntil() Returns the hold until string value.
String	getHoldUntilTimeFormatted() Returns the hold until time formatted as a UTC ISO date/time.
String	getHoldUser() Returns the user requesting the hold.
NodePoolJob	getJob() Get the NodePoolJob this slave was created for
NodePoolJob	getNodePoolJob() Get a reference to the nodepoolJob related to this agent
NodePoolNode	getNodePoolNode()
Boolean	isFinished()
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	removeHoldUntil() Removes the node hold until time.
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	setHoldUntil(String holdUntil, boolean resetHoldUntil) Sets the hold until value which represents a duration encoded as: 1h, 2d, 3w, 6m format.
void	setHoldUntilEpochMs(long holdUntilEpochMs) Sets the hold until time as the number of milliseconds since epoch.
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, createPath, getACL, getAssignedLabels, getChannel, getClockDifference, getDisplayName, getFileSystemProvisioner, getLabelCloud, getNodeProperty, getNodeProperty, getNodePropertyDescriptors, getSearchUrl, getSelfLabel, 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

Methods inherited from interface hudson.security.AccessControlled

checkPermission, hasPermission, hasPermission

Field Detail

DEFAULT_HOLD_UNTIL_VALUE

public static final String DEFAULT_HOLD_UNTIL_VALUE

See Also:

Constant Field Values

DEFAULT_HOLD_DURATION_MS

public static final long DEFAULT_HOLD_DURATION_MS

The default hold duration expressed in milliseconds.

MAX_HOLD_DURATION_MS

public static final long MAX_HOLD_DURATION_MS

The maximum hold duration currently allowed expressed in milliseconds.

Constructor Detail

NodePoolSlave

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

Create a new slave

Parameters:

nodePoolNode - the node from NodePool

credentialsId - the Jenkins credential identifier

npj - The job this slave/agent was created for

jdkHome - the JDK home folder

jdkInstallationScript - the script for installing the JDK

Throws:

Descriptor.FormException - on configuration exception

IOException - on configuration exception

Method Detail

getJob

public NodePoolJob getJob()

Get the NodePoolJob this slave was created for

Returns:

NodePoolJob object

getNodePoolNode

public NodePoolNode getNodePoolNode()

getBuildUrl

public String getBuildUrl()

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

getHoldUntil

public String getHoldUntil()

Returns the hold until string value.

Returns:

the hold until string value.

getNodePoolJob

public NodePoolJob getNodePoolJob()

Get a reference to the nodepoolJob related to this agent

Returns:

nodePoolJob object.

setHoldUntil

public void setHoldUntil(String holdUntil,
                         boolean resetHoldUntil)

Sets the hold until value which represents a duration encoded as: 1h, 2d, 3w, 6m format.

If the hold until value has NOT changed from the previous value and the reset hold until is false then the existing hold until value will not change and remain as previously calculated.

If the the reset hold flag is true it will recalculate the hold until time based on the current time (hold until = current time + hold until time duration - example: * hold until = now + 1d).

Scenarios:

• holdUntil value changed, reset flag true => recalculate hold until time
• holdUntil value changed, reset flag false => recalculate hold until time
• holdUntil value not changed, reset flag true => recalculate hold until time
• holdUntil value not changed, reset flag false => use existing value

Parameters:

holdUntil - the hold until string value

resetHoldUntil - flag to indicate if we should extend/renew/reset the hold until time. If true, will reset the hold until value to the specified duration from the current time. Otherwise, if the hold util value is the same it will leave the existing hold until time unchanged.

removeHoldUntil

public void removeHoldUntil()

Removes the node hold until time.

getHoldUnitEpochMs

public long getHoldUnitEpochMs()

Returns the hold until time as the number of milliseconds since epoch.

Returns:

the hold until time as the number of milliseconds since epoch.

setHoldUntilEpochMs

public void setHoldUntilEpochMs(long holdUntilEpochMs)

Sets the hold until time as the number of milliseconds since epoch.

Parameters:

holdUntilEpochMs - the hold until time as the number of milliseconds since epoch.

getHoldUntilTimeFormatted

public String getHoldUntilTimeFormatted()

Returns the hold until time formatted as a UTC ISO date/time.

Returns:

the hold until time formatted as a UTC ISO date/time.

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

isFinished

public Boolean isFinished()