A C D E G I J L M O R S T

A

AbstractComponent - class org.apache.stratum.component.AbstractComponent.

TODO: DOCUMENT ME!

AbstractComponent() - Constructor for class org.apache.stratum.component.AbstractComponent

addJobConfig(JobConfig) - Method in class org.apache.stratum.scheduler.SchedulerConfig

Add a Job Configuraton to Scheduler Config

addTriggerConfig(TriggerConfig) - Method in class org.apache.stratum.scheduler.SchedulerConfig

Add a trigger to Scheduler Config

C

Component - interface org.apache.stratum.component.Component.

TODO: DOCUMENT ME!

ComponentLoader - class org.apache.stratum.component.ComponentLoader.

Loader for Components implementing the lifecyle Interfaces.

ComponentLoader(Configuration) - Constructor for class org.apache.stratum.component.ComponentLoader

Constructor

Configurable - interface org.apache.stratum.lifecycle.Configurable.

The Configurable interface is used by components that need to be initialized.

configure(Configuration) - Method in interface org.apache.stratum.lifecycle.Configurable

Configure the component

configure(Configuration) - Method in class org.apache.stratum.messenger.MessengerComponent

Configure MessengerManager.

configure(Configuration) - Method in class org.apache.stratum.ojb.OJBComponent

Configure the Broker

configure(Configuration) - Method in class org.apache.stratum.scheduler.Scheduler

Configure the Scheduler

D

Disposable - interface org.apache.stratum.lifecycle.Disposable.

The Disposable interface is used when components need to deallocate and dispose resources prior to their destruction.

dispose() - Method in interface org.apache.stratum.lifecycle.Disposable

The dispose operation is called at the end of a components lifecycle.

E

Executable - interface org.apache.stratum.lifecycle.Executable.

The Executable can be implemented by components that need to perform some work.

execute() - Method in interface org.apache.stratum.lifecycle.Executable

Execute the action associated with this component.

G

getClassName() - Method in class org.apache.stratum.scheduler.JobConfig

DOCUMENT ME!

getClassName() - Method in class org.apache.stratum.scheduler.JobStoreConfig

DOCUMENT ME!

getClassName() - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

DOCUMENT ME!

getConfiguration() - Method in class org.apache.stratum.component.AbstractComponent

TODO: DOCUMENT ME!

getConfiguration() - Method in interface org.apache.stratum.component.Component

TODO: DOCUMENT ME!

getConfiguration() - Method in class org.apache.stratum.component.ComponentLoader

Support method for testing the constructor

getDayOfMonth() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getDayOfWeek() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getGroup() - Method in class org.apache.stratum.scheduler.JobConfig

The group name that this job will be associated with

getGroup() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getHours() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getInstanceName() - Method in class org.apache.stratum.scheduler.SchedulerConfig

Return the reference name of the scheduler

getJobConfigs() - Method in class org.apache.stratum.scheduler.SchedulerConfig

Return a list of Job Configurations

getJobName() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getJobStoreConfig() - Method in class org.apache.stratum.scheduler.SchedulerConfig

Return the the JobStore object

getLoggerName() - Method in class org.apache.stratum.scheduler.JobStoreConfig

DOCUMENT ME!

getLoggerName() - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

DOCUMENT ME!

getMinutes() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getMonth() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getName() - Method in class org.apache.stratum.scheduler.JobConfig

The name of the job

getName() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getPersistenceBroker() - Method in class org.apache.stratum.ojb.OJBComponent

Retrieves the initialized persistence broker

getSeconds() - Method in class org.apache.stratum.scheduler.TriggerConfig

DOCUMENT ME!

getThreadCount() - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

DOCUMENT ME!

getThreadPoolConfig() - Method in class org.apache.stratum.scheduler.SchedulerConfig

Return the the ThreadPool object

getThreadPriority() - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

DOCUMENT ME!

getTriggerConfigs() - Method in class org.apache.stratum.scheduler.SchedulerConfig

Return a list of triggers

I

Initializable - interface org.apache.stratum.lifecycle.Initializable.

The Initializable interface is used by components that need to allocate resources prior to them becoming active.

initialize() - Method in interface org.apache.stratum.lifecycle.Initializable

Initialialize the component.

initialize() - Method in class org.apache.stratum.messenger.MessengerComponent

Initialize the MessengerManager.

initialize() - Method in class org.apache.stratum.ojb.OJBComponent

Initialize the OJB Broker

isConfigured() - Method in class org.apache.stratum.component.AbstractComponent

TODO: DOCUMENT ME!

isConfigured() - Method in interface org.apache.stratum.component.Component

TODO: DOCUMENT ME!

J

JobConfig - class org.apache.stratum.scheduler.JobConfig.

This bean represents the settings used to create a JobDetail object for use in the Quartz scheduler.

JobConfig() - Constructor for class org.apache.stratum.scheduler.JobConfig

Default contructor

JobStoreConfig - class org.apache.stratum.scheduler.JobStoreConfig.

This bean represents the settings used to assign jobstore properties for use in the Quartz scheduler.

JobStoreConfig() - Constructor for class org.apache.stratum.scheduler.JobStoreConfig

Default contructor

L

load() - Method in class org.apache.stratum.component.ComponentLoader

Load all the components listed in the ComponentLoader's configuration.

loadComponent(String, String, Configuration) - Method in class org.apache.stratum.component.ComponentLoader

load the given component, configure it with the given config file, and initialize it.

M

MessengerComponent - class org.apache.stratum.messenger.MessengerComponent.

This class is the Messenger component.

MessengerComponent() - Constructor for class org.apache.stratum.messenger.MessengerComponent

main(String[]) - Static method in class org.apache.stratum.scheduler.Scheduler

Just a command line test tool to start the scheduler from the command line.

