Package org.cdlib.mrt.zk

Class QueueItem

java.lang.Object

org.cdlib.mrt.zk.QueueItem

Direct Known Subclasses:

Access, Batch, Job

public abstract class QueueItem
extends Object

Base Class for Common functions for Merritt Ingest Batches and Merritt Ingest Jobs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueItem.BatchJobStates	Standardized path names for Merritt Zookeeper nodes
static class	QueueItem.ZkPaths	Standardized path names for Merritt Zookeeper nodes
static class	QueueItem.ZkPrefixes	Standardized prefix names for Merritt Zookeeper sequential nodes

Field Summary

Fields

Modifier and Type	Field	Description
protected org.json.JSONObject	data

Constructor Summary

Constructors

Constructor	Description
QueueItem(String id)
QueueItem(String id, org.json.JSONObject data)

Method Summary

Modifier and Type	Method	Description
void	createData(org.apache.zookeeper.ZooKeeper client, ZKKey key, Object data)
void	createOrSetData(org.apache.zookeeper.ZooKeeper client, ZKKey key, Object data)
org.json.JSONObject	data()
abstract void	delete(org.apache.zookeeper.ZooKeeper client)
abstract String	dir()
String	id()
int	intProperty(org.apache.zookeeper.ZooKeeper client, ZKKey key)
static Object	jsonDataProperty(org.json.JSONObject obj, MerrittJsonKey key, Object dval)
static int	jsonIntProperty(org.json.JSONObject obj, MerrittJsonKey key, int dval)
static long	jsonLongProperty(org.json.JSONObject obj, MerrittJsonKey key, long dval)
org.json.JSONObject	jsonProperty(org.apache.zookeeper.ZooKeeper client, ZKKey key)
static String	jsonStringProperty(org.json.JSONObject obj, MerrittJsonKey key, String dval)
QueueItem	load(org.apache.zookeeper.ZooKeeper client)
void	loadProperties(org.apache.zookeeper.ZooKeeper client)
void	loadStatus(org.apache.zookeeper.ZooKeeper client, org.json.JSONObject js)
boolean	lock(org.apache.zookeeper.ZooKeeper client)
long	longProperty(org.apache.zookeeper.ZooKeeper client, ZKKey key)
String	makePath(ZKKey key)
org.json.JSONObject	optJsonProperty(org.apache.zookeeper.ZooKeeper client, ZKKey key)
String	optStringProperty(org.apache.zookeeper.ZooKeeper client, ZKKey key)
String	path()
abstract String	prefix()
abstract IngestState	resolveStatus(String s)
void	setData(org.apache.zookeeper.ZooKeeper client, ZKKey key, Object data)
void	setStatus(org.apache.zookeeper.ZooKeeper client, IngestState status)
void	setStatus(org.apache.zookeeper.ZooKeeper client, IngestState status, String message)
void	setStatusTrigger(org.apache.zookeeper.ZooKeeper client)
abstract IngestState[]	states()
IngestState	status()
org.json.JSONObject	statusObject(IngestState status)
String	stringProperty(org.apache.zookeeper.ZooKeeper client, ZKKey key)
boolean	unlock(org.apache.zookeeper.ZooKeeper client)

Methods inherited from class java.lang.Object

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

Field Detail

data

protected org.json.JSONObject data

Constructor Detail

QueueItem

public QueueItem(String id)

QueueItem

public QueueItem(String id,
                 org.json.JSONObject data)

Method Detail

id

public String id()

data

public org.json.JSONObject data()

jsonDataProperty

public static Object jsonDataProperty(org.json.JSONObject obj,
                                      MerrittJsonKey key,
                                      Object dval)

jsonStringProperty

public static String jsonStringProperty(org.json.JSONObject obj,
                                        MerrittJsonKey key,
                                        String dval)

jsonIntProperty

public static int jsonIntProperty(org.json.JSONObject obj,
                                  MerrittJsonKey key,
                                  int dval)

jsonLongProperty

public static long jsonLongProperty(org.json.JSONObject obj,
                                    MerrittJsonKey key,
                                    long dval)

states

public abstract IngestState[] states()

status

public IngestState status()

dir

public abstract String dir()

prefix

public abstract String prefix()

path

public String path()

makePath

public String makePath(ZKKey key)

