com.rackspace.jenkins_nodepool

Class ZooKeeperObject<T>

java.lang.Object

com.rackspace.jenkins_nodepool.ZooKeeperObject<T>

public class ZooKeeperObject<T>
extends Object

A wrapper class for Zookeeper Objects.

Constructor Summary

Constructors

Constructor and Description
ZooKeeperObject(String path, String zKID, org.apache.curator.framework.CuratorFramework conn, Class<T> typeParameterClass) Creates a new Zookeeper object model.

Method Summary

Modifier and Type	Method and Description
String	asJSON() Returns the associated data model as a JSON string
void	delete() Deletes the associated Zookeeper Node.
String	getConnectionString() Returns the connection string associated with this object.
String	getPath() Returns the path for the object.
String	getZKID() Returns the id for the object.
String	idFromPath(String path) Extracts the ID from the provided path.
T	load() See load(Boolean)
T	load(Boolean create) Reads the data model from Zookeeper.
String	save(T model) Saves the specified model to Zookeeper
String	save(T model, org.apache.zookeeper.CreateMode mode) Saves the specified model to Zookeeper using the given create mode attribute.
void	setPath(String path) Sets the path for the object.
void	setZKID(String zKID) Sets the ID for the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZooKeeperObject

public ZooKeeperObject(String path,
                       String zKID,
                       org.apache.curator.framework.CuratorFramework conn,
                       Class<T> typeParameterClass)

Creates a new Zookeeper object model.

Parameters:

path - the Zookeeper node path

zKID - the zookeeper node id

conn - the ZK connection object

typeParameterClass - the type of the class - used to assist in marshalling/unmarshalling

Method Detail

getConnectionString

public String getConnectionString()

Returns the connection string associated with this object.

Returns:

the connection string associated with this object.

getPath

public String getPath()

Returns the path for the object.

Returns:

the path for the underlying object.

setPath

public void setPath(String path)

Sets the path for the object.

Parameters:

path - the path value

getZKID

public String getZKID()

Returns the id for the object.

Returns:

the id for the object.

setZKID

public void setZKID(String zKID)

Sets the ID for the object.

Parameters:

zKID - the ID value

save

public String save(T model)
            throws ZookeeperException

Saves the specified model to Zookeeper

Parameters:

model - the data model

Returns:

the path for the data

Throws:

ZookeeperException - if an error occurs while saving the data model to Zookeeper node

save

public String save(T model,
                   org.apache.zookeeper.CreateMode mode)
            throws ZookeeperException

Saves the specified model to Zookeeper using the given create mode attribute. Note: if the CreateMode is one of the SEQUENTIAL varieties, then the generated node id (ZKID) will will be updated appropriately.

Parameters:

model - the data model

mode - the Zookeeper create mode

Returns:

the path for the data

Throws:

ZookeeperException - if an error occurs while saving the data model to Zookeeper node

load

public T load()
       throws ZookeeperException

See load(Boolean)

Returns:

the data model as a Java object

Throws:

ZookeeperException - if an error occurs while reading the data model from the Zookeeper node

load

public T load(Boolean create)
       throws ZookeeperException

Reads the data model from Zookeeper.

Parameters:

create - Creates a new znode if the required path doesn't exist

Returns:

the data model as a Java object

Throws:

ZookeeperException - if an error occurs while reading the data model from the Zookeeper node

delete

public void delete()

Deletes the associated Zookeeper Node.

idFromPath

public String idFromPath(String path)
                  throws NodePoolException

Extracts the ID from the provided path.

Parameters:

path - the path to the data

Returns:

the ID portion of the path.

Throws:

NodePoolException - if path is null, empty or otherwise malformed

asJSON

public String asJSON()
              throws ZookeeperException

Returns the associated data model as a JSON string

Returns:

the associated data model as a JSON string

Throws:

ZookeeperException - if an error occurs while loading and converting the data model