Un singleton bean ("singleton session bean") est une classe Java que le container EJB instancie et rend accessible ses méthodes publiques.
Le singleton bean est accessible en utilisant l'injection automatique ou JNDI.

Le container EJB crée une seule instance du singleton bean pour une application.
Les valeurs des variables d'instance du singleton bean sont conservées entre différents appels du singleton bean.

Pour définir une classe comme étant un singleton bean il faut, typiquement, annoter la classe avec l'annotation @Singleton.

Code source (JBoss) de l'annotation @Singleton:
package javax.ejb; @Target(TYPE) @Retention(RUNTIME) public @interface Singleton { /** * The ejb-name of this bean. */ String name() default ""; /** * A product specific name (in JBoss the global JNDI name) that this session bean should be mapped to. * Application servers are not required to support any particular form or type of mapped name, nor the ability to use mapped names. * The mapped name is product-dependent and often installation-dependent. * No use of a mapped name is portable. */ String mappedName() default ""; String description() default ""; }
L'annotation @Singleton accepte 3 paramètres :

• String name()
  Le nom EJB du singleton bean.
  Ce nom sera utilisé pour référencer le singleton bean (avec DI ou JNDI).
  Par défaut, si aucune valeur n'est spécifiée pour ce paramètre, il sera initialisé par le nom de la classe du singleton bean (sans le nom du package).
  Typiquement, on s'en sert pour donner un nom plus explicite au singleton bean ou pour distinguer le singleton bean d'un autre singleton bean qui a le même nom de la classe.
  
  
• String mappedName()
  Ce paramètre permet de mapper le singleton bean à un nom global définit dans le container EJB (assez souvent un nom JNDI).
  
  
• String description()
  Nom descriptif du singleton bean.
  
  

Exemple :
package com.mtitek.session.beans.singleton; import javax.ejb.Singleton; @Singleton public class MyFirstSingletonBean { private Integer requestNumber = 0; public Integer getRequestNumber() { requestNumber++; return requestNumber; } public Integer initRequestNumber() { requestNumber = 0; return requestNumber; } }

@Local // (javax.ejb.Local) @Remote // (javax.ejb.Remote) @LocalBean // (javax.ejb.LocalBean)

Annotations qui gèrent le cycle de vie du singleton bean :
@PostConstruct // (javax.annotation.PostConstruct) @PreDestroy // (javax.annotation.PreDestroy)

@Startup // (javax.ejb.Startup)
Cette annotation indique au container EJB d'instancier le singleton bean durant le démarrage de l'application.

Code source (JBoss) de l'annotation @Startup:
package javax.ejb; /** * Mark a Singleton for eager loading during application initialization. */ @Target(TYPE) @Retention(RUNTIME) public @interface Startup { }
Exemple :
package com.mtitek.session.beans.singleton; import javax.ejb.Singleton; import javax.ejb.Startup; @Singleton @Startup public class MyStartupSingletonBean { }

@DependsOn // (javax.ejb.DependsOn)
Avant d'instancier le singleton bean et appeler ses méthodes annotées par @PostConstruct, le container EJB va s'assurer que tous les autres singletons beans spécifiés par cette annotation sont :
- instanciés (exécution du code des blocs d'initialisations + exécution du code du constructeur par défaut) ;
- et leurs méthodes annotées par @PostConstruct sont exécutées.

Code source (JBoss) de l'annotation @DependsOn:
package javax.ejb; /** * Used to express an initialization dependency between Singleton components. */ @Target(TYPE) @Retention(RUNTIME) public @interface DependsOn { /** * Holds one or more ejb-names of Singleton components whose initialization must occur before this Singleton. */ String[] value(); }
Exemple :
package com.mtitek.session.beans.singleton; import javax.ejb.DependsOn; import javax.ejb.LocalBean; import javax.ejb.Singleton; @Singleton @LocalBean @DependsOn({"MyFirstSingletonBean", "MySecondSingletonBean"}) public class MyThirdSingletonBean { }
Notes : L'ordre spécifié par l'annotation @DependsOn ("MyFirstSingletonBean", "MySecondSingletonBean") ne garantit pas que ces singletons beans vont être initialisés dans cet ordre.