org.apache.oodt.cas.resource.jobqueue

Class FifoMappedJobQueue

java.lang.Object

org.apache.oodt.cas.resource.jobqueue.FifoMappedJobQueue

All Implemented Interfaces:

JobQueue, MappedJobQueue

public class FifoMappedJobQueue
extends Object
implements MappedJobQueue

This implementation provides a "queue-aware" JobQueue that ensures the FIFO execution of jobs.

Author:

resneck

Constructor Summary

Constructors

Constructor and Description
FifoMappedJobQueue(int maxSize, JobRepository repo)

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.
int	getCapacity() This method returns the number of jobs in any given queue that can be retained in the queue.
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.
JobSpec	getNextJob(String queueName) Gets the next JobSpec in the queue with the given name.
List	getQueuedJobs() Gets an ordered List of queued JobSpecs.
List<JobSpec>	getQueuedJobs(String queueName) Gets a list of all queued jobs that belong to the queue with the given name.
List<String>	getQueueNames()
int	getSize() Gets the number of jobs in queue
int	getSize(String queueName) Gets the number of jobs in the queue with the given name.
boolean	isEmpty() Returns a boolean value representing whether or not the queue is empty.
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	purge() Purges all JobSpecs from the queue.
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 class java.lang.Object

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

Constructor Detail

FifoMappedJobQueue

public FifoMappedJobQueue(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

Specified by:

addJob in interface MappedJobQueue

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.

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.addJob(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

Specified by:

requeueJob in interface MappedJobQueue

Parameters:

spec - The JobSpec to re-add.

Throws:

JobQueueException - If there is any error requeueing the JobSpec.

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.requeueJob(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.

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.getQueuedJobs()

getQueuedJobs

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

Description copied from interface: MappedJobQueue

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

Specified by:

getQueuedJobs in interface MappedJobQueue

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

purge

public void purge()

Description copied from interface: JobQueue

Purges all JobSpecs from the queue.

Specified by:

purge in interface JobQueue

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.purge()

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.

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.isEmpty()

isEmpty

public boolean isEmpty(String queueName)
                throws JobQueueException

Description copied from interface: MappedJobQueue

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

Specified by:

isEmpty in interface MappedJobQueue

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

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.

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.getNextJob()

getNextJob

public JobSpec getNextJob(String queueName)
                   throws JobQueueException,
                          JobRepositoryException

Description copied from interface: MappedJobQueue

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

Specified by:

getNextJob in interface MappedJobQueue

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

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.

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.getJobRepository()

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

See Also:

org.apache.oodt.cas.resource.jobqueue.JobQueue.getSize()

getSize

public int getSize(String queueName)
            throws JobQueueException

Description copied from interface: MappedJobQueue

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

Specified by:

getSize in interface MappedJobQueue

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.

getCapacity

public int getCapacity()

This method returns the number of jobs in any given queue that can be retained in the queue. This number does not change with the number of queues in the ResourceManager.

Specified by:

getCapacity in interface JobQueue

Returns:

The number of jobs of each queue that can be queued.

removeJob

public void removeJob(JobSpec spec)
               throws JobQueueException

Description copied from interface: MappedJobQueue

Removes the JobSpec with the given ID from the queue.

Specified by:

removeJob in interface MappedJobQueue

Throws:

JobQueueException - If no JobSpec has the given ID.

addQueue

public void addQueue(String queueName)
              throws JobQueueException

Description copied from interface: MappedJobQueue

Add a queue with the given name.

Specified by:

addQueue in interface MappedJobQueue

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

public void removeQueue(String queueName)
                 throws JobQueueException

Description copied from interface: MappedJobQueue

Remove the queue with the given name.

Specified by:

removeQueue in interface MappedJobQueue

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.

promoteJob

public void promoteJob(JobSpec spec)
                throws JobQueueException

Specified by:

promoteJob in interface MappedJobQueue

Throws:

JobQueueException

getQueueNames

public List<String> getQueueNames()

promoteKeyValPair

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

Specified by:

promoteKeyValPair in interface MappedJobQueue

Throws:

JobQueueException

JobRepositoryException