| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src\site\xdoc/configuration.xml at 14 September 2021 |
| | Rendered using Apache Maven Fluido Skin 1.9 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" /> |
| <meta name="author" content="Siegfried Goeschl" /> |
| <title>Fulcrum Quartz Service – Fulcrum Quartz Service</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-1.9.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><a href="../../" id="bannerLeft" title="Apache Turbine"><img src="../../images/turbine-project.png" alt="Apache Turbine"/></a></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 14 September 2021<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.1.3-SNAPSHOT</li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="../" title="Fulcrum">Fulcrum</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="../../" title="Turbine">Turbine</a></li> |
| <li class="pull-right"><a href="https://www.apache.org" class="externalLink" title="Apache">Apache</a></li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Overview</li> |
| <li><a href="index.html" title="About"><span class="none"></span>About</a></li> |
| <li class="active"><a href="#"><span class="none"></span>Configuration</a></li> |
| <li><a href="cronsamples.html" title="Cron Samples"><span class="none"></span>Cron Samples</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="https://www.apache.org/" class="externalLink" title="Apache Website"><span class="none"></span>Apache Website</a></li> |
| <li><a href="https://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works"><span class="none"></span>How the ASF works</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> |
| <li><a href="https://www.apache.org/security/" class="externalLink" title="Security"><span class="none"></span>Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10" > |
| |
| |
| <section> |
| <h2><a name="Configuration"></a>Configuration</h2> |
| |
| <section> |
| <h3><a name="Role_Configuration"></a>Role Configuration</h3> |
| |
| <p> |
| First you have to instantiate the Quartz service. |
| </p> |
| |
| <div class="source"><pre class="prettyprint"> |
| <role |
| name="org.apache.fulcrum.quartz.QuartzScheduler" |
| shorthand="quartz" |
| default-class="org.apache.fulcrum.quartz.impl.QuartzSchedulerImpl" |
| /> |
| </pre></div> |
| </section> |
| |
| <section> |
| <h3><a name="Component_Configuration"></a>Component Configuration</h3> |
| |
| <table border="0" class="table table-striped"> |
| |
| <tr class="a"> |
| |
| <th>Item</th> |
| |
| <th>Datatype</th> |
| |
| <th>Cardinality</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td>configuration</td> |
| |
| <td>Complex</td> |
| |
| <td>[0|1]</td> |
| |
| <td> |
| Contains the Quartz configuration either as property file or |
| a set of properties. |
| </td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td>configuration/propertyFile</td> |
| |
| <td>String</td> |
| |
| <td>[0|1]</td> |
| |
| <td> |
| Contains the location of a Quartz configuration file. The configuration |
| is loaded from the file system or from the classpath. |
| </td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td>configuration/properties</td> |
| |
| <td>Complex</td> |
| |
| <td>[0|1]</td> |
| |
| <td> |
| Contains a list of properties used for configuring Quartz |
| </td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td>configuration/properties/parameter</td> |
| |
| <td>String</td> |
| |
| <td>Simple</td> |
| |
| <td> |
| Contains a single configuration parameter consisting of 'name' |
| and 'value' attribute. |
| </td> |
| </tr> |
| </table> |
| </section> |
| |
| <section> |
| <h3><a name="Component_Configuration_Example_1"></a>Component Configuration Example 1</h3> |
| |
| <p> |
| A simple component configuration based on the XML configuration file |
| </p> |
| |
| <div class="source"><pre class="prettyprint"> |
| <quartz> |
| <configuration> |
| <properties> |
| <parameter |
| name="org.quartz.scheduler.instanceName" |
| value="TestScheduler" |
| /> |
| <parameter |
| name="org.quartz.scheduler.instanceId" |
| value="AUTO" |
| /> |
| <parameter |
| name="org.quartz.threadPool.class" |
| value="org.quartz.simpl.SimpleThreadPool" |
| /> |
| <parameter |
| name="org.quartz.threadPool.threadCount" |
| value="3" |
| /> |
| <parameter |
| name="org.quartz.threadPool.threadPriority" |
| value="5" |
| /> |
| <parameter |
| name="org.quartz.jobStore.misfireThreshold" |
| value="60000" |
| /> |
| <parameter |
| name="org.quartz.jobStore.class" |
| value="org.quartz.simpl.RAMJobStore" |
| /> |
| <parameter |
| name="org.quartz.plugin.jobInitializer.class" |
| value="org.quartz.plugins.xml.XMLSchedulingDataProcessorPlugin" |
| /> |
| <parameter |
| name="org.quartz.plugin.jobInitializer.fileNames" |
| value="./src/test/quartz.xml" |
| /> |
| <parameter |
| name="org.quartz.plugin.jobInitializer.failOnFileNotFound" |
| value="true" |
| /> |
| <parameter |
| name="org.quartz.plugin.jobInitializer.scanInterval" |
| value="120" |
| /> |
| <parameter |
| name="org.quartz.plugin.jobInitializer.wrapInUserTransaction" |
| value="false" |
| /> |
| </properties> |
| </configuration> |
| </quartz> |
| </pre></div> |
| </section> |
| |
| <section> |
| <h3><a name="Component_Configuration_Example_2"></a>Component Configuration Example 2</h3> |
| |
| <p> |
| A component configuration using an external property file |
| </p> |
| |
| <div class="source"><pre class="prettyprint"> |
| <quartz> |
| <configuration> |
| <propertyFile>./src/test/quartz.properties</propertyFile> |
| </configuration> |
| </quartz> |
| </pre></div> |
| </section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2004–2021 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
