Package org.mycore.services.queuedjob

Class MCRJobQueue

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<MCRJob>

org.mycore.services.queuedjob.MCRJobQueue

All Implemented Interfaces:

Comparable<MCRShutdownHandler.Closeable>, Iterable<MCRJob>, Collection<MCRJob>, Queue<MCRJob>, MCRShutdownHandler.Closeable

public class MCRJobQueue
extends AbstractQueue<MCRJob>
implements MCRShutdownHandler.Closeable

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CONFIG_PREFIX
protected String	configPrefixAdd
protected static Map<String,MCRJobQueue>	INSTANCES
protected static boolean	singleQueue

Fields inherited from interface org.mycore.common.events.MCRShutdownHandler.Closeable

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method	Description
void	clear()	Deletes all jobs no matter what the current state is.
void	close()	does nothing
MCRJob	element()	removes next job.
MCRJob	getElementOutOfOrder(Class<? extends MCRJobAction> action, Map<String,String> params)	get the specific job and alters it status to MCRJobStatus.PROCESSING
static MCRJobQueue	getInstance(Class<? extends MCRJobAction> action)	Returns an singleton instance of this class.
MCRJob	getJob(Map<String,String> params)	returns a specific job from given parameters or null if not found.
List<MCRJob>	getJobs(Map<String,String> params)	Returns specific jobs by the given parameters or an empty list.
int	getPriority()	Returns the priority.
Iterator<MCRJob>	iterator()	iterates over jobs of status MCRJobStatus.NEW does not change the status.
Iterator<MCRJob>	iterator(MCRJobStatus status)	Builds iterator for jobs with given MCRJobStatus or null for all jobs.
void	notifyListener()	every attached listener is informed that something happened to the state of the queue.
boolean	offer(MCRJob job)	adds MCRJob to queue and starts MCRJobMaster if "MCR.QueuedJob.autostart" is set true.
MCRJob	peek()	get next job without modifying it state to MCRJobStatus.PROCESSING
MCRJob	poll()
void	prepareClose()	Shuts down MCRStalledJobResetter and does not alter any job anymore.
MCRJob	remove()	removes next job.
int	remove(Class<? extends MCRJobAction> action)	Removes all jobs from queue of specified action.
int	remove(Class<? extends MCRJobAction> action, Map<String,String> params)	removes specific job from queue no matter what its current status is.
int	size()	returns the current size of this queue
String	toString()

Methods inherited from class java.util.AbstractQueue

add, addAll

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.mycore.common.events.MCRShutdownHandler.Closeable

compareTo

Field Details

INSTANCES

protected static Map<String,MCRJobQueue> INSTANCES

CONFIG_PREFIX

protected static String CONFIG_PREFIX

singleQueue

protected static boolean singleQueue

configPrefixAdd

protected String configPrefixAdd

Method Details

getInstance

public static MCRJobQueue getInstance(Class<? extends MCRJobAction> action)

Returns an singleton instance of this class.

Parameters:

action - the MCRJobAction or null

Returns:

singleton instance of this class

poll

public MCRJob poll()

Specified by:

poll in interface Queue<MCRJob>

Returns:

next available job instance

remove

public MCRJob remove()
              throws NoSuchElementException

removes next job. same as poll() but never returns null

Specified by:

remove in interface Queue<MCRJob>

Overrides:

remove in class AbstractQueue<MCRJob>

Throws:

NoSuchElementException - if poll() would return null

peek

public MCRJob peek()

get next job without modifying it state to MCRJobStatus.PROCESSING

Specified by:

peek in interface Queue<MCRJob>

Returns:

the next job

element

public MCRJob element()
               throws NoSuchElementException

removes next job. same as peek() but never returns null

Specified by:

element in interface Queue<MCRJob>

Overrides:

element in class AbstractQueue<MCRJob>

Throws:

NoSuchElementException - if peek() would return null

offer

public boolean offer(MCRJob job)

adds MCRJob to queue and starts MCRJobMaster if "MCR.QueuedJob.autostart" is set true. alters date added to current time and status of job to MCRJobStatus.NEW

Specified by:

offer in interface Queue<MCRJob>

clear

public void clear()

Deletes all jobs no matter what the current state is.

Specified by:

clear in interface Collection<MCRJob>

Overrides:

clear in class AbstractQueue<MCRJob>

iterator

public Iterator<MCRJob> iterator()

iterates over jobs of status MCRJobStatus.NEW does not change the status.

Specified by:

iterator in interface Collection<MCRJob>

Specified by:

iterator in interface Iterable<MCRJob>

Specified by:

iterator in class AbstractCollection<MCRJob>

iterator

public Iterator<MCRJob> iterator(MCRJobStatus status)

Builds iterator for jobs with given MCRJobStatus or null for all jobs.

size

public int size()

returns the current size of this queue

Specified by:

size in interface Collection<MCRJob>

Specified by:

size in class AbstractCollection<MCRJob>

getElementOutOfOrder

public MCRJob getElementOutOfOrder(Class<? extends MCRJobAction> action,
 Map<String,String> params)
                            throws NoSuchElementException

get the specific job and alters it status to MCRJobStatus.PROCESSING

Parameters:

action - the MCRJobAction

Throws:

NoSuchElementException

getJob

public MCRJob getJob(Map<String,String> params)

returns a specific job from given parameters or null if not found.

Parameters:

params - the parameters

Returns:

the job

getJobs

public List<MCRJob> getJobs(Map<String,String> params)

Returns specific jobs by the given parameters or an empty list.

Parameters:

params - the parameters

Returns:

the job

notifyListener

public void notifyListener()

every attached listener is informed that something happened to the state of the queue. Starts MCRJobMaster if "MCR.QueuedJob.autostart" is set true.

remove

public int remove(Class<? extends MCRJobAction> action,
 Map<String,String> params)

removes specific job from queue no matter what its current status is.

Parameters:

action - - the action class

params - - parameters to get jobs

Returns:

the number of jobs deleted

remove

public int remove(Class<? extends MCRJobAction> action)

Removes all jobs from queue of specified action.

Parameters:

action - - the action class

Returns:

the number of jobs deleted

prepareClose

public void prepareClose()

Shuts down MCRStalledJobResetter and does not alter any job anymore.

Specified by:

prepareClose in interface MCRShutdownHandler.Closeable

close

public void close()

does nothing

Specified by:

close in interface MCRShutdownHandler.Closeable

toString

public String toString()

Overrides:

toString in class AbstractCollection<MCRJob>

Returns:

"MCRJobQueue"

getPriority

public int getPriority()

Description copied from interface: MCRShutdownHandler.Closeable

Returns the priority. A Closeable with a higher priority will be closed before a Closeable with a lower priority. Default priority is 5.

Specified by:

getPriority in interface MCRShutdownHandler.Closeable