1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
==============================================================================
This file is intended to help you get started with the Quartz project.
For more information see http://www.quartz-scheduler.org
==============================================================================
What is Quartz?
==============================================================================
Quartz is an open source project aimed at creating a free-for-use Job
Scheduler, with enterprise features.
Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy
of the License at
http://www.apache.org/licenses/LICENSE-2.0
Additionally, a copy of the license and its accompanying notice file is
included with the distribution.
What is in this package?
==============================================================================
quartz-all-<ver>.jar all-in-one Quartz library. Includes the core
Quartz components plus all optional packages. If
you use this library, no other quartz-*.jars are
necessary.
quartz-<ver>.jar core Quartz library.
quartz-jboss-<ver>.jar optional JBoss specific Quartz extensions such as
the Quartz startup MBean, QuartzService.
quartz-oracle-<ver>.jar optional Oracle specific Quartz extensions such as
the OracleDelegate.
quartz-terracotta-<ver>.jar optional Terracotta specific Quartz extension to
enable the Terracotta Job Store for Terracotta
based clustering (Located in the Terracotta Kit
http://www.terracotta.org/dl/oss-download-catalog)
quartz-weblogic-<ver>.jar optional WebLogic specific Quartz extensions such
as the WebLogicDelegate.
README.txt this file.
LICENSE.txt a document declaring the license under which
Quartz can be used and distributed.
docs/dbTables sql scripts for creating Quartz database tables in
a variety of different databases.
quartz source code for the main quartz module, including
the following packages:
org.quartz the main package of the Quartz project,
containing the 'public' (client-side) API for
the scheduler
org.quartz.core a package containing the 'private' (server-side)
components of Quartz.
org.quartz.simpl a package contain simple implementations of
Quartz support modules (JobStores, ThreadPools,
Loggers, etc.) that have no dependencies on
external (third-party) products.
org.quartz.impl a package containing implementations of Quartz
support modules (JobStores, ThreadPools,
Loggers, etc.) that may have dependencies on
external (third-party) products - but may be
more robust.
org.quartz.utils a package containing some utility/helper
components used through-out the main Quartz
components.
quartz-jboss source code for the quartz-jboss module
quartz-oracle source code for the quartz-oracle module
quartz-weblogic source code for the quartz-weblogic module
quartz-all module to compile the quartz-all jar
examples a directory containing some code samples on the
usage of Quartz. The first example you should
look at is 'example1.bat' or 'example1.sh' -
depending if you're a win-dos or unix person.
This example uses the code found in the
SchedTest.java class, which is also in the
examples directory.
lib a directory which should contain all of the
third-party libraries that are needed in order
to use all of the features of Quartz. (Some are
not automatically there, but you need to get
them and put them there if you use the features
they depend on -- see below).
Where should I start if I am new to Quartz?
==============================================================================
There is an FAQ, tutorial and configuration reference that can be found on the
main Quartz website at http://quartz-scheduler.org/docs/index.html
Most of the Java source files are fairly well documented with JavaDOC -
consider this your "reference manual".
Start by looking at org.quartz.Scheduler, org.quartz.Job,
org.quartz.JobDetail and org.quartz.Trigger.
Examine and run the examples found in the "examples" directory.
If you're interested in the "behind the scenes" (server-side) code,
you'll want to look at org.quartz.core.QuartzSchedulerThread, which
will make you interested in org.quartz.spi.JobStore.java,
org.quartz.spi.ThreadPool.java and org.quartz.core.JobRunShell.
What should I do if I encounter a problem?
==============================================================================
Help is available via the Quartz Users forum:
http://forums.terracotta.org/forums/forums/show/17.page
Please report bugs / issues to JIRA at:
https://jira.terracotta.org/jira/browse/QTZ
How do I build Quartz?
==============================================================================
Quartz is built using the Maven project management tool. If you don't
already have Maven installed, download it from the Apache website
(http://maven.apache.org) and follow the installation instructions. You can
confirm the version of Maven you have installed by typing: mvn --version
To build, simply execute "mvn install" from the top level Quartz project
directory. This command will build the Quartz JAR files and install them
into your local repository. Along the way it will also execute all of the
Quartz unit and integration tests. You can disable tests by
passing -Dmaven.test.skip=true on the mvn command-line.
By default, only the main "quartz" module and the "quartz-jboss" module
JARs are built. The quartz-oracle and quartz-weblogic depend on
proprietary Oracle and Weblogic JARs that are not available in any public
Maven repositories, and therefore these modules have been excluded from
the default build. To build these modules you will need to obtain the
following JAR files and install them into your local Maven repository:
com.oracle:ojdbc5:jar:11.2.0
com.bea.core:datasource:jar:1.6.0
Once you have these artifacts installed into your local repository you can
enable the quartz-oracle and quartz-weblogic modules by activating the Maven
profiles "oracle" and "weblogic" with the -P mvn command-line option.
For example:
mvn -Pweblogic install
Note that the quartz-weblogic module depends on the quartz-oracle
module, and therefore the weblogic Maven profile implies the oracle
profile.
To create the downloadable distribution, invoke the package phase and the
assembly:assembly plugin goal with prepare-distribution profile enabled,
i.e.:
mvn -Pprepare-distribution package assembly:assembly
To include the quartz-oracle and quartz-weblogic artifacts in the
distribution, make sure to enable the respective profiles when assembling
the package, i.e.:
mvn -Pprepare-distribution -Poracle,weblogic,all package assembly:assembly
How can I get started with the Terracotta Job Store?
==============================================================================
The Terracotta Job Store provides an easy way to implement a highly
available, highly scalable, and durable way to schedule jobs across
multiple nodes. As with other Terracotta solutions, Quartz clustering
can be achieved via a Terracotta Express installation as well as via a
Terracotta Custom Installation. To use the Terracotta Job Store in a
Custom Installation - i.e. in conjunction with other Terracotta DSO uses
(such as shared objects/shared roots/TIMs/clustered web sessions) please
consult the online documentation.
For an Express installation, simply include the quartz-<ver> and
quartz-terracotta-<ver> jars in your application classpath, and then
configure your app to use the Terracotta Job Store by setting the
following in your quartz.properties file (or set these properties
directly within the application)
org.quartz.jobStore.class = org.terracotta.quartz.TerracottaJobStore
org.quartz.jobStore.tcConfigUrl = localhost:9510
This assumes that you are running the Terracotta server on the localhost
(which can be started using the bin/start-tc-server.[sh|bat] script). If
not, replace localhost as appropriate. The Terracotta Job Store requires
Terracotta 3.2.0 or greater.
|
