com.protomatter.pas.cron
Class PASCronManagerStartup

java.lang.Object
  |
  +--com.protomatter.pas.cron.PASCronManagerStartup

All Implemented Interfaces:

PASStartup

public class PASCronManagerStartup

extends java.lang.Object

implements PASStartup

A startup class for registering cron events via the PAS properties file. This startup class looks through the PAS properties file for entries that look like this:

  pas.cron.SYMBOLICNAME=\
     topics=TOPIC1;TOPIC2;...;TOPICN,\
     message=some text,\
     year=year-list,\
     month=month-list,\
     day=day-list,\
     weekday=weekday-list,\
     hour=hour-list,\
     minute=minute-list
  

And registers corresponding CronEntry objects with the PASCronManager.

The specified lists from above are:

year-list

This is a semi-colon (;) separated list of individual years or of year ranges. Examples: "1999;2000" or "1999-2004;2005-2143;2650"

month-list

This is a semi-colon (;) separated list of month names. Example: "january;march;may"

day-list

This is a semi-colon (;) separated list of individual day-of-month numbers or of day-of-month ranges. Examples: "1;15" or "1-5;7;10-24"

weekday-list

This is a semi-colon (;) separated list of weekday names names. Example: "monday;tuesday"

hour-list

This is a semi-colon (;) separated list of individual hours-of-day (24-hour time) or of hour-of-day ranges. Examples: "12;15" or "8-17;19;20-22"

minute-list

This is a semi-colon (;) separated list of individual minutes (during an hour) or of minute ranges. Examples: "0;15;30;45" or "0-5;8-14;23;28-32"

The value of each of those lists can also be an asterisk (*), which tells the cron system to disregard the given list when determining if a cron entry applies to a specific time -- for instance setting the year-list to * would cause the system to not take the current year into consideration. If a given list is not specified at all, it's the same as specifying it and giving it a value of *.

When it comes time for the cron entry to be run, a PASEvent with the message as it's payload will be submitted to the PASEventManager's event topic tree, where interested objects can do something based on the event.

See Also:

PASCronManager, CronEntry, PASEvent

Constructor Summary

PASCronManagerStartup()
Default constructor.

Method Summary

java.lang.String

startup(java.lang.String myName, java.util.Properties pasProps, java.util.Properties myProps, javax.naming.Context context) Start this thing up.

Methods inherited from class java.lang.Object

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

Constructor Detail

PASCronManagerStartup

public PASCronManagerStartup()

Default constructor.

Method Detail

startup

public java.lang.String startup(java.lang.String myName,
                                java.util.Properties pasProps,
                                java.util.Properties myProps,
                                javax.naming.Context context)
                         throws StartupException

Description copied from interface: PASStartup

Start this thing up.

Specified by:

startup in interface PASStartup

See Also:

PASStartup