Ever thought of running scheduled tasks within JIRA? Why do we need scheduled tasks when we have the JIRA Services? We have seen how to write a service in one of the previous posts. But in spite of all its advantages discussed there, services have a disadvantage. It always starts when JIRA is restarted and runs at regular intervals after that. So if you have a service that do some heavy memory intensive operation and if you restart JIRA in the middle of the day, you will suddenly find your instance's performance compromised! If it is scheduled to run every 24 hours, you will find the same service running in the middle of the day from then on until the next restart.
Scheduled tasks in JIRA are a good way to make sure all such operations happen at quite times, midnight for example. In this post we will write a real simple scheduled tasks and see how easy that can be!
Scheduled tasks in JIRA are a good way to make sure all such operations happen at quite times, midnight for example. In this post we will write a real simple scheduled tasks and see how easy that can be!
The first task to create a scheduled task is to write a Java class that implements the Quartz Job interface. JIRA internally uses Quartz for scheduling its tasks and so Quartz comes bundled within JIRA. Our scheduled job just prints a line to the console and hence the Java class that we write is as simple as follows:
package com.jtricks;
import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
public class JTricksScheduledJob implements Job{
public void execute(JobExecutionContext context) throws JobExecutionException {
System.out.println("Running the job at "+(new Date()).toString());
}
}
As you can see, the only thing we need to do here is to implement the execute method. Whatever we do in the method can be as simple as the above one liner or as complex as initiating a nuclear explosion!
The next task is to let JIRA know of our new task that we have written and also define the schedule for it. For that, we first need to create a jar file with the above class and drop it under the WEB-INF/lib folder of your JIRA installation. Note that it is not a v2 plugin and hence dropping it under JIRA_HOME/plugins/installed-plugins won't work.
JIRA stores the schedule tasks information in the scheduler-config.xml file under WEB-INF/classes folder. We need to define the schedule for our new task in the same file. First we need to define a job under the jobs tag as shown:
package com.jtricks;
import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
public class JTricksScheduledJob implements Job{
public void execute(JobExecutionContext context) throws JobExecutionException {
System.out.println("Running the job at "+(new Date()).toString());
}
}
As you can see, the only thing we need to do here is to implement the execute method. Whatever we do in the method can be as simple as the above one liner or as complex as initiating a nuclear explosion!
The next task is to let JIRA know of our new task that we have written and also define the schedule for it. For that, we first need to create a jar file with the above class and drop it under the WEB-INF/lib folder of your JIRA installation. Note that it is not a v2 plugin and hence dropping it under JIRA_HOME/plugins/installed-plugins won't work.
JIRA stores the schedule tasks information in the scheduler-config.xml file under WEB-INF/classes folder. We need to define the schedule for our new task in the same file. First we need to define a job under the jobs tag as shown:
<job name="JTricksJob" class="com.jtricks.JTricksScheduledJob" />
Next, we need to add a trigger that runs the JTricksJob. This is where we define the cron expression to run the job at defined timings.
<trigger name="JTricksJobTrigger" job="JTricksJob" type="cron">
<expression>0 0/2 * * * ?</expression><!-- run every 2 minutes -->
</trigger>
The above trigger schedules the job to run every 2 minutes. Lot more details on writing a cron expression can be found here. And that's it! The scheduled job is ready to run. All we need now is to restart JIRA.
Once JIRA is restarted, the new job can be seen at the scheduler details page under Administration > Scheduler Details. We can also verify the next fire time for the task in the same page as shown in the below picture.
<trigger name="JTricksJobTrigger" job="JTricksJob" type="cron">
<expression>0 0/2 * * * ?</expression><!-- run every 2 minutes -->
</trigger>
The above trigger schedules the job to run every 2 minutes. Lot more details on writing a cron expression can be found here. And that's it! The scheduled job is ready to run. All we need now is to restart JIRA.
Once JIRA is restarted, the new job can be seen at the scheduler details page under Administration > Scheduler Details. We can also verify the next fire time for the task in the same page as shown in the below picture.
And when the job runs, you will see the following printed in the console!
That was simpler than we thought. Wasn't it? Attached is the sample code we have seen and the modified scheduler-config.xml. Enjoy the new trick!
| scheduled-task-plugin.zip |
RSS Feed