com.rackspace.jenkins_nodepool

Class NodeRequest

java.lang.Object

com.rackspace.jenkins_nodepool.NodeRequest

public class NodeRequest
extends Object

Represents a nodepool node request. Data format is JSON dump of following dict structure: --- node_types: - label1 - label2 requestor: string id (eg hostname) state: string requested|pending|fulfilled|failed state_time: float seconds since epoch

Author:

hughsaunders

Constructor Summary

Constructors

Constructor and Description
NodeRequest(NodePool nodePool, String baseId, NodePoolJob npj) Create new request

Method Summary

Modifier and Type	Method and Description
boolean	addAllocatedNodes(List<String> nodes) Adds the specified allocated nodes to the existing list of nodes.
void	delete() Deletes the Node Request.
String	getAge() Returns the age of this request.
List<String>	getAllocatedNodeNames() Get node names only from the local cache of the ZNode
List<NodePoolNode>	getAllocatedNodes() Get list of NodePool nodes that have been allocated to fulfill this request
hudson.model.Label	getJenkinsLabel() Returns the jenkins label for this node request.
NodePoolJob	getJob() Returns the NodePoolJob associated with this request
String	getModelAsJSON() Returns the node request model as JSON.
String	getNodePoolLabel() Returns the node pool label for the node request.
String	getPath() Returns the path associated with this request.
NodePoolState	getState() Returns the requested state value from the data model.
hudson.model.Queue.Task	getTask() Returns the task associated with this request.
String	getZKID() Returns the ID associated with this request.
boolean	setAllocatedNodes(List<String> nodes) Sets the allocated nodes to the specified value.
String	toString() Get a string representation of this object, in JSON.
boolean	updateState(NodePoolState state) Updates the node request state to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NodeRequest

public NodeRequest(NodePool nodePool,
                   String baseId,
                   NodePoolJob npj)
            throws Exception

Create new request

Parameters:

nodePool - NodePool cluster to use

baseId - the base id string for the request - used to generate the full id which will be a combination of the base ID + a dash + a sequential value, such as 100-0001334443

npj - Associated NodePoolJob which contains the task

Throws:

Exception - on ZooKeeper error

Method Detail

getState

public NodePoolState getState()

Returns the requested state value from the data model.

Returns:

the requested state value from the data model.

updateState

public boolean updateState(NodePoolState state)

Updates the node request state to the specified value.

Parameters:

state - the state value to set in the node request.

Returns:

true if successful, false otherwise

getJob

public NodePoolJob getJob()

Returns the NodePoolJob associated with this request

Returns:

NodePoolJob

getAllocatedNodeNames

public List<String> getAllocatedNodeNames()

Get node names only from the local cache of the ZNode

Returns:

list of node names

toString

public String toString()

Get a string representation of this object, in JSON.

Overrides:

toString in class Object

Returns:

JSON representation of this object, same as is stored in zookeeper.

getAllocatedNodes

public List<NodePoolNode> getAllocatedNodes()
                                     throws Exception

Get list of NodePool nodes that have been allocated to fulfill this request

Returns:

list of nodes

Throws:

Exception - on ZooKeeper error

setAllocatedNodes

public boolean setAllocatedNodes(List<String> nodes)

Sets the allocated nodes to the specified value.

Parameters:

nodes - a list of node values as a string

Returns:

true if successful, false otherwise

addAllocatedNodes

public boolean addAllocatedNodes(List<String> nodes)

Adds the specified allocated nodes to the existing list of nodes.

Parameters:

nodes - a list of node values as a string

Returns:

true if successful, false otherwise

getNodePoolLabel

public String getNodePoolLabel()

Returns the node pool label for the node request.

Returns:

the node pool label

getJenkinsLabel

public hudson.model.Label getJenkinsLabel()

Returns the jenkins label for this node request.

Returns:

the jenkins label

getAge

public String getAge()

Returns the age of this request.

Returns:

the age of this request.

getTask

public hudson.model.Queue.Task getTask()

Returns the task associated with this request.

Returns:

the task associated with this request

getZKID

public String getZKID()

Returns the ID associated with this request.

Returns:

the ID associated with this request

getPath

public String getPath()

Returns the path associated with this request.

Returns:

the path associated with this request

delete

public void delete()

Deletes the Node Request.

getModelAsJSON

public String getModelAsJSON()

Returns the node request model as JSON.

Returns:

the node request model as JSON.