Wiki source code of Create Scheduler jobs in Java
Version 4.1 by Vincent Massol on 2020/01/28
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | XWiki provides a [[Scheduler Application>>extensions:Extension.Scheduler Application]] that offers the possiblity of creating jobs and perform actions on these jobs (Schedule, Trigger, Cancel ...). | ||
| 2 | |||
| 3 | Jobs created by the scheduler application executes a Groovy script periodicaly following a predifined period that is using a Cron expression. | ||
| 4 | |||
| 5 | A Scheduler Job is an **XWiki.SchedulerJobClass** object attached to a wiki page. | ||
| 6 | |||
| 7 | The script to excute is set in the Job Script property of the **XWiki.SchedulerJobClass** object, it is a groovy script. | ||
| 8 | |||
| 9 | In this post we will provide a solution to use Java code instead of Groovy in the Job Script. | ||
| 10 | |||
| 11 | ==Use Java in the job script== | ||
| 12 | To use java in the Job script you will need 2 steps: | ||
| 13 | 1) Create a java class that extends **com.xpn.xwiki.plugin.scheduler.AbstractJob** class and implements the **org.quartz.Job** interface. | ||
| 14 | 2) Set the Job **class** property with the full java class name and let the Job script property empty. | ||
| 15 | |||
| 16 | === Create the java class=== | ||
| 17 | The class will need a Cron experession to be used to excute the job periodically. The Cron expression will be provided by the Scheduler Job object. | ||
| 18 | |||
| 19 | In the java class we will need to override the **executeJob** method that will be called periodically from the scheduler. | ||
| 20 | |||
| 21 | We will take the **watchlist scheduler jobs**. as an example, the Scheduler job page is **Scheduler.WatchListDailyNotifier** in your Wiki and the java class is [[here>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-watchlist/xwiki-platform-watchlist-api/src/main/java/org/xwiki/watchlist/internal/job/WatchListJob.java]] | ||
| 22 | |||
| 23 | ====Methods that need to be defined in the class==== | ||
| 24 | |||
| 25 | **init** method: Sets objects required by the Job : XWiki, XWikiContext, Components ... etc. | ||
| 26 | |||
| 27 | {{code}} | ||
| 28 | ... | ||
| 29 | public void init(JobExecutionContext jobContext) throws Exception | ||
| 30 | { | ||
| 31 | JobDataMap data = jobContext.getJobDetail().getJobDataMap(); | ||
| 32 | |||
| 33 | this.watchlist = Utils.getComponent(WatchList.class); | ||
| 34 | this.schedulerJobObject = (BaseObject) data.get("xjob"); | ||
| 35 | this.watchListJobObject = | ||
| 36 | getXWikiContext().getWiki().getDocument(this.schedulerJobObject.getDocumentReference(), getXWikiContext()) | ||
| 37 | .getXObject(WatchListJobClassDocumentInitializer.DOCUMENT_REFERENCE); | ||
| 38 | } | ||
| 39 | ... | ||
| 40 | {{/code}} | ||
| 41 | |||
| 42 | **executeJob** method: Method called from the scheduler. | ||
| 43 | |||
| 44 | {{code}} | ||
| 45 | ... | ||
| 46 | @Override | ||
| 47 | public void executeJob(JobExecutionContext jobContext) throws JobExecutionException | ||
| 48 | { | ||
| 49 | try { | ||
| 50 | init(jobContext); | ||
| 51 | |||
| 52 | if (this.watchListJobObject == null) { | ||
| 53 | return; | ||
| 54 | } | ||
| 55 | |||
| 56 | Collection<String> subscribers = getSubscribers(); | ||
| 57 | |||
| 58 | // Stop here if nobody is interested. | ||
| 59 | if (!hasSubscribers()) { | ||
| 60 | return; | ||
| 61 | } | ||
| 62 | |||
| 63 | // Determine what happened since the last execution for everybody. | ||
| 64 | Date previousFireTime = getPreviousFireTime(); | ||
| 65 | WatchListEventMatcher eventMatcher = Utils.getComponent(WatchListEventMatcher.class); | ||
| 66 | List<WatchListEvent> events = eventMatcher.getEventsSince(previousFireTime); | ||
| 67 | setPreviousFireTime(); | ||
| 68 | |||
| 69 | // Stop here if nothing happened in the meantime. | ||
| 70 | if (events.size() == 0) { | ||
| 71 | return; | ||
| 72 | } | ||
| 73 | |||
| 74 | // Notify all the interested subscribers of the events that occurred. | ||
| 75 | // When processing the events, a subscriber will only be notified of events that interest him. | ||
| 76 | Map<String, Object> notificationData = new HashMap<>(); | ||
| 77 | notificationData.put(DefaultWatchListNotifier.PREVIOUS_FIRE_TIME_VARIABLE, previousFireTime); | ||
| 78 | |||
| 79 | String mailTemplate = | ||
| 80 | this.watchListJobObject.getStringValue(WatchListJobClassDocumentInitializer.TEMPLATE_FIELD); | ||
| 81 | notificationData.put(WatchListEventMimeMessageFactory.TEMPLATE_PARAMETER, mailTemplate); | ||
| 82 | |||
| 83 | // Send the notification for processing. | ||
| 84 | this.watchlist.getNotifier().sendNotification(subscribers, events, notificationData); | ||
| 85 | } catch (Exception e) { | ||
| 86 | // We're in a job, we don't throw exceptions | ||
| 87 | LOGGER.error("Exception while running job", e); | ||
| 88 | } | ||
| 89 | } | ||
| 90 | ... | ||
| 91 | {{/code}} | ||
| 92 | |||
| 93 | Find a complete example here: https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-watchlist/xwiki-platform-watchlist-api/src/main/java/org/xwiki/watchlist/internal/job/WatchListJob.java | ||
| 94 | |||
| 95 | ===Set the Job class property with the java full class name=== | ||
| 96 | Edit the **Scheduler.WatchListDailyNotifier** in Object mode and update the **Job class** property of the **XWiki.SchedulerJobClass** object with the full java class name and let the **Job script** property empty. | ||
| 97 | |||
| 98 | {{image reference="edit-job.png"/}} | ||
| 99 | //Scheduler job object// | ||
| 100 | |||
| 101 | == Conclusion == | ||
| 102 | |||
| 103 | This approach will allow you to take advantage of all power that Java provides in scheduler jobs. |
