Time Warp mit dem Quartz Scheduler

Was verbindet Newsletter, Hotfolder und die Defragmentierung von Festplatten? Eigentlich nichts, aber alle drei benötigen regelmäßige Wiederholungen.
Wenn man sich etwas umsieht, entdeckt man ziemlich viele Anwendungsfälle, bei denen etwas wiederholt werden muss: Automatisch aus Datenbanken generierte Statistiken, automatisierte Downloads von FTP-Servern, Batch-Processing von eintreffenden Dateien usw.

Um das mit Java in den Griff zu bekommen, gibt es ein ideales Tool: den Quartz Enterprise Job Scheduler von OpenSymphony. Der Name lässt vermuten, dass Quartz für JavaEE gedacht ist, aber in JavaSE funktioniert es genauso, und damit sind durch Zeitgeber gesteuerte Desktop-Anwendungen in Reichweite!

Fortsetzung:

Zu Quartz gibt es ein offizielles Tutorial (engl.), das ich durch eine kurze Step-by-Step Einführung ergänzen möchte. Ziel: Eine Desktop-Anwendung mit verschiedenen Jobs und Triggern, die in einer MySQL-Datenbank gespeichert werden.

Das hat gleich mehrere Vorteile: Zunächst die dauerhafte Sicherung der zu erledigenden Aufgaben, auch wenn das Programm zwischendurch mal nicht laufen sollte. Quartz kann verpasste Aufgaben in einem definierten Zeitraum nachholen. Hinzu kommt die Möglichkeit, die Aufgaben und deren Ausführungszeiten (Trigger) direkt über die Datenbank zu administrieren, z.B. mit einem in PHP programmierten Web-Frontend.
Aber eins nach dem anderen...

It's just a jump to the left.

Fangen wir mit den Grundvoraussetzungen an. Für diese Einführung wird folgendes benötigt:

• Eine Java IDE, z.B. Netbeans oder Eclipse. Ich verwende ersteres.
• Die Quartz Libraries, hier in Version 1.4.5.
• Eine Datenbank mit passendem JDBC-Treiber. Für MySQL gibt es den JDBC Driver (Connector/J). Alternativen wären Cloudscape, DB2, HSQLDB, Informix, Oracle, Postgres u.a.m.

And then a step to the right.

Die Quartz Libraries (alle JAR-Dateien im lib-Ordner) und den MySQL-Treiber (mysql-connector-java-5.0.7-bin.jar) nehme ich zunächst in mein Netbeans-Projekt auf. Anschließend muss die Datenbank vorbereitet werden. Quartz liefert eine Reihe von SQL-Skripts mit (in quartz-1.4.5/docs/dbTables), darunter auch eines für MySQL. Ich habe eine neue Datenbank „launchpad“ erzeugt, das Skript darin gestartet und einen neuen User angelegt. Diese Informationen benötigt natürlich auch das Quartz-Programm. Dazu kopiert man am besten die Datei quartz-1.4.5/docs/config/example_quartz.properties direkt in das src-Verzeichnis des Java-Projekts und benennt sie in quartz.properties um. Man findet die Datei anschließend in Netbeans unter Source Packages/default package und kann sie öffnen und anpassen. Ich habe folgendes geändert:

Code:

Damit sind die Vorbereitungen abgeschlossen und die eigentliche Programmierung kann beginnen!

With your hands on your hips.

Ich erstelle zunächst eine neue JFrame-Klasse für das Programmfenster und nenne sie Hauptfenster.java. Sie erhält zwei Methoden zum Starten und Beenden des Quartz Schedulers:

Code:

Dann noch drei Import-Anweisungen:

Code:

Und schließlich den Aufruf der beiden oben genannten Methoden: Im Konstruktor startQuartz(); und in einem WindowClosing-Eventhandler stopQuartz();

Hier die Hauptfenster-Klasse, die bereits eine vollständige Quartz-Anwendung mit Datenbank-Anbindung darstellt:

Code:

Beim Programmstart kann in der Konsolenausgabe verfolgt werden, ob alles klappt. Eine Startsequenz sieht z.B. so aus:

Code:

Beim Schließen des Programmfensters folgt

Code:

Und damit können wir uns direkt auf die Konfiguration einzelner Jobs und deren Zeitpläne stürzen.

You bring your knees in tight.

Dazu benötigt man drei Dinge:

