org.apache.avalon.cornerstone.blocks.scheduler
Class DefaultTimeScheduler

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.avalon.cornerstone.blocks.scheduler.DefaultTimeScheduler

All Implemented Interfaces:

java.lang.Runnable, MonitorableTimeSchedulerMBean, org.apache.avalon.cornerstone.services.scheduler.TimeScheduler, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Startable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable

Direct Known Subclasses:

MonitorableTimeScheduler

public class DefaultTimeScheduler
extends org.apache.avalon.framework.logger.AbstractLogEnabled
implements org.apache.avalon.cornerstone.services.scheduler.TimeScheduler, org.apache.avalon.framework.service.Serviceable, org.apache.avalon.framework.activity.Startable, org.apache.avalon.framework.activity.Disposable, java.lang.Runnable, MonitorableTimeSchedulerMBean

Default implementation of TimeScheduler service.

Author:

Avalon Development Team

Field Summary

private java.util.Hashtable	m_entries
private PriorityQueue	m_priorityQueue
private boolean	m_running
private org.apache.avalon.cornerstone.services.threads.ThreadManager	m_threadManager
private java.util.ArrayList	m_triggerFailureListeners

Fields inherited from interface org.apache.avalon.cornerstone.services.scheduler.TimeScheduler

ROLE

Constructor Summary

DefaultTimeScheduler()

Method Summary

void	addTrigger(java.lang.String name, org.apache.avalon.cornerstone.services.scheduler.TimeTrigger trigger, org.apache.avalon.cornerstone.services.scheduler.Target target) Schedule a time based trigger.
void	addTriggerFailureListener(org.apache.avalon.cornerstone.services.scheduler.TriggerFailureListener listener) Add a trigger failure listener
void	dispose()
protected void	doRunEntry(TimeScheduledEntry entry) Helper method delegated to to run in a separate thread.
java.util.Collection	getEntries() Return a collection of the triggerable names.
protected TimeScheduledEntry	getEntry(java.lang.String name) Retrieve entry from set.
protected java.util.Map	getEntryMap()
protected TimeScheduledEntry	getNextEntry() Retrieve next valid entry.
protected PriorityQueue	getPriorityQueue()
protected org.apache.avalon.cornerstone.services.threads.ThreadManager	getThreadManager()
protected java.util.List	getTriggerFailureListeners()
protected boolean	isRunning()
protected void	notifyFailedTriggers(java.lang.Throwable t)
void	removeTrigger(java.lang.String name) Remove a scheduled trigger by name.
void	removeTriggerFailureListener(org.apache.avalon.cornerstone.services.scheduler.TriggerFailureListener listener) Remove a trigger failure listener
protected boolean	rescheduleEntry(TimeScheduledEntry timeEntry, boolean clone) Reschedule an entry.
void	resetTrigger(java.lang.String name) Force a trigger time to be recalculated.
void	run() Entry point for thread that monitors entrys and triggers entrys when necessary.
protected void	runEntry(TimeScheduledEntry entry) Run entry in a separate thread and reschedule it.
void	service(org.apache.avalon.framework.service.ServiceManager serviceManager) Supply of the service manager to the component.
protected void	setRunning(boolean running)
void	start()
void	stop()

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

m_entries

private final java.util.Hashtable m_entries

m_priorityQueue

private final PriorityQueue m_priorityQueue

m_threadManager

private org.apache.avalon.cornerstone.services.threads.ThreadManager m_threadManager

m_running

private boolean m_running

m_triggerFailureListeners

private java.util.ArrayList m_triggerFailureListeners

Constructor Detail

DefaultTimeScheduler

public DefaultTimeScheduler()

Method Detail

getThreadManager

protected final org.apache.avalon.cornerstone.services.threads.ThreadManager getThreadManager()

isRunning

protected final boolean isRunning()

setRunning

protected final void setRunning(boolean running)

getTriggerFailureListeners

protected final java.util.List getTriggerFailureListeners()

getEntryMap

protected final java.util.Map getEntryMap()

getPriorityQueue

protected final PriorityQueue getPriorityQueue()

service

