root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Removed coverage of deprecated java.util.Timer support 

Issue: SPR-10050
This commit is contained in:
Juergen Hoeller 2012-12-05 19:19:24 +01:00
parent a92f7dd474
commit d6b9c6a475
1 changed files with 1 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
src/reference/docbook/scheduling.xml
View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<chapter xml:id="scheduling"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
@ -888,110 +888,4 @@ public class ExampleJob extends QuartzJobBean {
Javadoc</link> for more information.</para>
</section>
</section>
<section xml:id="scheduling-jdk-timer">
<title>Using JDK Timer support</title>
<para>The other way to schedule jobs in Spring is to use JDK
<classname>Timer</classname> objects. You can create custom timers or use
the timer that invokes methods. Wiring timers is done using the
<classname>TimerFactoryBean</classname>.</para>
<section xml:id="scheduling-jdk-timer-creating">
<title>Creating custom timers</title>
<para>Using the <classname>TimerTask</classname> you can create customer
timer tasks, similar to Quartz jobs:</para>
<programlisting language="java">public class CheckEmailAddresses extends TimerTask {
private List emailAddresses;
public void setEmailAddresses(List emailAddresses) {
this.emailAddresses = emailAddresses;
}
public void run() {
<lineannotation>// iterate over all email addresses and archive them</lineannotation>
}
}</programlisting>
<para>Wiring it up is simple:</para>
<programlisting language="xml">&lt;bean id="checkEmail" class="examples.CheckEmailAddress"&gt;
&lt;property name="emailAddresses"&gt;
&lt;list&gt;
&lt;value&gt;test@springframework.org&lt;/value&gt;
&lt;value&gt;foo@bar.com&lt;/value&gt;
&lt;value&gt;john@doe.net&lt;/value&gt;
&lt;/list&gt;
&lt;/property&gt;
&lt;/bean&gt;
&lt;bean id="scheduledTask" class="org.springframework.scheduling.timer.ScheduledTimerTask"&gt;
<lineannotation>&lt;!-- wait 10 seconds before starting repeated execution --&gt;</lineannotation>
&lt;property name="delay" value="10000" /&gt;
<lineannotation>&lt;!-- run every 50 seconds --&gt;</lineannotation>
&lt;property name="period" value="50000" /&gt;
&lt;property name="timerTask" ref="checkEmail" /&gt;
&lt;/bean&gt;</programlisting>
<para><emphasis> Note that letting the task only run once can be done by
changing the <literal>period</literal> property to 0 (or a negative
value). </emphasis></para>
</section>
<section xml:id="scheduling-jdk-timer-method-invoking-task">
<title>Using the
<classname>MethodInvokingTimerTaskFactoryBean</classname></title>
<para>Similar to the Quartz support, the <classname>Timer</classname>
support also features a component that allows you to periodically invoke
a method:</para>
<programlisting language="xml">&lt;bean id="doIt" class="org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean"&gt;
&lt;property name="targetObject" ref="exampleBusinessObject" /&gt;
&lt;property name="targetMethod" value="doIt" /&gt;
&lt;/bean&gt;</programlisting>
<para>The above example will result in the <literal>doIt</literal>
method being called on the <literal>exampleBusinessObject</literal> (see
below):</para>
<programlisting language="java">public class BusinessObject {
<lineannotation>// properties and collaborators</lineannotation>
public void doIt() {
<lineannotation>// do the actual work</lineannotation>
}
}</programlisting>
<para>Changing the <literal>timerTask</literal> reference of the
<classname>ScheduledTimerTask</classname> example to the bean
<literal>doIt</literal> will result in the <literal>doIt</literal>
method being executed on a fixed schedule.</para>
</section>
<section xml:id="scheduling-jdk-timer-factory-bean">
<title>Wrapping up: setting up the tasks using the
<classname>TimerFactoryBean</classname></title>
<para>The <classname>TimerFactoryBean</classname> is similar to the
Quartz <classname>SchedulerFactoryBean</classname> in that it serves the
same purpose: setting up the actual scheduling. The
<classname>TimerFactoryBean</classname> sets up an actual
<classname>Timer</classname> and schedules the tasks it has references
to. You can specify whether or not daemon threads should be used.</para>
<programlisting language="xml">&lt;bean id="timerFactory" class="org.springframework.scheduling.timer.TimerFactoryBean"&gt;
&lt;property name="scheduledTimerTasks"&gt;
&lt;list&gt;
<lineannotation>&lt;!-- see the example above --&gt;</lineannotation>
&lt;ref bean="scheduledTask" /&gt;
&lt;/list&gt;
&lt;/property&gt;
&lt;/bean&gt;</programlisting>
</section>
</section>
</chapter>