com.rackspace.jenkins_nodepool

Class NodePool

java.lang.Object

com.rackspace.jenkins_nodepool.NodePool

All Implemented Interfaces:

hudson.model.Describable<NodePool>

public class NodePool
extends Object
implements hudson.model.Describable<NodePool>

Representation of a ZooKeeper+NodePool cluster configuration.

Instances hold configuration data entered in the Jenkins UI and are serialised/deserialised via Stapler. This class does not implement serialisable, it would be useful if it did, as then readObject could be used to initTransients. However making it serialisable causes problems with the Charset field which doesn't implement serialisable but does serialise just fine * via xstreame :/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodePool.NodePoolDescriptor Descriptor class to support configuration of a NodePool instance in the Jenkins UI

Constructor Summary

Constructors

Constructor and Description
NodePool(String connectionString, String credentialsId, String labelPrefix, String requestRoot, String priority, String requestor, String zooKeeperRoot, String nodeRoot, Integer requestTimeout, String jdkInstallationScript, String jdkHome, Integer installTimeout, Integer maxAttempts) Constructor invoked by Jenkins's Stapler library.

Method Summary

Modifier and Type	Method and Description
List<NodePoolNode>	acceptNodes(NodeRequest request) Accept the node that was created to satisfy the given request.
static org.apache.curator.framework.CuratorFramework	createZKConnection(String connectionString, String zkRoot) Create a curator managed connection to ZooKeeper
boolean	equals(Object other) Equals based on connection string
Charset	getCharset()
org.apache.curator.framework.CuratorFramework	getConn()
String	getConnectionString()
String	getCredentialsId()
hudson.model.Descriptor<NodePool>	getDescriptor()
com.google.gson.Gson	getGson()
String	getJdkHome() Returns the JDK Home for this node.
String	getJdkInstallationScript() Returns the JDK installation script.
String	getLabelPrefix()
String	getNodeRoot()
String	getPriority()
String	getRequestor()
String	getRequestRoot()
List<NodeRequest>	getRequests()
Integer	getRequestTimeout()
String	getZooKeeperRoot()
int	hashCode() Hash Code based on connection string
String	nodePoolLabelFromJenkinsLabel(String jenkinsLabel) Convert the given jenkins label into its NodePool equivalent
void	provisionNode(NodePoolJob job) Submit request for node(s) required to execute the given task based on the nodes associated with the specified label.
void	setConnectionString(String connectionString)
void	setCredentialsId(String credentialsId)
void	setLabelPrefix(String labelPrefix)
void	setNodeRoot(String nodeRoot)
void	setPriority(String priority)
void	setRequestor(String requestor)
void	setRequestRoot(String requestRoot)
void	setRequests(List<NodeRequest> requests)
void	setRequestTimeout(Integer requestTimeout)
void	setZooKeeperRoot(String zooKeeperRoot)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NodePool

@DataBoundConstructor
public NodePool(String connectionString,
                                      String credentialsId,
                                      String labelPrefix,
                                      String requestRoot,
                                      String priority,
                                      String requestor,
                                      String zooKeeperRoot,
                                      String nodeRoot,
                                      Integer requestTimeout,
                                      String jdkInstallationScript,
                                      String jdkHome,
                                      Integer installTimeout,
                                      Integer maxAttempts)

Constructor invoked by Jenkins's Stapler library.

Parameters:

connectionString - ZooKeeper connection string

credentialsId - Credential information identifier

labelPrefix - Prefix for labels served by this NodePool cluster

requestRoot - Prefix of node requests

priority - Priority value of node requests

requestor - Name of process making node requests

zooKeeperRoot - Prefix of all NodePool-related ZNodes

nodeRoot - Prefix of nodes

requestTimeout - Length of time to wait for node requests to be fulfilled

jdkInstallationScript - the JDK installation script

jdkHome - the JDK home

installTimeout - timeout in seconds to connect to a new node and provision the JRE

maxAttempts - maximum number of times to try to provision the node

Method Detail

createZKConnection

public static org.apache.curator.framework.CuratorFramework createZKConnection(String connectionString,
                                                                               String zkRoot)

Create a curator managed connection to ZooKeeper

Parameters:

connectionString - ZooKeeper connection string

zkRoot - root path to prefix onto all Curator (ZK) requests

Returns:

CuratorFramework connection wrapper instance

hashCode

public int hashCode()

Hash Code based on connection string

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Equals based on connection string

Overrides:

equals in class Object

acceptNodes

public List<NodePoolNode> acceptNodes(NodeRequest request)
                               throws Exception

Accept the node that was created to satisfy the given request.

Parameters:

request - node request

Returns:

node name as a String

Throws:

Exception - on ZooKeeper error

getRequestTimeout

public Integer getRequestTimeout()

setRequestTimeout

public final void setRequestTimeout(Integer requestTimeout)

getCharset

public Charset getCharset()

getConn

public org.apache.curator.framework.CuratorFramework getConn()

getConnectionString

public String getConnectionString()

getCredentialsId

public String getCredentialsId()

getJdkInstallationScript

public String getJdkInstallationScript()

Returns the JDK installation script.

Returns:

the JDK installation script.

getJdkHome

public String getJdkHome()

Returns the JDK Home for this node.

Returns:

the JDK home for his node.

getDescriptor

public hudson.model.Descriptor<NodePool> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<NodePool>

getGson

public com.google.gson.Gson getGson()

getLabelPrefix

public String getLabelPrefix()

getNodeRoot

public String getNodeRoot()

getPriority

public String getPriority()

getRequestRoot

public String getRequestRoot()

getRequestor

public String getRequestor()

getRequests

public List<NodeRequest> getRequests()

getZooKeeperRoot

public final String getZooKeeperRoot()

nodePoolLabelFromJenkinsLabel

public String nodePoolLabelFromJenkinsLabel(String jenkinsLabel)

Convert the given jenkins label into its NodePool equivalent

Parameters:

jenkinsLabel - jenkins label

Returns:

NodePool label without the prefix

setConnectionString

public void setConnectionString(String connectionString)

setCredentialsId

public void setCredentialsId(String credentialsId)

setLabelPrefix

public void setLabelPrefix(String labelPrefix)

setNodeRoot

public void setNodeRoot(String nodeRoot)

setPriority

public void setPriority(String priority)

setRequestRoot

public void setRequestRoot(String requestRoot)

setRequestor

public void setRequestor(String requestor)

setRequests

public void setRequests(List<NodeRequest> requests)

setZooKeeperRoot

public void setZooKeeperRoot(String zooKeeperRoot)

provisionNode

public void provisionNode(NodePoolJob job)
                   throws Exception

Submit request for node(s) required to execute the given task based on the nodes associated with the specified label. Uses a default timeout of 60 seconds.

Parameters:

job - the job to execute

Throws:

IllegalArgumentException - if timeout is less than 1 second

Exception - if an error occurs managing the provision components

toString

public String toString()

Overrides:

toString in class Object