load

public QueueItem load(org.apache.zookeeper.ZooKeeper client)
               throws MerrittZKNodeInvalid,
                      org.apache.zookeeper.KeeperException,
                      InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

loadStatus

public void loadStatus(org.apache.zookeeper.ZooKeeper client,
                       org.json.JSONObject js)
                throws MerrittZKNodeInvalid

Throws:

MerrittZKNodeInvalid

resolveStatus

public abstract IngestState resolveStatus(String s)

loadProperties

public void loadProperties(org.apache.zookeeper.ZooKeeper client)
                    throws MerrittZKNodeInvalid,
                           org.apache.zookeeper.KeeperException,
                           InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

optStringProperty

public String optStringProperty(org.apache.zookeeper.ZooKeeper client,
                                ZKKey key)
                         throws org.apache.zookeeper.KeeperException,
                                InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

stringProperty

public String stringProperty(org.apache.zookeeper.ZooKeeper client,
                             ZKKey key)
                      throws MerrittZKNodeInvalid,
                             org.apache.zookeeper.KeeperException,
                             InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

jsonProperty

public org.json.JSONObject jsonProperty(org.apache.zookeeper.ZooKeeper client,
                                        ZKKey key)
                                 throws MerrittZKNodeInvalid,
                                        org.apache.zookeeper.KeeperException,
                                        InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

optJsonProperty

public org.json.JSONObject optJsonProperty(org.apache.zookeeper.ZooKeeper client,
                                           ZKKey key)
                                    throws MerrittZKNodeInvalid,
                                           org.apache.zookeeper.KeeperException,
                                           InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

intProperty

public int intProperty(org.apache.zookeeper.ZooKeeper client,
                       ZKKey key)
                throws MerrittZKNodeInvalid,
                       org.apache.zookeeper.KeeperException,
                       InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

longProperty

public long longProperty(org.apache.zookeeper.ZooKeeper client,
                         ZKKey key)
                  throws MerrittZKNodeInvalid,
                         org.apache.zookeeper.KeeperException,
                         InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

setData

public void setData(org.apache.zookeeper.ZooKeeper client,
                    ZKKey key,
                    Object data)
             throws org.apache.zookeeper.KeeperException,
                    InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

createData

public void createData(org.apache.zookeeper.ZooKeeper client,
                       ZKKey key,
                       Object data)
                throws org.apache.zookeeper.KeeperException,
                       InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

createOrSetData

public void createOrSetData(org.apache.zookeeper.ZooKeeper client,
                            ZKKey key,
                            Object data)
                     throws org.apache.zookeeper.KeeperException,
                            InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

statusObject

public org.json.JSONObject statusObject(IngestState status)

setStatus

public void setStatus(org.apache.zookeeper.ZooKeeper client,
                      IngestState status)
               throws org.apache.zookeeper.KeeperException,
                      InterruptedException,
                      MerrittZKNodeInvalid,
                      MerrittStateError

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

MerrittZKNodeInvalid

MerrittStateError

setStatus

public void setStatus(org.apache.zookeeper.ZooKeeper client,
                      IngestState status,
                      String message)
               throws org.apache.zookeeper.KeeperException,
                      InterruptedException,
                      MerrittZKNodeInvalid,
                      MerrittStateError

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

MerrittZKNodeInvalid

MerrittStateError

setStatusTrigger

public void setStatusTrigger(org.apache.zookeeper.ZooKeeper client)
                      throws MerrittZKNodeInvalid,
                             org.apache.zookeeper.KeeperException,
                             InterruptedException

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

lock

public boolean lock(org.apache.zookeeper.ZooKeeper client)
             throws InterruptedException

Throws:

InterruptedException

unlock

public boolean unlock(org.apache.zookeeper.ZooKeeper client)
               throws InterruptedException,
                      org.apache.zookeeper.KeeperException

Throws:

InterruptedException

org.apache.zookeeper.KeeperException

delete

public abstract void delete(org.apache.zookeeper.ZooKeeper client)
                     throws MerrittStateError,
                            MerrittZKNodeInvalid,
                            InterruptedException,
                            org.apache.zookeeper.KeeperException

Throws:

MerrittStateError

MerrittZKNodeInvalid

InterruptedException

org.apache.zookeeper.KeeperException