Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.quartz.ee.servlet
Class QuartzInitializerServlet

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by org.quartz.ee.servlet.QuartzInitializerServlet
All Implemented Interfaces:
Serializable, Servlet, ServletConfig
Deprecated. use QuartzInitializerListener instead. 

public class QuartzInitializerServlet
extends HttpServlet

A Servlet that can be used to initialize Quartz, if configured as a load-on-startup servlet in a web application.

You'll want to add something like this to your WEB-INF/web.xml file: 

     <servlet>
         <servlet-name>
             QuartzInitializer
         </servlet-name>
         <display-name>
             Quartz Initializer Servlet
         </display-name>
         <servlet-class>
             org.quartz.ee.servlet.QuartzInitializerServlet
         </servlet-class>
         <load-on-startup>
             1
         </load-on-startup>
         <init-param>
             <param-name>config-file</param-name>
             <param-value>/some/path/my_quartz.properties</param-value>
         </init-param>
         <init-param>
             <param-name>shutdown-on-unload</param-name>
             <param-value>true</param-value>
         </init-param>
         <init-param>
             <param-name>start-scheduler-on-load</param-name>
             <param-value>true</param-value>
         </init-param>
     </servlet>

The init parameter 'config-file' can be used to specify the path (and filename) of your Quartz properties file. If you leave out this parameter, the default ("quartz.properties") will be used.

The init parameter 'shutdown-on-unload' can be used to specify whether you want scheduler.shutdown() called when the servlet is unloaded (usually when the application server is being shutdown). Possible values are "true" or "false". The default is "true".

The init parameter 'start-scheduler-on-load' can be used to specify whether you want the scheduler.start() method called when the servlet is first loaded. If set to false, your application will need to call the start() method before the scheduler begins to run and process jobs. Possible values are "true" or "false". The default is "true", which means the scheduler is started.

A StdSchedulerFactory instance is stored into the ServletContext. You can gain access to the factory from a ServletContext instance like this: 
     StdSchedulerFactory factory = (StdSchedulerFactory) ctx
                .getAttribute(QuartzFactoryServlet.QUARTZ_FACTORY_KEY);

The init parameter 'servlet-context-factory-key' can be used to override the name under which the StdSchedulerFactory is stored into the ServletContext, in which case you will want to use this name rather than QuartzFactoryServlet.QUARTZ_FACTORY_KEY in the above example.

The init parameter 'start-delay-seconds' can be used to specify the amount of time to wait after initializing the scheduler before scheduler.start() is called.

Once you have the factory instance, you can retrieve the Scheduler instance by calling getScheduler() on the factory.

Author:
James House, Chuck Cavaness
See Also:
Serialized Form

Field Summary
static String QUARTZ_FACTORY_KEY
          Deprecated.  
 
Constructor Summary
QuartzInitializerServlet()
          Deprecated.  
 
Method Summary
 void destroy()
          Deprecated.  
 void doGet(HttpServletRequest request, HttpServletResponse response)
          Deprecated.  
 void doPost(HttpServletRequest request, HttpServletResponse response)
          Deprecated.  
 void init(ServletConfig cfg)
          Deprecated.  
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service
 
Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

QUARTZ_FACTORY_KEY

public static final String QUARTZ_FACTORY_KEY
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

QuartzInitializerServlet

public QuartzInitializerServlet()
Deprecated. 
Method Detail

init

public void init(ServletConfig cfg)
          throws ServletException
Deprecated. 
Specified by:
init in interface Servlet
Overrides:
init in class GenericServlet
Throws:
ServletException

destroy

public void destroy()
Deprecated. 
Specified by:
destroy in interface Servlet
Overrides:
destroy in class GenericServlet

doPost

public void doPost(HttpServletRequest request,
                   HttpServletResponse response)
            throws ServletException,
                   IOException
Deprecated. 
Overrides:
doPost in class HttpServlet
Throws:
ServletException
IOException

doGet

public void doGet(HttpServletRequest request,
                  HttpServletResponse response)
           throws ServletException,
                  IOException
Deprecated. 
Overrides:
doGet in class HttpServlet
Throws:
ServletException
IOException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Quartz Enterprise Job Scheduler Project Page
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2000-2005 - OpenSymphony