{"id":2422,"date":"2011-09-22T19:14:17","date_gmt":"2011-09-22T13:44:17","guid":{"rendered":"http:\/\/JitendraZaa.com\/blog\/?p=2422"},"modified":"2011-09-22T19:14:17","modified_gmt":"2011-09-22T13:44:17","slug":"quartz-framework-tutorial-with-example-schedule-job-in-java","status":"publish","type":"post","link":"https:\/\/www.jitendrazaa.com\/blog\/java\/quartz-framework-tutorial-with-example-schedule-job-in-java\/","title":{"rendered":"Quartz framework tutorial with example – Schedule job in Java"},"content":{"rendered":"

What is Quartz?<\/strong><\/p>\n

Quartz is a job scheduling system that can be integrated with, or used along side virtually any other software system. The term “job scheduler<\/strong>” seems to conjure different ideas for different people. As you read this tutorial, you should be able to get a firm idea of what we mean when we use this term, but in short, a job scheduler is a system that is responsible for executing (or notifying) other software components when a pre-determined (scheduled) time arrives.
\nQuartz is quite flexible, and contains multiple usage paradigms that can be used separately or together, in order to achieve your desired behavior, and enable you to write your code in the manner that seems most ‘natural’ to your project.
\nQuartz is very light-weight, and requires very little setup\/configuration – it can actually be used ‘out-of-the-box’ if your needs are relatively basic.
\nQuartz is fault-tolerant, and can persist (‘remember’) your scheduled jobs between system restarts.
\nAlthough Quartz is extremely useful for simply running certain system processes on given schedules, the full potential of Quartz can be realized when you learn how to use it to drive the flow of your application’s business processes.<\/p>\n

Why not just use java.util.Timer<\/a>?<\/strong>
\nSince JDK 1.3, Java has “built-in” timer capabilities, through the java.util.Timer and java.util.TimerTask classes – why would someone use Quartz rather than these standard features?
\nThere are many reasons! Here are a few:<\/p>\n

    \n
  1. Timers have no persistence mechanism.<\/li>\n
  2. Timers have inflexible scheduling (only able to set start-time & repeat interval, nothing based on dates, time of day, etc.)<\/li>\n
  3. Timers don’t utilize a thread-pool (one thread per timer)<\/li>\n
  4. Timers have no real management schemes – you’d have to write your own mechanism for being able to remember, organize and retrieve your tasks by name, etc.<\/li>\n<\/ol>\n

    Download the jar files for Quartz from here<\/a>.<\/p>\n

    jar files neede are:<\/p>\n

    quartz-2.0.2.jar
    \nslfj-log4j12-1.6.1.jar
    \nsl4j-api-1.6.1.jar
    \nlog4j-1.2.14.jar<\/p><\/blockquote>\n

    Example with Source code:<\/p>\n

    DisplayCurrentTime.java<\/strong><\/span><\/p>\n

    \npackage in.shivasoft.quartz;\n\nimport java.text.SimpleDateFormat;\nimport java.util.Calendar;\nimport java.util.Date;\nimport java.util.GregorianCalendar;\n\nimport org.quartz.Job;\nimport org.quartz.JobExecutionContext;\nimport org.quartz.JobExecutionException;\n\npublic class DisplayCurrentTime implements Job {\n\tCalendar c;\n\tDate d;\n\tSimpleDateFormat sdf;\n\n\tpublic DisplayCurrentTime()\n\t{}\n\n\t@Override\n\tpublic void execute(JobExecutionContext context) throws JobExecutionException {\n\t\tc = new GregorianCalendar();\n\t\td = c.getTime();\n\t\tsdf = new SimpleDateFormat("d MMMMM yyyy - HH:mm:ss aaa");\n\t\tString msg = String.format("Job Name - %s, Current Time - %s", context.getJobDetail().getKey(), sdf.format(d));\n\t\tSystem.out.println(msg);\n\t}\n}\n<\/pre>\n
    Create a class which should be executed by the quartz scheduler. The class must implement the interface “Job<\/strong>“. The Job interface has only one method “execute()<\/strong>“. The logic which should be executed must be written in this method. There must be the default constructor in class, as scheduler will create the object of that class at runtime.<\/p>\n
    SimpleQuartzDemo.java<\/strong><\/span><\/p>\n
    \npackage in.shivasoft.quartz;\n\nimport java.text.ParseException;\nimport java.util.Date;\n\nimport org.quartz.CronScheduleBuilder;\nimport org.quartz.CronTrigger;\nimport org.quartz.DateBuilder;\nimport org.quartz.JobBuilder;\nimport org.quartz.JobDetail;\nimport org.quartz.Scheduler;\nimport org.quartz.SchedulerException;\nimport org.quartz.SchedulerFactory;\nimport org.quartz.SimpleScheduleBuilder;\nimport org.quartz.SimpleTrigger;\nimport org.quartz.Trigger;\nimport org.quartz.TriggerBuilder;\nimport org.quartz.impl.StdSchedulerFactory;\n\npublic class SimpleQuartzDemo {\n\n\t\/**\n\t * @param args\n\t *\/\n\tpublic static void main(String[] args) {\n\t\tSimpleQuartzDemo obj = new SimpleQuartzDemo();\n\t\tobj.runDemo();\n\t}\n\n\tpublic void runDemo() {\n\t\ttry {\n\n\t\t\t\/\/ First we must get a reference to a scheduler\n\t        SchedulerFactory sf = new StdSchedulerFactory();\n\t        Scheduler sched = sf.getScheduler();\n\n\t        \/**\n\t         * Job 1 using Trigger\n\t         *\/\n\t\t\tJobDetail job1 = JobBuilder.newJob(DisplayCurrentTime.class)\n\t\t\t\t\t.withIdentity("currentTime-Job-1", "group1")\n\t\t\t\t\t.build();\n\n\t\t\t\/\/This trigger will run every minute in infinite loop\n\t\t\tTrigger trigger1 = TriggerBuilder.newTrigger()\n\t\t\t\t\t.withIdentity("everyMinuteTrigger", "group1")\n\t\t\t\t\t.startAt(new Date(System.currentTimeMillis()))\n\t\t\t\t\t.withSchedule( CronScheduleBuilder.cronSchedule( "0 0\/1 * 1\/1 * ? *"))\n\t\t\t\t\t.build();\n\n\t\t\tDate ft = sched.scheduleJob(job1, trigger1);\n\t\t\tsched.start();\n\n\t\t\tSystem.out.println(job1.getKey() + " has been scheduled to run at: " + ft);\n\n\t\t\t\/**\n\t\t\t * Job 2 using SimpleTrigger\n\t\t\t *\/\n\t\t\tJobDetail job2 = JobBuilder.newJob(DisplayCurrentTime.class)\n\t\t\t.withIdentity("currentTime-Job-2", "group1")\n\t\t\t.build();\n\n\t\t\t\/\/ get a "nice round" time a few seconds in the future....\n\t\t\tDate startTime = DateBuilder.nextGivenSecondDate(null, 10);\n\n\t\t\t\/\/This trigger will run every 10 sec for 4 times\n\t\t\tSimpleTrigger trigger2 = TriggerBuilder.newTrigger()\n            .withIdentity("fourTimesTrigger", "group1")\n            .startAt(startTime)\n            .withSchedule( SimpleScheduleBuilder.simpleSchedule()\n                    .withIntervalInSeconds(10)\n                    .withRepeatCount(4))\n            .build();\n\n\tft = sched.scheduleJob(job2, trigger2);\n\tsched.start();\n\n\tSystem.out.println(job1.getKey() + " has been scheduled to run at: " + ft);\n\n\t\/**\n\t* Job 3 Using CronTrigger\n\t*\/\n\tJobDetail job3 = JobBuilder.newJob(DisplayCurrentTime.class)\n\t\t.withIdentity("currentTime-Job-3", "newGroup")\n\t\t.build();\n\n\t\/\/run every 20 seconds\n\tCronTrigger trigger3 = TriggerBuilder.newTrigger()\n            .withIdentity("twentySec", "group2")\n            .withSchedule( CronScheduleBuilder.cronSchedule( "0\/20 * * * * ?"))\n            .build();\n\n\tft = sched.scheduleJob(job3, trigger3);\n\tsched.start();\n\n\t\t} catch (SchedulerException e) {\n\t\t\te.printStackTrace();\n\t\t}\n\t\tcatch (ParseException e) {\n\t\t\te.printStackTrace();\n\t\t}\n\t}\n}\n\n<\/pre>\n
    As you can see in above program, we have created the object of “StdSchedulerFactory<\/strong>“, which will schedule the job.
    \nThen we have created the job and trigger to be executed by quartz framework.<\/p>\n
    In above example we have created three jobs and triggers.
    \nWhile creating job, we specify that which class (implements interface Job) will be executed by framework. And the “JobName” and “Thread group” in which it will be executed.<\/p>\n
    We have used three types of trigger in above example:<\/p>\n
      \n
    1. Trigger<\/li>\n
    2. SimpleTrigger<\/li>\n
    3. CronTrigger<\/li>\n<\/ol>\n