org.openksavi.sponge.core.engine.event

Class QuartzEventScheduler

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.engine.event.BaseEventScheduler

org.openksavi.sponge.core.engine.event.QuartzEventScheduler

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.engine.event.EventScheduler, org.openksavi.sponge.util.Manageable

public class QuartzEventScheduler
extends BaseEventScheduler

An event scheduler that uses Quartz.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuartzEventScheduler.EventSchedulerJob Quartz job.
static class	QuartzEventScheduler.EventSchedulerJobParameters

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY_PARAMETERS
static String	PROP_THREAD_COUNT

Fields inherited from class org.openksavi.sponge.core.engine.event.BaseEventScheduler

currentEntryId, eventIdGenerator, outQueue

Constructor Summary

Constructors

Constructor and Description
QuartzEventScheduler(org.openksavi.sponge.engine.Engine engine, org.openksavi.sponge.engine.event.EventQueue outQueue) Creates a new event scheduler.

Method Summary

Modifier and Type	Method and Description
protected org.openksavi.sponge.event.EventSchedulerEntry	doSchedule(org.openksavi.sponge.event.Event event, org.quartz.Trigger trigger, boolean single)
void	doShutdown() Shuts down this event scheduler.
void	doStartup() Starts up this event scheduler.
List<org.openksavi.sponge.event.EventSchedulerEntry>	getEntries() Returns all scheduled entries.
org.quartz.Scheduler	getScheduler()
boolean	remove(org.openksavi.sponge.event.EventSchedulerEntry entry) Removes the scheduled event entry.
org.openksavi.sponge.event.EventSchedulerEntry	scheduleAfter(org.openksavi.sponge.event.Event event, long delay) Schedules an event after a specified time.
org.openksavi.sponge.event.EventSchedulerEntry	scheduleAfter(org.openksavi.sponge.event.Event event, long delay, long interval) Schedules an event after a specified time with the specified interval.
org.openksavi.sponge.event.EventSchedulerEntry	scheduleAt(org.openksavi.sponge.event.Event event, long at) Schedules an event at a specified time.
org.openksavi.sponge.event.EventSchedulerEntry	scheduleAt(org.openksavi.sponge.event.Event event, long at, long interval) Schedules an event at a specified time with the specified interval.
org.openksavi.sponge.event.EventSchedulerEntry	scheduleAt(org.openksavi.sponge.event.Event event, String crontabSpec)

Methods inherited from class org.openksavi.sponge.core.engine.event.BaseEventScheduler

getEventIdGenerator, getNextEntryId, scheduleNow, setEventIdGenerator

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getEngine, getName, getService, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setEngine, setName, shutdown, startup, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.engine.EngineModule

getEngine, getName, setEngine, setName

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Field Detail

PROP_THREAD_COUNT

public static final String PROP_THREAD_COUNT

See Also:

Constant Field Values

KEY_PARAMETERS

protected static final String KEY_PARAMETERS

See Also:

Constant Field Values

Constructor Detail

QuartzEventScheduler

public QuartzEventScheduler(org.openksavi.sponge.engine.Engine engine,
                            org.openksavi.sponge.engine.event.EventQueue outQueue)

Creates a new event scheduler.

Parameters:

engine - the engine.

outQueue - an output event queue.

Method Detail

doStartup

public void doStartup()

Starts up this event scheduler.

Overrides:

doStartup in class BaseEngineModule

doShutdown

public void doShutdown()

Shuts down this event scheduler.

Overrides:

doShutdown in class BaseEngineModule

doSchedule

protected org.openksavi.sponge.event.EventSchedulerEntry doSchedule(org.openksavi.sponge.event.Event event,
                                                                    org.quartz.Trigger trigger,
                                                                    boolean single)

scheduleAfter

public org.openksavi.sponge.event.EventSchedulerEntry scheduleAfter(org.openksavi.sponge.event.Event event,
                                                                    long delay)

Schedules an event after a specified time.

Parameters:

event - event.

delay - delay in milliseconds.

Returns:

scheduled event entry.

scheduleAfter

public org.openksavi.sponge.event.EventSchedulerEntry scheduleAfter(org.openksavi.sponge.event.Event event,
                                                                    long delay,
                                                                    long interval)

Schedules an event after a specified time with the specified interval.

Parameters:

event - event.

delay - delay in milliseconds.

interval - interval in milliseconds.

Returns:

scheduled event entry.

scheduleAt

public org.openksavi.sponge.event.EventSchedulerEntry scheduleAt(org.openksavi.sponge.event.Event event,
                                                                 long at)

Schedules an event at a specified time.

Parameters:

event - event.

at - time in milliseconds.

Returns:

scheduled event entry.

scheduleAt

public org.openksavi.sponge.event.EventSchedulerEntry scheduleAt(org.openksavi.sponge.event.Event event,
                                                                 long at,
                                                                 long interval)

Schedules an event at a specified time with the specified interval.

Parameters:

event - event.

at - time in milliseconds.

interval - interval in milliseconds.

Returns:

scheduled event entry.

scheduleAt

public org.openksavi.sponge.event.EventSchedulerEntry scheduleAt(org.openksavi.sponge.event.Event event,
                                                                 String crontabSpec)

remove

public boolean remove(org.openksavi.sponge.event.EventSchedulerEntry entry)

Removes the scheduled event entry.

Parameters:

entry - the scheduled event entry.

Returns:

true if the specified entry has been scheduled.

getEntries

public List<org.openksavi.sponge.event.EventSchedulerEntry> getEntries()

Returns all scheduled entries.

Returns:

all scheduled entries.

getScheduler

public org.quartz.Scheduler getScheduler()