O

OJBComponent - class org.apache.stratum.ojb.OJBComponent.

This class is the Object Bridege component that

OJBComponent() - Constructor for class org.apache.stratum.ojb.OJBComponent

org.apache.stratum.component - package org.apache.stratum.component

org.apache.stratum.lifecycle - package org.apache.stratum.lifecycle

org.apache.stratum.messenger - package org.apache.stratum.messenger

org.apache.stratum.ojb - package org.apache.stratum.ojb

org.apache.stratum.scheduler - package org.apache.stratum.scheduler

R

Reconfigurable - interface org.apache.stratum.lifecycle.Reconfigurable.

The Reconfigurable interface is used by components that need to be reconfigured.

reconfigure(Configuration) - Method in interface org.apache.stratum.lifecycle.Reconfigurable

TODO: DOCUMENT ME!

resume() - Method in interface org.apache.stratum.lifecycle.Suspendable

Resumes the component.

S

Scheduler - class org.apache.stratum.scheduler.Scheduler.

This class is the Scheduler component that implements a Quartz scheduler.

Scheduler() - Constructor for class org.apache.stratum.scheduler.Scheduler

SchedulerConfig - class org.apache.stratum.scheduler.SchedulerConfig.

This bean represents all of the configuration information needed to load the Quartz scheduler.

SchedulerConfig() - Constructor for class org.apache.stratum.scheduler.SchedulerConfig

Default contructor

Startable - interface org.apache.stratum.lifecycle.Startable.

The Startable interface is used when components need to be "running" to be active.

Suspendable - interface org.apache.stratum.lifecycle.Suspendable.

The Suspendable interface is used when a component will need to temporarily halt execution of a component.

scheduler - Variable in class org.apache.stratum.scheduler.Scheduler

TODO: DOCUMENT ME!

setClassName(String) - Method in class org.apache.stratum.scheduler.JobConfig

This is the full package/class name of the job that Quartz will run

setClassName(String) - Method in class org.apache.stratum.scheduler.JobStoreConfig

This is the full package/class name of the class used for the Quartz jobstore.

setClassName(String) - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

This is the full package/class name of the class used for the Quartz threadpool.

setConfiguration(Configuration) - Method in class org.apache.stratum.component.AbstractComponent

TODO: DOCUMENT ME!

setConfiguration(Configuration) - Method in interface org.apache.stratum.component.Component

TODO: DOCUMENT ME!

setConfiguration(Configuration) - Method in class org.apache.stratum.component.ComponentLoader

Set the configuration for this ComponentLoader

setDayOfMonth(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

Field Name Allowed Values Allowed Special Characters dayOfMonth 0-31 , - * ? / L C

setDayOfWeek(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

Field Name Allowed Values Allowed Special Characters dayOfWeek 1-7 or SUN-SAT , - * ? / L C

setGroup(String) - Method in class org.apache.stratum.scheduler.JobConfig

This is the group with which the job will be associated in Quartz.

setGroup(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

This is the name of group that the trigger is associated with

setHours(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

Field Name Allowed Values Allowed Special Characters hours 0-23 , - * /

setInstanceName(String) - Method in class org.apache.stratum.scheduler.SchedulerConfig

Set the reference name given to the scheduler that is loaded into Quartz

setJobName(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

This is the name of job that the trigger is associated with

setJobStoreConfig(JobStoreConfig) - Method in class org.apache.stratum.scheduler.SchedulerConfig

Set the jobstore for the scheduler to use

setLoggerName(String) - Method in class org.apache.stratum.scheduler.JobStoreConfig

This is the reference name of the logger that has been registered with Quartz that will be used by the Quartz jobstore.

setLoggerName(String) - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

This is the reference name of the logger that has been registered with Quartz that will be used by the Quartz threadpool.

setMinutes(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

Field Name Allowed Values Allowed Special Characters minutes 0-59 , - * /

setMonth(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

Field Name Allowed Values Allowed Special Characters month 1-12 or JAN-DEC , - * /

setName(String) - Method in class org.apache.stratum.scheduler.JobConfig

This is the name by which the job will be identified in Quartz

setName(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

This is the name of the trigger

setSeconds(String) - Method in class org.apache.stratum.scheduler.TriggerConfig

Field Name Allowed Values Allowed Special Characters seconds 0-59 , - * /

setThreadCount(String) - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

This is the thread count used for the Quartz threadpool.

setThreadPoolConfig(ThreadPoolConfig) - Method in class org.apache.stratum.scheduler.SchedulerConfig

Set the threadPool for the scheduler to use

setThreadPriority(String) - Method in class org.apache.stratum.scheduler.ThreadPoolConfig

This is the thread priority used for the Quartz threadpool.

start() - Method in interface org.apache.stratum.lifecycle.Startable

Starts the component.

start() - Method in class org.apache.stratum.scheduler.Scheduler

start the scheduler.

stop() - Method in interface org.apache.stratum.lifecycle.Startable

Stops the component.

stop() - Method in class org.apache.stratum.scheduler.Scheduler

stop the scheduler.

suspend() - Method in interface org.apache.stratum.lifecycle.Suspendable

Suspends the component.

T

ThreadPoolConfig - class org.apache.stratum.scheduler.ThreadPoolConfig.

This bean represents the settings used to assign thread pool properties for use in the Quartz scheduler.

ThreadPoolConfig() - Constructor for class org.apache.stratum.scheduler.ThreadPoolConfig

Default contructor

TriggerConfig - class org.apache.stratum.scheduler.TriggerConfig.

This bean represents the settings used to create a Trigger object for use in the Quartz scheduler

TriggerConfig() - Constructor for class org.apache.stratum.scheduler.TriggerConfig

Default contructor

A C D E G I J L M O R S T