com.rackspace.jenkins_nodepool

Class NodePoolNode

java.lang.Object

com.rackspace.jenkins_nodepool.NodePoolNode

public class NodePoolNode
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getConnectionString() Returns the connection string for the underlying NodePool object.
Long	getHoldUntil() Returns the hold until time (in milliseconds since epoch) for this Node.
String	getHost() Returns the host or interface IP for the node.
String	getHostKey() Returns the first host key.
List<String>	getHostKeys() Returns the host keys.
String	getJenkinsLabel() Get Jenkins's version of the node label
NodePoolJob	getJob() Get the NodePoolJob associated with this node
String	getName() Returns the name for this node.
List<String>	getNPTypes() Returns a list of NodePool type labels.
String	getPath() Returns the path for the underlying NodePool object.
Integer	getPort() Returns the connection port.
String	getProvider() Get the name of the provider that provisioned this node
String	getZKID() Returns the id for the underlying NodePool object.
void	hold(String jobIdentifier) Mark the node as being held.
void	release() Mark the node as being used and release it.
void	removeHoldUntil() Removes the node hold until time.
void	setHoldUntil(Long holdUntilTimeEpochMillis) Sets the node hold until time (ms since epoch).
void	setInUse() Sets the NodePool state to IN USE.
String	toString() Returns the string representation for this object.

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,
                    NodePoolJob npj)
             throws ZookeeperException

Creates a new Zookeeper node for the node pool.

Parameters:

nodePool - NodePool

id - id of node as represented in ZooKeeper

npj - NodePoolJob object representing the build that this node was requested for.

Throws:

ZookeeperException - on ZooKeeper error

Method Detail

getJob

public NodePoolJob getJob()

Get the NodePoolJob associated with this node

Returns:

NodePoolJob object

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, or null if not set

getPath

public String getPath()

Returns the path for the underlying NodePool object.

Returns:

the path for the underlying NodePool object.

getZKID

public String getZKID()

Returns the id for the underlying NodePool object.

Returns:

the id for the underlying NodePool object.

getConnectionString

public String getConnectionString()

Returns the connection string for the underlying NodePool object.

Returns:

the connection string for the underlying NodePool object.

getJenkinsLabel

public String getJenkinsLabel()

Get Jenkins's version of the node label

Returns:

Jenkins label

getName

public String getName()

Returns the name for this node.

Returns:

the name for this node

getHost

public String getHost()

Returns the host or interface IP for the node.

Returns:

the host / interface IP or null if not set

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

getHoldUntil

public Long getHoldUntil()

Returns the hold until time (in milliseconds since epoch) for this Node.

Returns:

the hold until time value for this Node.

setHoldUntil

public void setHoldUntil(Long holdUntilTimeEpochMillis)

Sets the node hold until time (ms since epoch).

Parameters:

holdUntilTimeEpochMillis - the hold until time in milliseconds since epoch

removeHoldUntil

public void removeHoldUntil()

Removes the node hold until time.

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