org.apache.oodt.cas.resource.jobqueue

Interface JobQueue

All Known Subinterfaces:

MappedJobQueue

All Known Implementing Classes:

FifoMappedJobQueue, JobStack

public interface JobQueue

Version:

$Revision$

An interface for persisting JobSpecs used by a JobQueueController.

.

Author:

mattmann

Method Summary

Modifier and Type	Method and Description
String	addJob(JobSpec spec) Persists a JobSpec to the queue.
int	getCapacity() Gets the max number of jobs allowed in queue at any given time
JobRepository	getJobRepository() Gets the underlying JobSpec persistance layer used by this JobQueue.
JobSpec	getNextJob() Gets the next JobSpec from the queue, and correspondingly removes it from persitance.
List	getQueuedJobs() Gets an ordered List of queued JobSpecs.
int	getSize() Gets the number of jobs in queue
boolean	isEmpty() Returns a boolean value representing whether or not the queue is empty.
void	purge() Purges all JobSpecs from the queue.
String	requeueJob(JobSpec spec) Re-adds a JobSpec to the back of the queue.

Method Detail

addJob

String addJob(JobSpec spec)
       throws JobQueueException

Persists a JobSpec to the queue.

Parameters:

spec - The JobSpec to persist.

Returns:

The ID of the JobSpec in the queue.

Throws:

JobQueueException - If there is any error queueing the JobSpec.

requeueJob

String requeueJob(JobSpec spec)
           throws JobQueueException

Re-adds a JobSpec to the back of the queue.

Parameters:

spec - The JobSpec to re-add.

Throws:

JobQueueException - If there is any error requeueing the JobSpec.

getQueuedJobs

List getQueuedJobs()

Gets an ordered List of queued JobSpecs.

Returns:

An ordered List of queued JobSpecs.

Throws:

JobQueueException - If there is any error obtaining the queued jobs.

purge

void purge()

Purges all JobSpecs from the queue.

Throws:

JobQueueException - If there is any error purging all the JobSpecs.

isEmpty

boolean isEmpty()

Returns a boolean value representing whether or not the queue is empty.

Returns:

true, if the queue is empty, false otherwise.

getNextJob

JobSpec getNextJob()

Gets the next JobSpec from the queue, and correspondingly removes it from persitance.

Returns:

The next JobSpec from the queue.

Throws:

JobQueueException - If there is any error getting the next JobSpec.

getJobRepository

JobRepository getJobRepository()

Gets the underlying JobSpec persistance layer used by this JobQueue.

Returns:

The underlying JobRepository.

getSize

int getSize()

Gets the number of jobs in queue

Returns:

Number of jobs in queue

getCapacity

int getCapacity()

Gets the max number of jobs allowed in queue at any given time

Returns:

Max number of jobs