Package org.cdlib.mrt.zk

Class Batch

java.lang.Object

org.cdlib.mrt.zk.QueueItem

org.cdlib.mrt.zk.Batch

public class Batch
extends QueueItem

Class to manage a Merritt Ingest Batch in the Batch Queue.

See Also:

• State Transition Design

Nested Class Summary

Nested classes/interfaces inherited from class org.cdlib.mrt.zk.QueueItem

QueueItem.BatchJobStates, QueueItem.ZkPaths, QueueItem.ZkPrefixes

Field Summary

Fields inherited from class org.cdlib.mrt.zk.QueueItem

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Batch	acquireBatchForReporting(org.apache.zookeeper.ZooKeeper client)
static Batch	acquirePendingBatch(org.apache.zookeeper.ZooKeeper client)
static Batch	acquireUpdateBatchForReporting(org.apache.zookeeper.ZooKeeper client)
String	batchUuid()
static String	batchUuidPath(String uuid)
static Batch	createBatch(org.apache.zookeeper.ZooKeeper client, org.json.JSONObject submission)
void	delete(org.apache.zookeeper.ZooKeeper client)
static List<String>	deleteCompletedBatches(org.apache.zookeeper.ZooKeeper client)
static List<String>	deleteDeletedJobs(org.apache.zookeeper.ZooKeeper client)
String	dir()
static Batch	findByUuid(org.apache.zookeeper.ZooKeeper client, String uuid)
List<Job>	getCompletedJobs(org.apache.zookeeper.ZooKeeper client)
List<Job>	getDeletedJobs(org.apache.zookeeper.ZooKeeper client)
List<Job>	getFailedJobs(org.apache.zookeeper.ZooKeeper client)
List<Job>	getJobs(org.apache.zookeeper.ZooKeeper client, QueueItem.BatchJobStates state)
List<Job>	getProcessingJobs(org.apache.zookeeper.ZooKeeper client)
boolean	hasFailure()	Indicate that a batch contains a failed job in the Job Queue.
static IngestState	initStatus()
void	loadHasFailure(org.apache.zookeeper.ZooKeeper client)
void	loadProperties(org.apache.zookeeper.ZooKeeper client, boolean setStatus)
static void	main(String[] argv)
String	prefix()
static String	prefixPath()
IngestState	resolveStatus(String s)
IngestState[]	states()

Methods inherited from class org.cdlib.mrt.zk.QueueItem

createData, createOrSetData, data, id, intProperty, jsonDataProperty, jsonIntProperty, jsonLongProperty, jsonProperty, jsonStringProperty, load, load, loadStatus, lock, longProperty, makePath, optJsonProperty, optStringProperty, path, setData, setStatus, setStatus, setStatusTrigger, status, statusObject, stringProperty, unlock

Methods inherited from class java.lang.Object

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

Constructor Details

Batch

public Batch(String id)

Parameters:

id - Unique id assigned to a batch. This id is generated by creating a sequential batch folder.

Batch

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

Parameters:

id - Unique id assigned to a batch. This id is generated by creating a sequential batch folder.

data - JSON representation of an ingest initiated by a Merritt depostor.

Method Details

hasFailure

public boolean hasFailure()

Indicate that a batch contains a failed job in the Job Queue.

Returns:

true if a failed job exists for the batch

dir

public String dir()

Specified by:

dir in class QueueItem

prefix

public String prefix()

Specified by:

prefix in class QueueItem

prefixPath

public static String prefixPath()

initStatus

public static IngestState initStatus()

loadHasFailure

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

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

resolveStatus

public IngestState resolveStatus(String s)

Specified by:

resolveStatus in class QueueItem

batchUuid

public String batchUuid()

loadProperties

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

Overrides:

loadProperties in class QueueItem

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

MerrittZKNodeInvalid

states

public IngestState[] states()

Specified by:

states in class QueueItem

batchUuidPath

public static String batchUuidPath(String uuid)

createBatch

public static Batch createBatch(org.apache.zookeeper.ZooKeeper client,
 org.json.JSONObject submission)
                         throws org.apache.zookeeper.KeeperException,
InterruptedException,
MerrittZKNodeInvalid,
MerrittStateError

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

MerrittZKNodeInvalid

MerrittStateError

delete

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

Specified by:

delete in class QueueItem

Throws:

MerrittStateError

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

acquirePendingBatch

public static Batch acquirePendingBatch(org.apache.zookeeper.ZooKeeper client)
                                 throws MerrittZKNodeInvalid,
org.apache.zookeeper.KeeperException,
InterruptedException,
MerrittStateError

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

MerrittStateError

acquireBatchForReporting

public static Batch acquireBatchForReporting(org.apache.zookeeper.ZooKeeper client)
                                      throws MerrittZKNodeInvalid,
org.apache.zookeeper.KeeperException,
InterruptedException,
MerrittStateError

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

MerrittStateError

acquireUpdateBatchForReporting

public static Batch acquireUpdateBatchForReporting(org.apache.zookeeper.ZooKeeper client)
                                            throws MerrittZKNodeInvalid,
org.apache.zookeeper.KeeperException,
InterruptedException,
MerrittStateError

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

MerrittStateError

deleteCompletedBatches

public static List<String> deleteCompletedBatches(org.apache.zookeeper.ZooKeeper client)
                                           throws MerrittZKNodeInvalid,
org.apache.zookeeper.KeeperException,
InterruptedException,
MerrittStateError

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

MerrittStateError

deleteDeletedJobs

public static List<String> deleteDeletedJobs(org.apache.zookeeper.ZooKeeper client)
                                      throws MerrittZKNodeInvalid,
org.apache.zookeeper.KeeperException,
InterruptedException,
MerrittStateError

Throws:

MerrittZKNodeInvalid

org.apache.zookeeper.KeeperException

InterruptedException

MerrittStateError

getProcessingJobs

public List<Job> getProcessingJobs(org.apache.zookeeper.ZooKeeper client)
                            throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getCompletedJobs

public List<Job> getCompletedJobs(org.apache.zookeeper.ZooKeeper client)
                           throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getFailedJobs

public List<Job> getFailedJobs(org.apache.zookeeper.ZooKeeper client)
                        throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getDeletedJobs

public List<Job> getDeletedJobs(org.apache.zookeeper.ZooKeeper client)
                         throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getJobs

public List<Job> getJobs(org.apache.zookeeper.ZooKeeper client,
 QueueItem.BatchJobStates state)
                  throws org.apache.zookeeper.KeeperException,
InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

findByUuid

public static Batch findByUuid(org.apache.zookeeper.ZooKeeper client,
 String uuid)
                        throws org.apache.zookeeper.KeeperException,
InterruptedException,
MerrittZKNodeInvalid

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

MerrittZKNodeInvalid

main

public static void main(String[] argv)