Les Timers permettent de planifier l'exécution asynchrones des tâches.
Les Timers peuvent être configurés de façon déclarative (annotations) ou programmable (initiés par le code de l'application).

Les Timers déclaratifs sont créés automatiquement par le container EJB.
Les Timers programmables doivent être créés explicitement par le code de l'application en utilisant des méthodes de l'interface TimerService.

Un Timer peut être planifiée pour s'exécuter à un temps précis ou à des intervalles répétitifs.

La méthode (callback method) qui sera appelée par le Timer doit avoir une des deux signatures suivantes :
void callbackMethodName() void callbackMethodName(javax.ejb.Timer timer)
L'objet Timer donne des informations sur le Timer en plus de fournir la méthode cancel() qui permet d'annuler le Timer.

• Créer un projet Maven:
  $ mvn archetype:generate \ -DarchetypeGroupId=org.codehaus.mojo.archetypes \ -DarchetypeArtifactId=ejb-javaee6 \ -DarchetypeVersion=1.5 \ -DgroupId=mtitek.modulez.timers \ -DartifactId=mtitek-modulez-timers \ -Dpackage=mtitek.modulez.timers \ -Dversion=1.0.0-SNAPSHOT \ -DinteractiveMode=false
  Importez le projet dans votre éditeur du code (Eclipse, NetBeans, …).
  Vous pouvez nettoyer le projet et supprimer le code Java généré par Maven.
  
  Notes :
  Sur Linux, le caractère "\" permet d'écrire une commande sur plusieurs lignes.
  Sur Windows, il faut utiliser le caractère "^".
  
  
• Créer une classe Java pour déclarer des Timers :
  package mtitek.modulez.timers; import javax.ejb.Schedule; import javax.ejb.Schedules; import javax.ejb.Stateless; @Stateless public class TimerDeclarativeFirst { @Schedule(second = "0", minute = "*", hour = "*") public void doScheduleTaskFirst() { System.out.println(TimerDeclarativeFirst.class.toString() + " : doScheduleTaskFirst @Schedule[second = '0']"); } @Schedule(second = "10,20,30", minute = "*", hour = "*") public void doScheduleTaskSecond() { System.out.println(TimerDeclarativeFirst.class.toString() + " : doScheduleTaskSecond @Schedule[second = '10,20,30']"); } @Schedules({ @Schedule(second = "40", minute = "*", hour = "*"), @Schedule(second = "50", minute = "*", hour = "*") }) public void doScheduleTaskThird() { System.out.println(TimerDeclarativeFirst.class.toString() + " : doScheduleTaskThird @Schedule[second = '40'] @Schedule[second = '50']"); } }
  - L'annotation @Schedule permet de designer la méthode (callback method) qui va être appelée automatiquement par le Timer créé par le container EJB.
  - L'annotation @Schedules permet de déclarer un groupe d'annotations @Schedule, chacune va correspondre à un Timer spécifique.
  
  
• Créer, déployer et tester les Timers :
  Pour builder le projet il faut utiliser la commande Maven : "mvn install".
  Le fichier jar créé peut être packagé et déployé dans un EAR.
  Les Timers seront créés automatiquement par le container EJB.
  
  Si vous utilisez WebSphere WAS, vous pouvez vérifier que les Timers ont été bien créés en utilisant la commande : findEJBTimers.bat server1 -all
  EJB timer: 1 Expiration: 07/12/14 7:41 PM Calendar EJB: myjeeapp, mtitek-modulez-timers-1.0.0-SNAPSHOT.jar, TimerDeclarativeFirst Automatic timer with timout method: doScheduleTaskFirst Calendar expression: [start=null, end=null, timezone=null, seconds="0", minutes="*", hours="*", dayOfMonth="*", month="*", dayOfWeek="*", year="*"] EJB timer: 2 Expiration: 07/12/14 7:40 PM Calendar EJB: myjeeapp, mtitek-modulez-timers-1.0.0-SNAPSHOT.jar, TimerDeclarativeFirst Automatic timer with timout method: doScheduleTaskSecond Calendar expression: [start=null, end=null, timezone=null, seconds="10,20,30", minutes="*", hours="*", dayOfMonth="*", month="*", dayOfWeek="*", year="*"] EJB timer: 3 Expiration: 07/12/14 7:40 PM Calendar EJB: myjeeapp, mtitek-modulez-timers-1.0.0-SNAPSHOT.jar, TimerDeclarativeFirst Automatic timer with timout method: doScheduleTaskThird Calendar expression: [start=null, end=null, timezone=null, seconds="40", minutes="*", hours="*", dayOfMonth="*", month="*", dayOfWeek="*", year="*"] EJB timer: 4 Expiration: 07/12/14 7:40 PM Calendar EJB: myjeeapp, mtitek-modulez-timers-1.0.0-SNAPSHOT.jar, TimerDeclarativeFirst Automatic timer with timout method: doScheduleTaskThird Calendar expression: [start=null, end=null, timezone=null, seconds="50", minutes="*", hours="*", dayOfMonth="*", month="*", dayOfWeek="*", year="*"]
  Voici un exemple de log du fichier "SystemOut.log" de WebSphere WAS :
  [07/12/14 19:36:00:014 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerDeclarativeFirst : doScheduleTaskFirst @Schedule[second = '0'] [07/12/14 19:36:10:014 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerDeclarativeFirst : doScheduleTaskSecond @Schedule[second = '10,20,30'] [07/12/14 19:36:20:013 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerDeclarativeFirst : doScheduleTaskSecond @Schedule[second = '10,20,30'] [07/12/14 19:36:30:013 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerDeclarativeFirst : doScheduleTaskSecond @Schedule[second = '10,20,30'] [07/12/14 19:36:40:012 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerDeclarativeFirst : doScheduleTaskThird @Schedule[second = '40'] @Schedule[second = '50'] [07/12/14 19:36:50:012 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerDeclarativeFirst : doScheduleTaskThird @Schedule[second = '40'] @Schedule[second = '50']
  

• Créer une classe Java pour déclarer des Timers :
  package mtitek.modulez.timers; import javax.annotation.Resource; import javax.ejb.Schedule; import javax.ejb.Stateless; import javax.ejb.Timeout; import javax.ejb.TimerService; @Stateless public class TimerProgrammaticFirst { @Resource TimerService timerService; @Schedule(second = "0", minute = "*", hour = "*") public void doScheduleTaskFirst() { System.out.println(TimerProgrammaticFirst.class.toString() + " : doScheduleTaskFirst @Schedule[second = '0']"); timerService.createSingleActionTimer(10000, null); } @Timeout public void doProgrammaticTaskFirst() { System.out.println(TimerProgrammaticFirst.class.toString() + " : doProgrammaticTaskFirst @Timeout"); } }
  - L'annotation @Resource est utilisée pour injecter une instance de l'interface TimerService.
  - La méthode createSingleActionTimer de l'interface TimerService crée un Timer qui va être planifié pour une seule exécution.
  - L'annotation @Timeout permet de designer la méthode (callback method) qui va être appelée automatiquement par le Timer créé par le container EJB.
  - L'annotation @Timeout peut être utilisée une seule fois pour une classe donnée.
  
  Notes :
  - La méthode doScheduleTaskFirst va être appelée par le Timer déclaratif à toute les minutes.
  
  Voici un exemple de log du fichier "SystemOut.log" de WebSphere WAS :
  [07/12/14 19:13:00:013 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerProgrammaticFirst : doScheduleTaskFirst @Schedule[second = '0'] [07/12/14 19:13:10:036 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerProgrammaticFirst : doProgrammaticTaskFirst @Timeout [07/12/14 19:14:00:019 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerProgrammaticFirst : doScheduleTaskFirst @Schedule[second = '0'] [07/12/14 19:14:10:034 EST] 000000a1 SystemOut O class mtitek.modulez.timers.TimerProgrammaticFirst : doProgrammaticTaskFirst @Timeout
  

L'annotation @Schedule offre un ensemble d'attributs qui peuvent être utilisées pour contrôler la planification du Timer.

Code source de l'annotation @Schedule (JBoss) :
package javax.ejb; import static java.lang.annotation.ElementType.METHOD; import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Retention; import java.lang.annotation.Target; /** * Schedule a timer for automatic creation with a timeout schedule based on a cron-like time expression. * The annotated method is used as the timeout callback method. */ @Target(value = METHOD) @Retention(value = RUNTIME) public @interface Schedule { // valeurs possibles : [0,59] String second() default "0"; // valeurs possibles : [0,59] String minute() default "0"; // valeurs possibles : [0,23] String hour() default "0"; // valeurs possibles : // [1-12] // {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", Dec"} String month() default "*"; // valeurs possibles : nnnn (4 chiffres représentant l'année) String year() default "*"; // valeurs possibles : // [0,7] (0 et 7 correspondent au Dimanche) // {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"} String dayOfWeek() default "*"; // valeurs possibles : // [1,31] // [-7, -1] (nombre de jours avant le dernier jour du mois) // "Last" (dernier jour du mois) // {"1st", "2nd", "3rd", "4th", "5th", "Last"} (Zassocié avec un jour de la semaine, il permet d'identifier un jour précis du mois) // {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"} String dayOfMonth() default "*"; String timezone() default ""; boolean persistent() default true; String info() default ""; }
- La valeur "*" représente toutes les valeurs permises pour l'attribut de l'annotation.
- Une liste des valeurs (séparées par une virgule) indique un ensemble des valeurs permises pour l'attribut de l'annotation : "3,5,9".
- Un intervalle des valeurs (séparées par un tiret) indique un ensemble des valeurs (toutes celles incluses dans l'intervalle) permises : "2-6".

L'interface TimerService fournit aux EJBs un accès au service du minuteur fournit par le container EJB.
Le service du minuteur EJB permet aux Entités, stateless, singleton et MDBs de s'enregistrer pour un évènement de rappel par le minuteur :
- à un moment précis,
- après un temps écoulé déterminé,
- ou après un intervalle de temps spécifié.

Méthodes de l'interface TimerService :

• Cette méthode retourne tous les Timers (déclaratifs et programmables) actifs associés au bean :
  Collection<Timer> getTimers()
  
  
• Cette méthode retourne tous les Timers (déclaratifs et programmables) actifs associés aux beans appartenant au module dans lequel le bean appelant est packagé :
  Collection<Timer> getAllTimers()
  
  
• Ces deux méthodes créent des Timers qui expirent après une durée déterminée :
  Timer createTimer(long duration, Serializable info) Timer createSingleActionTimer(long duration, TimerConfig timerConfig)
  
  
• Ces deux méthodes créent des Timers qui expirent à un moment donné dans le temps :
  Timer createTimer(Date expiration, Serializable info) Timer createSingleActionTimer(Date expiration, TimerConfig timerConfig)
  
  
• Ces deux méthodes créent des Timers qui expirent après une durée déterminée, et dont les expirations subséquentes se produiront après l'intervalle spécifié :
  Timer createTimer(long initialDuration, long intervalDuration, Serializable info) Timer createIntervalTimer(long initialDuration, long intervalDuration, TimerConfig timerConfig)
  
  
• Ces deux méthodes créent des Timers qui expirent à un moment donné dans le temps, et dont les expirations subséquentes se produiront après l'intervalle spécifié :
  Timer createTimer(Date initialExpiration, long intervalDuration, Serializable info) Timer createIntervalTimer(Date initialExpiration, long intervalDuration, TimerConfig timerConfig)
  
  
• Ces deux méthodes créent des Timers basés sur l'expression de planification ScheduleExpression :
  Timer createCalendarTimer(ScheduleExpression schedule) Timer createCalendarTimer(ScheduleExpression schedule, TimerConfig timerConfig)
  

L'objet TimerConfig peut être utilisé pour définir des paramètres de configuration supplémentaires du Timer.

Méthodes de la classe TimerConfig :

• Constructeurs :
  - Le paramètre info permet d'associer au Timer un objet spécifique.
  - Pour le constructeur sans paramètres, l'objet correspondant info est initialisé par défaut à la valeur null.
  
  - Le paramètre persistent détermine si le Timer persistent.
  - Pour le constructeur sans paramètres, la propriété correspondante persistent est initialisée par défaut à la valeur true.
  TimerConfig() TimerConfig(Serializable info, boolean persistent)
  
  
• get/set l'objet info :
  Serializable getInfo() void setInfo(Serializable info)
  
  
• get/set la propriété persistent :
  boolean isPersistent() void setPersistent(boolean persistent)