Package org.dspace.harvest

Class HarvestScheduler

java.lang.Object

org.dspace.harvest.HarvestScheduler

All Implemented Interfaces:

Runnable

public class HarvestScheduler
extends Object
implements Runnable

The class responsible for scheduling harvesting cycles are regular intervals.

Author:

alexey

Field Summary

Fields

Modifier and Type	Field	Description
protected static Integer	activeThreads
protected static EPerson	harvestAdmin
static int	HARVESTER_INTERRUPT_INSERT_THREAD
static int	HARVESTER_INTERRUPT_KILL_THREAD
static int	HARVESTER_INTERRUPT_NONE
static int	HARVESTER_INTERRUPT_PAUSE
static int	HARVESTER_INTERRUPT_RESUME
static int	HARVESTER_INTERRUPT_STOP
static int	HARVESTER_STATUS_PAUSED
static int	HARVESTER_STATUS_RUNNING
static int	HARVESTER_STATUS_SLEEPING
static int	HARVESTER_STATUS_STOPPED
protected static Stack<HarvestThread>	harvestThreads
protected static UUID	interruptValue
static Object	lock
protected static org.apache.logging.log4j.Logger	log
protected Context	mainContext
protected static Integer	maxActiveThreads
protected static long	maxHeartbeat
protected static long	minHeartbeat
protected static int	status

Constructor Summary

Constructors

Constructor	Description
HarvestScheduler()

Method Summary

Modifier and Type	Method	Description
void	addThread(Context context, HarvestedCollection harvestedCollection)	Adds a thread to the ready stack.
static int	getInterrupt()
static String	getStatus()
static boolean	hasStatus(int statusToCheck)
void	run()
protected void	scheduleLoop()
static void	setInterrupt(int newInterrupt)
static void	setInterrupt(int newInterrupt, UUID newInterruptValue)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.logging.log4j.Logger log

harvestAdmin

protected static EPerson harvestAdmin

mainContext

protected Context mainContext

lock

public static final Object lock

harvestThreads

protected static Stack<HarvestThread> harvestThreads

maxActiveThreads

protected static Integer maxActiveThreads

activeThreads

protected static volatile Integer activeThreads

HARVESTER_STATUS_RUNNING

public static final int HARVESTER_STATUS_RUNNING

See Also:

Constant Field Values

HARVESTER_STATUS_SLEEPING

public static final int HARVESTER_STATUS_SLEEPING

See Also:

Constant Field Values

HARVESTER_STATUS_PAUSED

public static final int HARVESTER_STATUS_PAUSED

See Also:

Constant Field Values

HARVESTER_STATUS_STOPPED

public static final int HARVESTER_STATUS_STOPPED

See Also:

Constant Field Values

HARVESTER_INTERRUPT_NONE

public static final int HARVESTER_INTERRUPT_NONE

See Also:

Constant Field Values

HARVESTER_INTERRUPT_PAUSE

public static final int HARVESTER_INTERRUPT_PAUSE

See Also:

Constant Field Values

HARVESTER_INTERRUPT_STOP

public static final int HARVESTER_INTERRUPT_STOP

See Also:

Constant Field Values

HARVESTER_INTERRUPT_RESUME

public static final int HARVESTER_INTERRUPT_RESUME

See Also:

Constant Field Values

HARVESTER_INTERRUPT_INSERT_THREAD

public static final int HARVESTER_INTERRUPT_INSERT_THREAD

See Also:

Constant Field Values

HARVESTER_INTERRUPT_KILL_THREAD

public static final int HARVESTER_INTERRUPT_KILL_THREAD

See Also:

Constant Field Values

status

protected static int status

interruptValue

protected static UUID interruptValue

minHeartbeat

protected static long minHeartbeat

maxHeartbeat

protected static long maxHeartbeat

Constructor Detail

HarvestScheduler

public HarvestScheduler()
                 throws SQLException,
                        AuthorizeException

Throws:

SQLException

AuthorizeException

Method Detail

hasStatus

public static boolean hasStatus(int statusToCheck)

setInterrupt

public static void setInterrupt(int newInterrupt)

setInterrupt

public static void setInterrupt(int newInterrupt,
                                UUID newInterruptValue)

getInterrupt

public static int getInterrupt()

getStatus

public static String getStatus()

run

public void run()

Specified by:

run in interface Runnable

scheduleLoop

protected void scheduleLoop()

addThread

public void addThread(Context context,
                      HarvestedCollection harvestedCollection)
               throws SQLException,
                      IOException,
                      AuthorizeException

Adds a thread to the ready stack. Can also be called externally to queue up a collection for harvesting before it is "due" for another cycle. This allows starting a harvest process from the UI that still "plays nice" with these thread mechanics instead of making an asynchronous call to runHarvest().

Parameters:

context - The relevant DSpace Context.

harvestedCollection - collection to be harvested

Throws:

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.