org.quartz
Class SchedulerMetaData

java.lang.Object
  extended byorg.quartz.SchedulerMetaData
All Implemented Interfaces:
java.io.Serializable

public class SchedulerMetaData
extends java.lang.Object
implements java.io.Serializable

Describes the settings and capabilities of a given Scheduler instance.

Author:
James House
See Also:
Serialized Form

Constructor Summary
SchedulerMetaData(java.lang.String schedName, java.lang.String schedInst, java.lang.Class schedClass, boolean isRemote, boolean started, boolean paused, boolean shutdown, java.util.Date startTime, int numJobsExec, java.lang.Class jsClass, boolean jsPersistent, java.lang.Class tpClass, int tpSize, java.lang.String version)
           
 
Method Summary
 java.lang.Class getJobStoreClass()
          Returns the class-name of the JobStore instance that is being used by the Scheduler.
 java.lang.Class getSchedulerClass()
          Returns the class-name of the Scheduler instance.
 java.lang.String getSchedulerInstanceId()
          Returns the instance Id of the Scheduler.
 java.lang.String getSchedulerName()
          Returns the name of the Scheduler.
 java.lang.String getSummary()
          Returns a formatted (human readable) String describing all the Scheduler's meta-data values.
 java.lang.Class getThreadPoolClass()
          Returns the class-name of the ThreadPool instance that is being used by the Scheduler.
 int getThreadPoolSize()
          Returns the number of threads currently in the Scheduler's ThreadPool.
 java.lang.String getVersion()
          Returns the version of Quartz that is running.
 boolean isPaused()
          Reports whether the Scheduler is paused.
 boolean isSchedulerRemote()
          Returns whether the Scheduler is being used remotely (via RMI).
 boolean isShutdown()
          Reports whether the Scheduler has been shutdown.
 boolean isStarted()
          Returns whether the scheduler has been started.
 boolean jobStoreSupportsPersistence()
          Returns whether or not the Scheduler's JobStore instance supports persistence.
 int numJobsExecuted()
          Returns the number of jobs executed since the Scheduler started..
 java.util.Date runningSince()
          Returns the Date at which the Scheduler started running.
 java.lang.String toString()
          Return a simple string representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SchedulerMetaData

public SchedulerMetaData(java.lang.String schedName,
                         java.lang.String schedInst,
                         java.lang.Class schedClass,
                         boolean isRemote,
                         boolean started,
                         boolean paused,
                         boolean shutdown,
                         java.util.Date startTime,
                         int numJobsExec,
                         java.lang.Class jsClass,
                         boolean jsPersistent,
                         java.lang.Class tpClass,
                         int tpSize,
                         java.lang.String version)
Method Detail

getSchedulerName

public java.lang.String getSchedulerName()

Returns the name of the Scheduler.


getSchedulerInstanceId

public java.lang.String getSchedulerInstanceId()

Returns the instance Id of the Scheduler.


getSchedulerClass

public java.lang.Class getSchedulerClass()

Returns the class-name of the Scheduler instance.


runningSince

public java.util.Date runningSince()

Returns the Date at which the Scheduler started running.

Returns:
null if the scheduler has not been started.

numJobsExecuted

public int numJobsExecuted()

Returns the number of jobs executed since the Scheduler started..


isSchedulerRemote

public boolean isSchedulerRemote()

Returns whether the Scheduler is being used remotely (via RMI).


isStarted

public boolean isStarted()

Returns whether the scheduler has been started.

Note: isStarted() may return true even if isPaused() returns true.


isPaused

public boolean isPaused()

Reports whether the Scheduler is paused.

Note: isStarted() may return true even if isPaused() returns true.


isShutdown

public boolean isShutdown()

Reports whether the Scheduler has been shutdown.


getJobStoreClass

public java.lang.Class getJobStoreClass()

Returns the class-name of the JobStore instance that is being used by the Scheduler.


jobStoreSupportsPersistence

public boolean jobStoreSupportsPersistence()

Returns whether or not the Scheduler's JobStore instance supports persistence.


getThreadPoolClass

public java.lang.Class getThreadPoolClass()

Returns the class-name of the ThreadPool instance that is being used by the Scheduler.


getThreadPoolSize

public int getThreadPoolSize()

Returns the number of threads currently in the Scheduler's ThreadPool.


getVersion

public java.lang.String getVersion()

Returns the version of Quartz that is running.


toString

public java.lang.String toString()

Return a simple string representation of this object.


getSummary

public java.lang.String getSummary()
                            throws SchedulerException

Returns a formatted (human readable) String describing all the Scheduler's meta-data values.

The format of the String looks something like this:


 Quartz Scheduler 'SchedulerName' with instanceId 'SchedulerInstanceId'
   Scheduler class: 'org.quartz.impl.StdScheduler' - running locally.
   Running since: '11:33am on Jul 19, 2002'
   Not currently paused.
   Number of Triggers fired: '123'
   Using thread pool 'org.quartz.simpl.SimpleThreadPool' - with '8' threads
   Using job-store 'org.quartz.impl.JDBCJobStore' - which supports persistence.
 

Throws:
SchedulerException


Copyright James House (c) 2001-2004