org.apache.oodt.cas.resource.jobqueue

Interface MappedJobQueue

All Superinterfaces:

JobQueue

All Known Implementing Classes:

FifoMappedJobQueue

public interface MappedJobQueue
extends JobQueue

The interface for a JobQueue that is aware of the different queues in the ResourceManager and allows for the manipulation of jobs on a queue-by-queue basis.

Author:

resneck

Method Summary

Modifier and Type	Method and Description
String	addJob(JobSpec spec) Persists a JobSpec to the queue.
void	addQueue(String queueName) Add a queue with the given name.
JobSpec	getNextJob(String queueName) Gets the next JobSpec in the queue with the given name.
List<JobSpec>	getQueuedJobs(String queueName) Gets a list of all queued jobs that belong to the queue with the given name.
int	getSize(String queueName) Gets the number of jobs in the queue with the given name.
boolean	isEmpty(String queueName) Returns a boolean value representing whether or not the job queue contains jobs in the given queue.
void	promoteJob(JobSpec spec)
void	promoteKeyValPair(String key, String val)
void	removeJob(JobSpec spec) Removes the JobSpec with the given ID from the queue.
void	removeQueue(String queueName) Remove the queue with the given name.
String	requeueJob(JobSpec spec) Re-adds a JobSpec to the back of the queue.

Methods inherited from interface org.apache.oodt.cas.resource.jobqueue.JobQueue

getCapacity, getJobRepository, getNextJob, getQueuedJobs, getSize, isEmpty, purge

Method Detail

isEmpty

boolean isEmpty(String queueName)
         throws JobQueueException

Returns a boolean value representing whether or not the job queue contains jobs in the given queue.

Parameters:

queueName - The name of the queue which you are checking.

Returns:

true, if the queue is empty, false otherwise.

Throws:

JobQueueException - If the given queue name is null or if no queue with that name exists.

getNextJob

JobSpec getNextJob(String queueName)
            throws JobQueueException,
                   JobRepositoryException

Gets the next JobSpec in the queue with the given name.

Parameters:

queueName - The name of the queue from which the next JobSpec will be returned.

Returns:

The next JobSpec from the jobqueue belonging to the queue with the given name.

Throws:

JobQueueException - If the given queue name is null or if no queue with that name exists.

JobRepositoryException

getSize

int getSize(String queueName)
     throws JobQueueException

Gets the number of jobs in the queue with the given name.

Parameters:

queueName - The name of the queue whos size will be given.

Returns:

The number of JobSpecs in the queue with the given name.

Throws:

JobQueueException - If the given queue name is null or if no queue with that name exists.

removeJob

void removeJob(JobSpec spec)
        throws JobQueueException

Removes the JobSpec with the given ID from the queue.

Parameters:

id - The ID of the JobSpec that will be removed.

Throws:

JobQueueException - If no JobSpec has the given ID.

addQueue

void addQueue(String queueName)
       throws JobQueueException

Add a queue with the given name.

Parameters:

queueName - The name of the queue to be created.

Throws:

JobQueueException - If the given queue name is null or if a queue with the given name already exists.

removeQueue

void removeQueue(String queueName)
          throws JobQueueException

Remove the queue with the given name.

Parameters:

queueName - The name of the queue to be removed.

Throws:

JobQueueException - If the given queue name is null or if no queue with the given name exists.

getQueuedJobs

List<JobSpec> getQueuedJobs(String queueName)
                     throws JobQueueException,
                            JobRepositoryException

Gets a list of all queued jobs that belong to the queue with the given name.

Parameters:

queueName - The name of the queue whose members will be given.

Returns:

A List of queued s from the given queue.

Throws:

JobQueueException - If the given queue name is null or if no queue with the given name exists.

JobRepositoryException

addJob

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

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.

promoteJob

void promoteJob(JobSpec spec)
         throws JobQueueException

Throws:

JobQueueException

promoteKeyValPair

void promoteKeyValPair(String key,
                       String val)
                throws JobQueueException,
                       JobRepositoryException

Throws:

JobQueueException

JobRepositoryException