Posts tagged ‘tutorial’

Spring – Quartz scheduler setup

The Spring Application Framework ships with helper classes to make configuring OpenSymphony’s quartz scheduler a breeze. The scheduler allows (amongst other things) cron style triggers. At the time of writing, the latest version of Quartz is 1.6.3, but I’ll be using 1.6.0 as this is the latest version in the Maven central repos.

First, download the version you wish to use and add as a dependency to your project. In Maven‘s case, add this to the pom.xml:

<dependency>
  <groupId>opensymphony</groupId>
  <artifactId>quartz</artifactId>
  <version>1.6.0</version>
</dependency>

Now, create your task which extends org.springframework.scheduling.quartz.QuartzJobBean and implement public void executeInternal(JobExecutionContext context) throws JobExecutionException. You can inject any necessary beans too (myService in this example).

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

public class myTask extends QuartzJobBean {
  private MyService myService;

  public void setMyService(MyService myService) {
    this.myService = myService;
  }

  public void executeInternal(JobExecutionContext context) throws JobExecutionException {
    Actual Business Logic
  }
}

Create a schedulingContext-timer.xml to keep the scheudling configuration seperate and place in the WEB-INF folder of your Spring webapp. These settings could also go in the applicationContext.xml if you prefer but I like to keep the configuration seperate.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
  <!-- Job details -->
  <bean id="myTask" class="org.springframework.scheduling.quartz.JobDetailBean">
    <property name="jobClass" value="com.mycompany.project.scheduling.MyTask"/>
    <property name="jobDataAsMap">
      <map>
        <entry key="myService" value-ref="myServiceBean"/>
      </map>
    </property>
  </bean>

   <!-- Cron -->
  <bean id="myTaskCronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
    <property name="jobDetail" ref="myTask"/>
    <property name="cronExpression" value="0 0/5 * * * ?"/>
  </bean>

   <!-- Kicker -->
  <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
    <property name="triggers">
      <list>
        <ref bean="myTaskCronTrigger"/>
      </list>
    </property>
  </bean>
</beans>

A couple of notes:

  • “Job details” is where you inject any required beans
  • This example uses a CronTriggerBean as this provides functionality otherwise not present in a simple Timer. In the example, the trigger is set to run every 5 minutes starting on the hour. For a full list of possible cron settings, click here.
  • Available triggers are CronTrigger, SimpleTrigger and UICronTrigger. See here.
  • The “Kicker” is required to actually make use of the triggers you’ve set up
  • If you’ve used a separate context, remember to add its name to the web.xml under contextConfigLocation

And that’s all… your webapp now has full Cron capabilities! Enjoy 🙂

Advertisements

November 25, 2008 at 5:55 pm Leave a comment

Converting Ant to Maven in NetBeans

After a good couple of days spent converting ant projects over to maven, here is what I consider the easiest method. This is using NetBeans 6.5rc1 but probably works in 6.1.

Here are the steps for converting an ant project to a maven project in NetBeans.
This presumes your ~/.m2/settings.xml is already set up (not shown here for security purposes) and you have installed the Netbeans maven2 plugin:

1. Open ant project
2. Create new maven project using the “Maven Quickstart Archetype”
3. Properties -> Sources -> Change to 1.6
4. pom.xml -> Add distribution management

<distributionManagement>
  <repository>
    <id>nexus</id>
    <name>Internal Releases</name>
    <url>YourInternalReleaseURL</url>
  </repository>
</distributionManagement>

5. Files tab -> src/main -> add folder “resources”. This will create an “Other Sources/resources” entry in the project view
6. Delete existing source and test package stubs
7. Copy java sources and test sources across from ant project
8. Move all config xml files (such as applicationContext.xml) over to “Other Sources/resources”
9. If you have any hibernate .hbm.xml files, create a folder structure under “Other Sources/resources” identical to the package structure, and copy the files to there
10. Resolve dependencies. The easiest way to do this is go through red-underlined classes, copy the missing required classname, right-click the libraries node and hit “Find Dependency”
11. If a dependency is purely for a test class, add “<scope>test</scope>” to reduce the resulting jar filesize
12. mvn install or deploy

If the ant project exposes a WebService:
1. Add the following plugin to the pom.xml:

<plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>jaxws-maven-plugin</artifactId>
  <executions>
    <execution>
      <goals>
        <goal>wsimport</goal>
      </goals>
      <configuration>
        <wsdlUrls>
          <wsdlUrl>yourWSDLExposedUrl</wsdlUrl>
        </wsdlUrls>
        <packageName>yourWSClientPackageName</packageName>
        <sourceDestDir>${basedir}/src/main/java</sourceDestDir>
      </configuration>
    </execution>
  </executions>
</plugin>

2. Change the wsdl location and packageName as necessary. Without the sourceDestDir, the generated sources live under target/ and code completion won’t work. Setting the package name to the same package as the ws-client solves this. Compilation works either way.

October 30, 2008 at 7:05 pm 1 comment