org.quartz.ee.servlet
Class QuartzInitializerServlet

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 teh 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);
Once you have the factory instance, you can retrieve the Scheduler instance by calling getScheduler() on the factory.
SinceNot specified.
VersionNot specified.
AuthorJames House, Chuck Cavaness
Wiki javadoc Use textile entry format.
Add your comments here.
Field Summary
static String QUARTZ_FACTORY_KEY
No description provided.
Constructor Summary
QuartzInitializerServlet()
No description provided.
Method Summary
void destroy()
No description provided.
void doGet( HttpServletRequest request, HttpServletResponse response )
No description provided.
void doPost( HttpServletRequest request, HttpServletResponse response )
No description provided.
void init( ServletConfig cfg )
No description provided.
QUARTZ_FACTORY_KEY
public static String QUARTZ_FACTORY_KEY
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
QuartzInitializerServlet
public QuartzInitializerServlet ( )
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
destroy
public void destroy ( )
No description provided.
Overrides method in GenericServlet
Returns void No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
doGet
public void doGet ( HttpServletRequest request, HttpServletResponse response )
No description provided.
Overrides method in HttpServlet
Parameters
TypeNameDescription
HttpServletRequest request No description provided.
HttpServletResponse response No description provided.
Returns void No description provided.
Exceptions
ServletException No description provided.
IOException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
doPost
public void doPost ( HttpServletRequest request, HttpServletResponse response )
No description provided.
Overrides method in HttpServlet
Parameters
TypeNameDescription
HttpServletRequest request No description provided.
HttpServletResponse response No description provided.
Returns void No description provided.
Exceptions
ServletException No description provided.
IOException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
init
public void init ( ServletConfig cfg )
No description provided.
Overrides method in GenericServlet
Parameters
TypeNameDescription
ServletConfig cfg No description provided.
Returns void No description provided.
Exceptions
ServletException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.