My previous post explained how to use Quartz on JBoss 5.1, and gave you a heads-up about the way JBoss properties are mangled on Windows platforms.
Kudos to the guys at Terracotta, who picked up quickly on the corresponding issue I filed and included a fix in the very next release (which is 2.1, released September 16th)!
On our current project, we have the requirement to be able to run our application on more than JBoss AS alone. When confronted with the need to schedule certain tasks, we considered a few options:
So the decision was made to use Quartz, not as readily available from JBoss but as an add-on library (‘external’, if you will). I found a couple of articles that pointed me in the right direction:
We used Quartz version 2.0.2 – the latest and greatest at the time I write this – and since Maven is our build tool of choice, the following dependency pulls all required libs into our project:
<dependency>
<groupid>org.quartz-scheduler</groupid>
<artifactid>quartz-jboss</artifactid>
<version>2.0.2</version>
<scope>provided</scope>
</dependency>
We use provided scope here since we won’t be including Quartz in our project’s deliverables; instead we put such dependencies on our server explicitly. Either approach would work, though.
1) Clean up your installation.
So, the first job at hand is to remove the Quartz artifacts from our JBoss installation. I guess it makes sense to prevent different versions from showing up in your classpath. The files to be removed are:
Before deleting anything from the common/lib directory, be sure that there aren’t any other servers running from the same AS installation that need that file!
2) Add the required Quartz libraries to you server.
The following file should be in place after this step:
That’s right. Just one jar, very convenient – and the added bonus is that this already contains the stuff that’s needed for deployment in other app servers, so no need to have different dependencies in different deployments.
Note that this file is not downloaded if you include the dependencies through Maven as indicated above, you have to download the full distribution to get it.
3) Add an MBean to the JBoss configuration.
The following is a simple example of a Quartz MBean configuration:
<server>
<mbean code="org.quartz.ee.jmx.jboss.QuartzService" name="user:service=QuartzService,name=QuartzService">
<attribute name="JndiName">Quartz</attribute>
<attribute name="Properties">
org.quartz.scheduler.instanceName = DefaultQuartzScheduler
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount = 5
org.quartz.threadPool.threadPriority = 4
org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore
</attribute>
</mbean>
</server>
If you use this, no extra DataSource needs to be configured and Quartz keeps its jobs in memory. For more specifics on the configuration possibilities (there are a lot!), see http://www.quartz-scheduler.org/docs/configuration/.
Put the XML above in a x-service.xml file in your server’s deploy dir, like e.g.:
4) Point Quartz at the jobs you want done.
Obviously it now is possible to use Quartz from code inside deployed applications. Just retrieve the scheduler from JNDI like so:
InitialContext ctx = new InitialContext();
Scheduler scheduler = (Scheduler) ctx.lookup("Quartz");
But for our purpose this just isn’t good enough, we want to be able to schedule tasks from configuration files. To accomplish that, we need to perform a number of steps:
a) Enable the Quartz plugin that reads jobs and triggers from an indicated XML file. This is done by adding the following properties to the configuration shown in step 3):
org.quartz.plugin.jobInitializer.class = org.quartz.plugins.xml.XMLSchedulingDataProcessorPlugin
org.quartz.plugin.jobInitializer.fileNames = ${jboss.server.home.dir}/conf/quartz-jobs.xml
org.quartz.plugin.jobInitializer.scanInterval = 120
For details on this plugin see http://www.quartz-scheduler.org/api/2.0.0/org/quartz/plugins/xml/XMLSchedulingDataProcessorPlugin.html.
b) Create a class that implements the org.quartz.Job interface for each such a task. This interface exposes exactly one method, void execute(JobExecutionContext ctx), which is called when the job is triggered.
c) Provide the quartz-jobs.xml file that is indicated in the extra configuration in step a) (the file name and path can be adjusted to your liking) with the appropriate timing to start your jobs. For our tasks we use Cron-like jobs, with the Quartz CronTrigger (see http://www.quartz-scheduler.org/api/2.0.0/org/quartz/CronTrigger.html). An example configuration is:
<job-scheduling-data version="1.8" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.quartz-scheduler.org/xml/JobSchedulingData" xsi:schemalocation="http://www.quartz-scheduler.org/xml/JobSchedulingData http://www.quartz-scheduler.org/xml/job_scheduling_data_1_8.xsd">
<pre-processing-commands>
<delete-jobs-in-group>*</delete-jobs-in-group>
<delete-triggers-in-group>*</delete-triggers-in-group>
</pre-processing-commands>
<processing-directives>
<overwrite-existing-data>true</overwrite-existing-data>
<ignore-duplicates>false</ignore-duplicates>
</processing-directives>
<schedule>
<job>
<name>TestJob</name>
<job-class>com.acme.quartz.TestJob</job-class>
</job>
<trigger>
<cron>
<name>TestCronTrigger</name>
<job-name>TestJob</job-name>
<cron-expression>0 0 3 ? * MON-FRI</cron-expression>
</cron>
</trigger>
</schedule>
</job-scheduling-data>
In this example the task executed by the com.acme.quartz.TestJob class is triggered at 3:00 AM on weekdays.
One last CAVEAT: On Windows, the ${jboss.server.home.dir} expression resolves to a String that contains backward slashes (‘\’) instead of forward slashes as path delimiter. The way the Quartz extension for JBoss reads in the properties is not able to cope with that, so you may need to provide a full path explicitly for any file names.
This task can be divided into two independent components (configure Apache to use SSL, set up Apache as a reverse proxy for JBoss) and a single step to make those two work together. The guidelines below have been successfully tested on an Apache 2.2.17/JBoss EAP 5.1.0.GA combination, the latter using Tomcat native libs, on a single server.
Part 1: Use SSL for access to Apache
1) Download and install the Apache Httpd server (version 2.2.6 or higher, 2.2.17 is the current). The folder in which the server is installed is referred to as APACHE_HOME further on.
2) In APACHE_HOME/conf/httpd.conf, un-comment the following lines:
LoadModule ssl_module modules/mod_ssl.so
Include conf/extra/httpd-ssl.conf
Then comment the following one (to restrict access without SSL):
#Listen 80
3) Put your certificate and key in the APACHE_HOME/conf folder, and (if necessary) change the names in APACHE_HOME/conf/extra/httpd-ssl.conf entries to match:
SSLCertificateFile "[APACHE_HOME]/conf/server.crt"
SSLCertificateKeyFile "[APACHE_HOME]/conf/server.key"
If you don’t have a CA certificate, you can create a self-signed certificate for testing purposes, see e.g. the OpenSSL FAQ how to do so. An OpenSSL executable is provided in the APACHE_HOME/bin folder.
Remark: On Windows platforms it is not possible to use the SSLPassPhraseDialog-parameter (in httpd-ssl.conf) with the default value ‘builtin’. The simplest (albeit not the safest) solution is to remove the passphrase from the key, removing the need for Apache to ask for it at startup.
4) (Re-)start the Apache server and test whether it works as expected… and don’t forget the ‘https://’!
For an extensive explanation of the SSL configuration possibilities see Apache Module ssl_mod.
Part 2: Set Apache up as a reverse proxy for JBoss
1) Download the mod_jk connector (version 1.2.15 or higher, 1.2.31 is the current), rename the ‘mod_jk-1.2.[*]-httpd-2.2.x.so’ file to ‘mod_jk.so’ and move it to the APACHE_HOME/modules folder.
2) Add the following line to APACHE_HOME/conf/httpd.conf:
Include conf/mod-jk.conf
3) Create a new file in APACHE_HOME/conf with the name ‘mod-jk.conf’, and fill it with:
LoadModule jk_module modules/mod_jk.so
JkWorkersFile conf/workers.properties
JkLogFile logs/mod_jk.log
JkLogLevel info
JkLogStampFormat "[%a %b %d %H:%M:%S %Y]"
JkRequestLogFormat "%w %V %T"
JkOptions +ForwardKeySize +ForwardURICompatUnparsed -ForwardDirectories
# Mount your applications
###JkMount /application/* loadbalancer
# Mount all URLs:
JkMount /* node1
# You can addionally use external file for mount points.
###JkMountFile conf/uriworkermap.properties
# Mount file reload check interval in secs (0 = turned off).
###JkMountFileReload 60
# Add shared memory. Used only on unix platforms. The shm file is used by balancer and status workers.
###JkShmFile run/jk.shm
# Add jkstatus for managing runtime data:
<Location /jkstatus/>
JkMount status
Order deny,allow
Deny from all
Allow from 127.0.0.1
</Location>
When not all requests are to be redirected to node1 the line starting with ‘JkMount’ must be adjusted. Furthermore it is possible to use a separate properties file (using ‘JkMountFile’, with entries following the pattern ‘URL=worker’, e.g. ‘/jmx-console=node1’) if you need a more extensive redirection scheme.
In the configuration above the access to the status manager (worker with ID ‘status’) is restricted to clients running on the same host, just for illustrative purposes.
See the Tomcat connector reference for further details and possibilities.
4) Create a new file in APACHE_HOME/conf named ‘workers.properties’, and put the following in it:
# Define list of workers that will be used for mapping requests
# Define Node1
# modify the host as your host IP or DNS name.
worker.node1.type=ajp13
worker.node1.host=localhost
worker.node1.port=8009
worker.node1.ping_mode=A
#worker.node1.connection_pool_size=10 # Only if the number of allowed connections to the Httpd is higher than maxThreads in JBoss server.xml.
#worker.node1.lbfactor=1 # Only used for a member worker of a load balancer.
# For non-loadbalanced setup with a single node:
worker.list=node1
# Define Node2
# modify the host as your host IP or DNS name.
#worker.node2.type=ajp13
#worker.node2.host= node2.mydomain.com
#worker.node2.port=8009
#worker.node2.ping_mode=A
#worker.node2.connection_pool_size=10
#worker.node2.lbfactor=1
# Load-balancing behaviour
#worker.loadbalancer.type=lb
#worker.loadbalancer.balance_workers=node1,node2
#worker.loadbalancer.sticky_session=Off # Enabled by default.
#worker.list=loadbalancer
# Status worker for managing load balancer
worker.status.type=status
worker.list=status
Most lines above are commented out, since we’re aiming for a configuration for a single node without loadbalancing. It is straightforward to add more nodes, with or without loadbalancing; just pay attention to the fact that with loadbalancing the worker.list should not refer to the separate nodes but only to the loadbalancer worker.
5) For each (JBoss-)node a ‘jvmRoute’ attribute must be added to the <Engine>-element in JBOSS_HOME/server/[configuration]/deploy/jbossweb.sar/server.xml, using the corresponding name from the mod_jk-configuration as a parameter:
<Engine name="jboss.web" defaulthost="localhost" jvmroute="node1">
And for JBoss AS/EAP version 5 and above that is all that is required!
6) If you didn’t configure Apache to use SSL, you can now (re-)start the JBoss en Apache servers and test whether the redirecting functions as expected…
If you did configure SSL for Apache, hang on just a bit more…
Part 3: Combining the two solutions above
To be able to access Apache using SSL after which the request is passed to the JBoss instance over AJP, one last adjustment is required:
1) Move the JkMount directives from the APACHE_HOME/conf/mod-jk.conf file to the APACHE_HOME/conf/extra/httpd-ssl.conf file, and make sure they’re within the <VirtualHost> tags:
<VirtualHost _default_:443>
[…]
JkMount /* node1
<Location /jkstatus/>
JkMount status
Order deny,allow
Deny from all
Allow from 127.0.0.1
</Location>
</VirtualHost>
After a restart of the Apache server the pages served by JBoss will be available over HTTPS from Apache (port 443).
Be aware that they are also still available over HTTP from JBoss directly (on port 8080), since the configuration above didn’t remove that (default) situation. To accomplish that, you should comment the HTTP connector entry in the server.xml file of jbossweb.sar.