{"id":120,"date":"2011-06-06T13:19:37","date_gmt":"2011-06-06T20:19:37","guid":{"rendered":"http:\/\/sloanseaman.com\/wordpress\/?p=120"},"modified":"2012-03-03T13:23:50","modified_gmt":"2012-03-03T20:23:50","slug":"spring-and-quartz-and-persistence","status":"publish","type":"post","link":"http:\/\/sloanseaman.com\/wordpress\/2011\/06\/06\/spring-and-quartz-and-persistence\/","title":{"rendered":"Spring, Quartz, and Persistence"},"content":{"rendered":"

Spring is great, Spring is fun, Spring is best when it’s one on one (props to George Michael). <\/p>\n

No, really, Spring is a great architecture. Its easily configured, highly flexible, and comes with a ton of already coded utils for doing anything from REST based integration calls to quickly deployed Servlets.<\/p>\n

One of the packages that you may eventually end up using it the Spring Scheduler<\/a>. The Spring Scheduler is a Spring wrapper to the very nice scheduling library, Quartz<\/a>. The Spring Scheduler is simple and easy until you have to worry about more than one server. As soon as you get into a clustered environment (especially one that you back the scheduling with a database) it starts to swagger like a frat boy during homecoming. Unless your careful it just may puke on you.<\/p>\n

So you don’t waste 3 (yes 3) days on getting it setup and working I thought I’d go over what it takes to get Quartz to run in a Spring clustered environment with a db backend and actual usable Spring beans (autowiring, etc).<\/p>\n

The first thing you will want to do it get the Quartz libraries. Careful now because the latest Quartz libs (2.x) don’t work with Spring. You have to use something earlier (at the time of this writing it’s at 1.8.6).
\nHere is the Maven dependencies for it:<\/p>\n

\r\n\t<dependency>\r\n\t\t<groupId>org.quartz-scheduler<\/groupId>\r\n\t\t<artifactId>quartz<\/artifactId>\r\n\t\t<version>1.8.5<\/version>\r\n\t\t<exclusions>\r\n\t\t\t<exclusion>\r\n\t\t\t\t<groupId>com.mchange.c3p0<\/groupId>\r\n\t\t\t\t<artifactId>com.springsource.com.mchange.v2.c3p0<\/artifactId>\r\n\t\t\t<\/exclusion>\r\n\t\t<\/exclusions>\r\n\t<\/dependency>\r\n\r\n        <dependency>\r\n            <groupId>org.quartz-scheduler<\/groupId>\r\n            <artifactId>quartz-oracle<\/artifactId>\r\n            <version>1.8.5<\/version>\r\n        <\/dependency>\r\n<\/pre>\n
Please note that I excluded C3P0 because I already use it in most of my projects.  If you don’t use C3P0 then your Maven dependencies will be:<\/p>\n
\r\n\t<dependency>\r\n\t\t<groupId>org.quartz-scheduler<\/groupId>\r\n\t\t<artifactId>quartz<\/artifactId>\r\n\t\t<version>1.8.5<\/version>\r\n\t<\/dependency>\r\n\r\n        <dependency>\r\n            <groupId>org.quartz-scheduler<\/groupId>\r\n            <artifactId>quartz-oracle<\/artifactId>\r\n            <version>1.8.5<\/version>\r\n        <\/dependency>\r\n<\/pre>\n
I’m assuming your application already has a dataSource and a transactionManager defined. Something like:<\/p>\n
\r\n\t<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"\r\n\t\tdestroy-method="close">\r\n\t\t<property name="driverClass" value="${driver}"><\/property>\r\n\t\t<property name="jdbcUrl" value="${url}" \/>\r\n\t\t<property name="user" value="${username}" \/>\r\n\t\t<property name="password" value="${password}" \/>\r\n\t\t<property name="initialPoolSize" value="2" \/>\r\n\t\t<property name="minPoolSize" value="2" \/>\r\n\t\t<property name="maxPoolSize" value="5" \/>\r\n\t\t<property name="checkoutTimeout" value="100" \/>\r\n\t\t<property name="maxStatements" value="500" \/>\r\n\t\t<property name="testConnectionOnCheckin" value="false" \/>\r\n\t\t<property name="maxIdleTime" value="180" \/>\r\n\t\t<property name="idleConnectionTestPeriod" value="1000" \/>\r\n\t<\/bean>\r\n\r\n\t<bean id="entityManagerFactory"\r\n\t\tclass="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">\r\n\t\t<property name="persistenceProvider" ref="hibernatePersistence" \/>\r\n\t\t<property name="persistenceUnitName" value="model" \/>\r\n\t\t<property name="dataSource" ref="dataSource" \/>\r\n\t\t<property name="jpaVendorAdapter">\r\n\t\t\t<bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">\r\n\t\t\t\t<property name="showSql" value="true" \/>\r\n\t\t\t\t<property name="databasePlatform" value="org.hibernate.dialect.Oracle10gDialect" \/>\r\n\t\t\t<\/bean>\r\n\t\t<\/property>\r\n\t<\/bean>\r\n\r\n\t<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">\r\n\t\t<property name="entityManagerFactory" ref="entityManagerFactory" \/>\r\n\t\t<property name="dataSource" ref="dataSource" \/>\r\n\t<\/bean>\r\n<\/pre>\n
You will need an dataSource<\/code> and transactionManager<\/code> for Quartz to use.   Quartz, in order to make sure that multiple servers are not firing the same event, uses the database to keep track of what has executed and what needs to be executed.  This allows multiple servers that have the application on it to not fire the same event at the same time.  Only one server will fire the job (the server that will do the job is random).<\/p>\n
Next we need to set up Quartz to run under Spring.  Now, I mentioned Spring Scheduler above.  It has it’s one tags, <task>, that work great in single server environments.  Anything other than that and you will be using regular Spring bean definitions.  There’s quite a bit to the configuration so I’ll go over each piece and then present the whole configuration as one file.<\/p>\n
First lets setup the scheduler that will run the jobs for us.  This uses the Spring framework SchedulerFactoryBean <\/code>to create the scheduler that wraps Quartz and runs our jobs for us.<\/p>\n
\r\n<bean id="scheduler"\r\n\tclass="org.springframework.scheduling.quartz.SchedulerFactoryBean" lazy-init="false">\r\n\r\n<\/pre>\n
Next we need to setup some basic configuration parameters to get the system working:<\/p>\n
\r\n<property name="autoStartup" value="true"\/> \r\n<property name="applicationContextSchedulerContextKey" value="applicationContext"\/>\r\n<property name="waitForJobsToCompleteOnShutdown" value="true"\/>\r\n<property name="overwriteExistingJobs" value="true"\/>\r\n<property name="dataSource">\r\n\t<ref bean="dataSource"\/>\r\n<\/property>\r\n<property name="transactionManager">\r\n\t<ref bean="transactionManager"\/>\r\n<\/property>\r\n<\/pre>\n