• Ein JobDetail-Objekt, das definiert, was zu tun ist.
• Eine JobDataMap, die die Parameter des Jobs festlegt.
• Einen (oder mehrere) Trigger für die Ausführungszeitpunkte.

Ein paar Standard-Aktionen sind in Quartz schon enthalten, daher ist es sehr einfach, z.B. einen Befehl ans Betriebssystem abzugeben. Das erledigt man am besten mit einem NativeJob. Er heißt übrigens so, weil er die Befehle abhängig vom jeweiligen Betriebssystem weitergibt.

Code:

Leider haben die Entwickler die Klasse NativeJob nur für die Konfiguration
org.quartz.jobStore.useProperties = false
geschrieben, wir haben diesen Wert aber eben auf „true“ gesetzt. Und zwar mit Absicht – damit werden die Job-Konfigurationen nämlich nicht als serialisierte Objekte, sondern als Strings gespeichert. Und damit sind spätere Änderungen an eigenen Jobklassen mit deutlich weniger Problemen verbunden. Sogar im offiziellen Tutorial wird empfohlen, hier „true“ einzustellen.
Damit brauchen wir eine Variante der Klasse NativeJob, die mit der obigen Einstellung klar kommt. Ich habe diese Variante SystemJob genannt, hier ist sie:

Code:

Um den neuen Job zu definieren, heißt es nun:

Code:

Damit haben wir einen neuen Job erzeugt, ihm den Namen „FileZilla starten“ gegeben, einer Gruppe zugeordnet und die auszuführende Klasse definiert. Alle drei Angaben sind Pflicht! Jeder Job muss einen eindeutigen Namen haben und einer Gruppe angehören.

Als nächstes folgt die Konfiguration des Jobs:

Code:

Ich möchte hier einfach das Programm FileZilla ohne weitere Parameter starten.
Man beachte die Anweisung „putAsString“ in der letzten Zeile: Boolean-Werte müssen zwingend so definiert werden, wenn man in den quartz.properties „org.quartz.jobStore.useProperties = true“ eingestellt hat. Das steht nicht im offiziellen Tutorial!

So, damit ist für Quartz klar, was zu tun ist, aber noch nicht wann. Dafür brauchen wir einen Trigger, der zu definierten Zeiten dem Job ein Startsignal gibt. Übrigens kann man für jeden Job beliebig viele Trigger anlegen.
Die Zeiteinstellung kann auf zwei Weisen erfolgen: Entweder mit einem SimpleTrigger für einfache Wiederholungen in festen Abständen, oder mit einem CronTrigger, der sehr spezielle Einstellungen ermöglicht.

Ein SimpleTrigger sieht z.B. so aus:

Code:

Der Trigger erhält einen Namen, eine Gruppenzuordnung, einen Startzeitpunkt („new Date()“ bedeutet „jetzt“), einen Endzeitpunkt („null“ heißt „nie“), die Anzahl der Wiederholungen (hier: unendlich) und das Zeitintervall in Millisekunden (hier: jede volle Minute).

Nun müssen wir nur noch Job und Trigger miteinander verbinden und starten:

Code:

... und schon freuen wir uns, dass jede Minute ein Programm gestartet wird, bis das Java-Programmfenster wieder geschlossen wird.

Let's do the time warp again

Na ja, vielleicht fällt uns ja auch noch eine sinnvollere Anwendung ein...

Hier das Ganze als Methode „createJob“:

Code:

Ich habe eine kurze Abfrage vorgeschaltet, die prüft, ob es schon irgendwelche Jobs gibt. Die „createJob“-Methode kann jetzt einfach aus dem Konstruktor heraus gestartet werden.

Code:

Der Import-Block müsste jetzt so ausssehen, damit alles funktioniert:

Code:

Jetzt ist es ganz interessant, mit einem Tool wie HeidiSQL die Tabellen und Einträge in der Datenbank „launchpad“ anzusehen. In der Tabelle „qrtz_job_details“ steht der Job mit allen Parametern, die Konfiguration findet sich im BLOB-Feld JOB_DATA.

Wie geht’s weiter? Am besten mit dem offiziellen Tutorial und Ideen für eigene Jobs: FTP-Verzeichnisse überwachen, PHP-Skripts starten und deren Output per Mail senden, Batchfiles starten u.v.m. Viel Erfolg!

Zum Weiterlesen:
Quartz User Forum