com.rackspace.jenkins_nodepool

Class NodePoolNode

java.lang.Object

com.rackspace.jenkins_nodepool.ZooKeeperObject

com.rackspace.jenkins_nodepool.NodePoolNode

public class NodePoolNode
extends ZooKeeperObject

Representation of a node from NodePool (not necessarily a Jenkins slave)

Constructor Summary

Constructors

Constructor and Description
NodePoolNode(NodePool nodePool, String id) Creates a new Zookeeper node for the node pool.

Method Summary

Modifier and Type	Method and Description
String	getHost() Returns the host.
String	getHostKey() Returns the first host key.
List<String>	getHostKeys() Returns the host keys.
String	getJenkinsLabel() Get Jenkins's version of the node label
String	getName()
NodePool	getNodePool() Used to render node editing page in the UI
List<String>	getNPTypes() Returns a list of NodePool type labels.
Integer	getPort() Returns the connection port.
String	getProvider() Get the name of the provider that provisioned this node
void	hold(String jobIdentifier) Mark the node as being held.
void	release() Mark the node as being used and release it.
void	setInUse() Sets the NodePool state to IN USE.
String	toString() Returns the string representation for this object.

Methods inherited from class com.rackspace.jenkins_nodepool.ZooKeeperObject

createZNode, delete, exists, getFromZK, getJson, getPath, getZKID, setPath, setZKID, updateFromMap, updateFromZK, writeToZK

Methods inherited from class java.lang.Object

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

Constructor Detail

NodePoolNode

public NodePoolNode(NodePool nodePool,
                    String id)
             throws Exception

Creates a new Zookeeper node for the node pool.

Parameters:

nodePool - NodePool

id - id of node as represented in ZooKeeper

Throws:

Exception - on ZooKeeper error

Method Detail

getNPTypes

public List<String> getNPTypes()

Returns a list of NodePool type labels.

Returns:

an array of NodePool labels

getProvider

public String getProvider()

Get the name of the provider that provisioned this node

Returns:

String name of the provider

getJenkinsLabel

public String getJenkinsLabel()

Get Jenkins's version of the node label

Returns:

Jenkins label

getName

public String getName()

getNodePool

public NodePool getNodePool()

Used to render node editing page in the UI

Returns:

node pool object

getHost

public String getHost()

Returns the host.

Returns:

the host

getPort

public Integer getPort()

Returns the connection port.

Returns:

the connection port

getHostKey

public String getHostKey()

Returns the first host key.

Returns:

the first host key

getHostKeys

public List<String> getHostKeys()

Returns the host keys.

Returns:

the host keys

toString

public String toString()

Returns the string representation for this object.

Overrides:

toString in class Object

Returns:

the string representation for this object.

hold

public void hold(String jobIdentifier)
          throws Exception

Mark the node as being held. A held node must be manually deleted from NodePool.

Parameters:

jobIdentifier - identifier of build/job that this node was running.

Throws:

Exception - on ZK error

setInUse

public void setInUse()
              throws Exception

Sets the NodePool state to IN USE.

Throws:

Exception - if an error occurs while setting the state

release

public void release()
             throws Exception

Mark the node as being used and release it. It will be destroyed by NodePool.

Throws:

Exception - on ZooKeeper error