public void service(org.apache.avalon.framework.service.ServiceManager serviceManager)
             throws org.apache.avalon.framework.service.ServiceException

Supply of the service manager to the component.

Specified by:

service in interface org.apache.avalon.framework.service.Serviceable

Parameters:

serviceManager - the service manager

Throws:

org.apache.avalon.framework.service.ServiceException

dispose

public void dispose()

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

start

public void start()
           throws java.lang.Exception

Specified by:

start in interface org.apache.avalon.framework.activity.Startable

Throws:

java.lang.Exception

stop

public void stop()

Specified by:

stop in interface org.apache.avalon.framework.activity.Startable

run

public void run()

Entry point for thread that monitors entrys and triggers entrys when necessary.

Specified by:

run in interface java.lang.Runnable

addTriggerFailureListener

public void addTriggerFailureListener(org.apache.avalon.cornerstone.services.scheduler.TriggerFailureListener listener)

Add a trigger failure listener

Specified by:

addTriggerFailureListener in interface org.apache.avalon.cornerstone.services.scheduler.TimeScheduler

Parameters:

listener - The listener

removeTriggerFailureListener

public void removeTriggerFailureListener(org.apache.avalon.cornerstone.services.scheduler.TriggerFailureListener listener)

Remove a trigger failure listener

Specified by:

removeTriggerFailureListener in interface org.apache.avalon.cornerstone.services.scheduler.TimeScheduler

Parameters:

listener - The listener

addTrigger

public void addTrigger(java.lang.String name,
                       org.apache.avalon.cornerstone.services.scheduler.TimeTrigger trigger,
                       org.apache.avalon.cornerstone.services.scheduler.Target target)

Schedule a time based trigger. Note that if a TimeTrigger already has same name then it is removed.

Specified by:

addTrigger in interface org.apache.avalon.cornerstone.services.scheduler.TimeScheduler

Parameters:

name - the name of the trigger

trigger - the trigger

target - the target

removeTrigger

public void removeTrigger(java.lang.String name)
                   throws java.util.NoSuchElementException

Remove a scheduled trigger by name.

Specified by:

removeTrigger in interface org.apache.avalon.cornerstone.services.scheduler.TimeScheduler

Parameters:

name - the name of the trigger

Throws:

java.util.NoSuchElementException - if no trigger exists with that name

resetTrigger

public void resetTrigger(java.lang.String name)
                  throws java.util.NoSuchElementException

Force a trigger time to be recalculated.

Specified by:

resetTrigger in interface org.apache.avalon.cornerstone.services.scheduler.TimeScheduler

Parameters:

name - the name of the trigger

Throws:

java.util.NoSuchElementException - if no trigger exists with that name

getEntries

public java.util.Collection getEntries()

Return a collection of the triggerable names.

Specified by:

getEntries in interface MonitorableTimeSchedulerMBean

Returns:

the collection

rescheduleEntry

protected boolean rescheduleEntry(TimeScheduledEntry timeEntry,
                                  boolean clone)

Reschedule an entry. if clone is true then invalidate old version and create a new entry to insert into queue.

Parameters:

timeEntry - the entry

clone - true if new entry is to be created

Returns:

true if added to queue, false if not added

getEntry

protected TimeScheduledEntry getEntry(java.lang.String name)
                               throws java.util.NoSuchElementException

Retrieve entry from set.

Parameters:

name - the name of entry

Returns:

the entry

Throws:

java.util.NoSuchElementException - if no entry is found with that name

runEntry

protected void runEntry(TimeScheduledEntry entry)

Run entry in a separate thread and reschedule it.

Parameters:

entry - the entry to run

doRunEntry

protected void doRunEntry(TimeScheduledEntry entry)

Helper method delegated to to run in a separate thread.

Parameters:

entry - the entry to run

getNextEntry

protected TimeScheduledEntry getNextEntry()

Retrieve next valid entry. It will pop off any invalid entrys until the heap is empty or a valid entry is found.

Returns:

the next valid entry or null if none

notifyFailedTriggers

protected void notifyFailedTriggers(java.lang.Throwable t)