org.apache.oodt.cas.resource.jobqueue

Class JobStack

java.lang.Object

org.apache.oodt.cas.resource.jobqueue.JobStack

All Implemented Interfaces:

JobQueue

public class JobStack
extends Object
implements JobQueue

Version:

$Revision$

The Job Stack for unallocatable Jobs.

Author:

woollard

Constructor Summary

Constructors

Constructor and Description
JobStack(int maxSize, JobRepository repo)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobStack

public JobStack(int maxSize,
                JobRepository repo)

Method Detail

addJob

public String addJob(JobSpec spec)
              throws JobQueueException

Description copied from interface: JobQueue

Persists a JobSpec to the queue.

Specified by:

addJob in interface JobQueue

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

public String requeueJob(JobSpec spec)
                  throws JobQueueException

Description copied from interface: JobQueue

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

Specified by:

requeueJob in interface JobQueue

Parameters:

spec - The JobSpec to re-add.

Throws:

JobQueueException - If there is any error requeueing the JobSpec.

getQueuedJobs

public List getQueuedJobs()

Description copied from interface: JobQueue

Gets an ordered List of queued JobSpecs.

Specified by:

getQueuedJobs in interface JobQueue

Returns:

An ordered List of queued JobSpecs.

purge

public void purge()

Description copied from interface: JobQueue

Purges all JobSpecs from the queue.

Specified by:

purge in interface JobQueue

isEmpty

public boolean isEmpty()

Description copied from interface: JobQueue

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

Specified by:

isEmpty in interface JobQueue

Returns:

true, if the queue is empty, false otherwise.

getNextJob

public JobSpec getNextJob()

Description copied from interface: JobQueue

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

Specified by:

getNextJob in interface JobQueue

Returns:

The next JobSpec from the queue.

getJobRepository

public JobRepository getJobRepository()

Description copied from interface: JobQueue

Gets the underlying JobSpec persistance layer used by this JobQueue.

Specified by:

getJobRepository in interface JobQueue

Returns:

The underlying JobRepository.

getCapacity

public int getCapacity()

Description copied from interface: JobQueue

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

Specified by:

getCapacity in interface JobQueue

Returns:

Max number of jobs

getSize

public int getSize()

Description copied from interface: JobQueue

Gets the number of jobs in queue

Specified by:

getSize in interface JobQueue

Returns:

Number of jobs in queue