Tuesday, February 24, 2009

Quartz Scheduling

Quartz scheduling

Quartz is a full-featured, open source job scheduling system that can beintegrated with, or used along side virtually any J2EE or J2SE application- from the smallest stand-alone application to the largest e-commercesystem. Quartz can be used to create simple or complex schedules forexecuting tens, hundreds, or even tens-of-thousands of jobs

Quartz is freely usable, licensed under the Apache 2.0 license.
Main elements-

1.Job 2.Trigger 3.Scheduler

Scheduler

Main part of the Quartz• Responsible for managing the runtime environment for all Quartz applications
• Based on a multithreaded architecture
– on startup a set of worker threads are initialized – a worker thread is used by the scheduler to schedule Jobs
• Many Jobs can be run concurrently

Scheduler keeps track of all Jobs and the times they are executed
Job execution needs to be very exact ant prompt


Job

A Job is a Java class that performs a task
example
– Use JavaMail to send emails
– Query and update persistent data
– Use FTP to move file

Only requirements:

– implement org.quartz.Job interface
– throw a JobExecutionExcpetion in the case of error

example code is here

public class HelloJob implements Job
{
public void execute(JobExecutionContext arg0) throws JobExecutionException{
System.out.println("Hello World Quartz Scheduler: " + new Date());
}
}


Jobs And Trigger

Quartz separates the Job from the schedule
Trigger are used to tell the Scheduler when a Job should be fired
Several triggers types are available, but the most important are:
– SimpleTrigger
– CronTrigger


Trigger

Simple Trigger
simple firing schedule: at given time, repeat nr of times, waiting between firings

CronTrigger
– calendar-like schedule: 0 15 10 ? MON-FRI

How to schedule a job

Create an Scheduler instance from the Factory
– Create a Job, JobDetail
– Create and setup the trigger
– Schedule Job and Trigger with the Scheduler
– Start the Scheduler


Crontrigger

cron is a UNIX tool that has been around for a long time, so its scheduling capabilities are powerful and proven. The CronTrigger class is based on the scheduling capabilities of cron.


CronTrigger uses "cron expressions", which are able to create firing schedules such as: "At 8:00am every Monday through Friday" or "At 1:30am every last Friday of the month".


A cron expression is a string comprised of 6 or 7 fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows:

fieldname(range)(allowed values)
1.seconds(0-59)(, - * / )‏
2.Minutes(0-59)(, - * / )‏
3.hours(0-23)(, - * / )‏
4.Day Of month( 1-31 )(, - * ? / L W)‏
5.month(1-12 or JAN-DEC )(, - * / )‏
6.day of week(1-7 or SUN-SAT )(, - * ? / L # )‏
7.year(empty, 1970-2099)(, - * / )‏

allowed value description

* ("all values") - used to select all values within a field. For example, "*" in the minute field means "every minute".

? ("no specific value") -useful when you need to specify something in one of the two fields in which the character is allowed, but not the other. For example, if I want my trigger to fire on a particular day of the month (say, the 10th), but don't care what day of the week that happens to be, I would put "10" in the day-of-month field, and "?" in the day-of-week field.

- used to specify ranges. For example, "10-12" in the hour field means "the hours 10, 11 and 12"., used to specify additional values. For example, "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday"./ - used to specify increments. For example, "0/15" in the seconds field means "the seconds 0, 15, 30, and 45".

L ("last") - has different meaning in each of the two fields in which it is allowed. the value "L" in the day-of-month field means "the last day of the month" if used in the day-of-week field by itself, it simply means "7" or "SAT". But if used in the day-of-week field after another value, it means "the last xxx day of the month" - for example "6L" means "the last friday of the month".

W ("weekday")‏

The 'L' and 'W' characters can also be combined in the day-of-month field to yield 'LW', which translates to "last weekday of the month".


# - used to specify "the nth" XXX day of the month
For example, the value of "6#3" in the day-of-week field means "the third Friday of the month" (day 6 = Friday and "#3" = the 3rd one in the month)‏

Cron expression example

1. Fire at 12pm (noon) every day
0 0 12 * * ?
2. Fire at 10:15am every day
0 15 10 ? * *
3. Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day
0 0/5 14,18 * * ?

4. Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day
0 10,44 14 ? 3 WED
5.Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday
0 15 10 ? * MON-FRI
FOR IMPEMENTING QUARTZ HAVE TO LOAD TO JAR FILES. name as follow.

1. quartz-1.6.4.jar()
2 .commons-collections-3.2.jar
u can load these jar using (http://www.opensymphony.com/quartz/|)

Sample Program is given below.


public class DailyReportGenerator {


public void run() throws Exception {

SchedulerFactory sf = new StdSchedulerFactory();
Scheduler sched = sf.getScheduler();

// jobs can be scheduled before sched.start() has been called

// job 1 will run every 20 seconds
JobDetail job = new JobDetail("job1", "group1", MailSender.class);
// All three Triggers will be scheduled to fire 5 minutes from now.
// Calendar cal = Calendar.getInstance();
// cal.add(Calendar.MINUTE, 5);

// Trigger trigger = new SimpleTrigger("T1", "MyGroup", cal.getTime());
// Trigger trig2 = new SimpleTrigger("T2", "MyGroup", cal.getTime());
// Trigger trig3 = new SimpleTrigger("T3", "MyGroup", cal.getTime());
//
// trig2.setJobName(jobDetail.getName());
// trig2.setPriority(10);
// sched.scheduleJob(trig2);
//
// // Trigger2 has its priority set to 1
// trig3.setJobName(jobDetail.getName());
// trig2.setPriority(1);
// sched.scheduleJob(trig3);
CronTrigger trigger = new CronTrigger("trigger1", "group1", "job1", "group1", "0 15 17 * * ?");
sched.addJob(job, true);
Date ft = sched.scheduleJob(trigger);

sched.start();

}
}

there are some lines are commented u can uncommented it and rum simple trigger .this one use cron trigger.which is really awesome .reduce overhead of threading.
MailSender is job implemented class.


public class MailSender implements Job{


public void execute(JobExecutionContext context)
throws JobExecutionException {
// send mail();
System.out.println("manu");

}

}


No comments: