cestpasdur.com Tutoriaux et ressources du web

JMX, supervision et administration des applications J2EE

Java Management eXtension ou JMX est une API java permettant de surveiller une application existante. Cette technologie permet également d’intéragir sur l’application en cours d’exécution. Cette API a été intégré dans le J2SE à partir de la version 1.5. Dans l’exemple ci-dessous, nous utiliserons cette technologie afin de suivre le nombre d’objets mis en cache avec EHCache et JMX.

Acquisition de données (instrumentation) avec JMX

Le MBean (managed bean) est l’élément de base de JMX. Associé à un agent de supervision, il servira d’interface de communication avec les éléments gérés par JMX. On peut le voir comme une sonde effectuant une ou plusieurs mesures.

MBeanServer : l’agent de Supervision

Appelés agents ou serveurs JMX, ceux-ci sont chargés de recenser les MBeans. Chaque ajout ou supression d’un MBean donne lieu à une notification.

Spring et JMX

Comme à son habitude, Spring facilite l’intégration de JMX dans l’architecture d’une application. Il met à disposition des méthodes simples pour enregistrer de nouveaux MBean. Cette intégration se fait tout en conservant un faible couplage de l’application avec cette technologie.

Suivi des objets en cache avec EHCACHE et JMX dans une application SPRING

Afin de faciliter la mise en place de cette technologie, nous nous baserons sur une application fonctionnant sur le serveur d’application JBOSS.

Nous allons mettre un place un MBean qui effectuera un certain nombre de mesures afin de suivre l’évolution de la propriété MemoryStoreSize de notre cache.

Configuration Spring du MBean :

<bean id="jmxCacheBean" class="com.programmetvcesoir.jmx.JmxCache">
   <property name="cacheManager" ref="cacheManagerID"></property>
</bean>

La classe correspondante :

mport net.sf.ehcache.Cache ;
import net.sf.ehcache.CacheManager;
/**
* MBean permettant de surveiller et d‘adminitrer via jmx le cache géré par EHCACHE
* @author dgouyette
*
*/
public class JmxCache

/**
* Manager de cache EHCACHE
*/
private CacheManager cacheManager ;

public JmxCache()
{
}

public long getMemoryStoreSize()
{
  Cache cache=cacheManager.getCache("1000_overflow_disk") ;
  return cache.getMemoryStoreSize() ;
}
public void removeAll()
{
  Cache cache=cacheManager.getCache("1000_overflow_disk") ;
  cache.removeAll() ;
}
public void setCacheManager(CacheManager cacheManager)
{
  this.cacheManager = cacheManager ;
}

Comme vous pouvez le voir, la valeur de la propriété cacheManager est injectée via la configuration Spring. Nous avons donc accès dans notre MBean à l’ensemble des propriétés du cacheManager, en l’occurence celle qui nous intéresse : memoryStoreSize (nombre d’objet en cache à un instant T). Maintenant, notre MBean a besoin de communiquer avec un MBeanServer. La configuration suivante permet de localiser un server existant et de s’y connecter (dans notre cas, JBoss)

<bean id="mbeanServer" class="org.springframework.jmx.support.MBeanServerFactoryBean">
  <property name="locateExistingServerIfPossible" value="true"/>
</bean>

C’est aussi simple que çà ! Notre MBean va devoir notifier sa présence au MBeanServer en utilisant un MBeanExporter :

<bean id="exporter"class="org.springframework.jmx.export.MBeanExporter">
   <property name="beans">
     <map>
       <entry key="bean:name=jmxCacheBean" value-ref="jmxCacheBean"></entry>
     </map>
    </property>
    <property name="server" ref="mbeanServer"/>
</bean>

Au démarrage du serveur, nous pouvons voir la présence du MBean dans les logs :

DEBUG org.springframework.jmx.support.JmxUtils - Found MBeanServer : org.jboss.mx.server.MBeanServerImpl@1c9a690[defaultDomain='jboss' ]
INFO org.springframework.jmx.export.MBeanExporter - Registering beans for JMX exposure on startup
DEBUG org.springframework.jmx.export.MBeanExporter - Located simple bean ‘bean:name=jmxCacheBean’ : registering with JMX server as MBean [bean:name=jmxCacheBean]

Essayez maintenant avec la console web JMX de JBoss.

Vous pouvez constater que notre MBean est bien référencé sur le serveur d’applications. Maintenant une console JMX un peu plus pratique serait sympa, vous avez la JConsole disponible via le jdk, dans mon cas c’est ici : c :\Program Files\Java\jdk1.6.0_03\bin\jconsole.exe ou bien vous pouvez télécharger la MC4J management console.

J’espère que cette petite introduction aux extensions JMX vous a permis de comprendre ce qu’est JMX, et, d’en cerner un peu plus l’utilité.

JBOSS SEAM, premiers pas (getting started)

Un tutoriel dans la lignée des step by step de spring afin de créer sa première application fonctionnant avec jboss Seam.

Installation

Prérequis : avoir un jdk 5 ou 6 installé sur la machine.

Téléchargez JBOSS Seam (version 2.0.2, au jour d’aujourd’hui, la version 2.1 (en développement) me retourne une exception ant à la création d’un nouveau projet) Téléchargez JBOSS AS 4.2.2.GA Téléchargez ANT 1.7.0

Extraire JBOSS SEAM dans le répertoire C :\java\jboss-seam-2.0.2.GA\ Extraire JBOSS AS dans le répertoire C :\java\jboss-4.2.2.GA\ Extraire ANT 1.7 dans le répertoire c :\java\ant-1.7.0\

Ajouter ces répertoires dans le path :

c :\java\ant-1.7.0\bin\
C :\java\jboss-seam-2.0.2.GA\
Cliquez sur Ok

fin de valider que cette modification soit prise en compte tapez la commande

seam help

Vous devriez voir défiler l’ensemble des commandes disponibles, dans le cas contraire vérifiez l’emplacement du répertoire jboss seam ainsi que son paramétrage dans le path windows

Modifier le fichier C :\java\jboss-seam-2.0.2.GA\build.properties présent dans le répertoire afin de le faire pointer sur l’emplacement du serveur d’application jboss, mettez bien les slash dans ce sens, sinon cela ne fonctionnera pas.

boss.home=C:/java/jboss-4.2.2.GA/

Faire fonctionner les exemples

Avant d’écrire le moindre bout de code, il peut être intéressant de tester les exemples fournis (26) avec le framework. Démarrer le serveur jboss avec la commande :

C:\java\jboss-4.2.2.GA\bin\>run.bat
Ensuite il faut lancer la tache ant correspondante, pour le blog par exemple :

C:\java\jboss-seam-2.0.2.GA\examples\blog>ant deploy
Pour info, le mot de passe pour se logger au blog est tokio normalement vous devriez voir le blog à l’adresse suivante : http://localhost:8080/seam-blog/

Dans l’ensemble les démos fonctionnaient bien. Les fonctionnalités présentes dans ces applications seront certainement d’une grande aide à l’apprentissage du framework.

Bon point pour Redhat de fournir toutes ces démos

JBOSS SEAM, création du premier projet HelloWorld

Après avoir effectué la configuration de l’environnement permettant de faire fonctionner le framework JBoss seam dans le l’article Jboss seam premier pas getting started, nous allons maintenant pouvoir créer notre premier projet.

Configuration de l’environnement avec seam setup

C:\>seam setup
Unable to locate tools.jar. Expected to find it in C:\Program Files\Java\jre1.6.0_04\lib\tools.jar
Buildfile: C:\java\jboss-seam-2.0.1.GA\seam-gen\build.xml

init:

setup:
[echo] Welcome to seam-gen 
[input] Enter your Java project workspace (the directory that contains your Seam projects) [C:/Projects] [C:/Projects]
C:\java\workspace
[input] Enter your JBoss home directory [C:/Program Files/jboss-4.2.2.GA] [C:/Program Files/jboss-4.2.2.GA]
C:\java\jboss-4.2.2.GA
[input] Enter the project name [myproject] [myproject]
HelloWorld
[echo] Accepted project name as: HelloWorld
[input] Do you want to use ICEFaces instead of RichFaces [n] (y, [n], )
n
[input] skipping input as property icefaces.home.new has already been set.
[input] Select a RichFaces skin [blueSky] ([blueSky], classic, ruby, wine, deepMarine, emeraldTown, sakura, DEFAULT)
ruby
[input] Is this project deployed as an EAR (with EJB components) or a WAR (with no EJB support) [ear] ([ear], war, )
war (ca fait riche un ear pour faire un hello world)
[input] Enter the Java package name for your session beans [com.mydomain.HelloWorld] [com.mydomain.HelloWorld]
[input] Enter the Java package name for your entity beans [com.mydomain.HelloWorld] [com.mydomain.HelloWorld]
[input] Enter the Java package name for your test cases [com.mydomain.HelloWorld.test][com.mydomain.HelloWorld.test]
[input] What kind of database are you using? [hsql] ([hsql], mysql, oracle, postgres, mssql, db2, sybase, enterprisedb, h2)

[input] Enter the Hibernate dialect for your database [org.hibernate.dialect.HSQLDialect] [org.hibernate.dialect.HSQLDialect]

[input] Enter the filesystem path to the JDBC driver jar [lib/hsqldb.jar] [lib/hsqldb.jar]
C:\java\jboss-4.2.2.GA\server\all\lib\hsqldb.jar
[input] Enter JDBC driver class for your database [org.hsqldb.jdbcDriver] [org.hsqldb.jdbcDriver]

[input] Enter the JDBC URL for your database [jdbc:hsqldb:.] [jdbc:hsqldb:.]
jdbc:hsqldb:mem:helloWorldDb
[input] Enter database username [sa] [sa]

[input] Enter database password [] []

[input] Enter the database schema name (it is OK to leave this blank) [] []

[input] Enter the database catalog name (it is OK to leave this blank) [] []

[input] Are you working with tables that already exist in the database? [n] (y, [n], )

[input] Do you want to drop and recreate the database tables and data in import.sql each time you deploy? [n] (y, [n], )
y
[propertyfile] Creating new property file: C:\java\jboss-seam-2.0.1.GA\seam-gen\build.properties
[echo] Installing JDBC driver jar to JBoss server
[echo] Type ’seam create-project’ to create the new project

BUILD SUCCESSFUL
Total time: 3 minutes 16 seconds

C:\>

Création d’un nouveau projet avec seam new-project

Voilà notre premier projet configuré, maintenant il faut le créer avec la commande :

seam new-project

La structure du projet a été créée dans le workspace indiqué précédement. Les jars seam vont y être copiés, les templates facelets, les métédatas Eclipse, les scripts de build Ant.

Copier le war explosé dans le répertoire adéquat du serveur jboss avec la commande :

seam explode

Importer et démarrer l’application dans JBOSS TOOLS

Afin de pouvoir modifier les fichiers dans l’IDE, il faut :

File > new > Project > sélectionnez Général > Project (ne pas sélectionner projet java) Project name : helloworld

Maintenant afin de voir les traces dans la console eclipse, nous allons ajouter dans la view server, notre serveur jboss : Windows > show view > sélectionnez servers

Dans la vue nouvellement ouverte, clic droit new server et sélectionnez le server JBOSS AS 4.2 Cliquez sur next Home directory : C :\java\jboss-4.2.2.GA Choisissez le serveur default et cliquez sur finish Maintenant démarrez le serveur nouvelle ajouté, si vous regardez bien la console, vous verrez l’application helloworld démarrer. Afficher dans votre navigateur http://localhost:8080/helloworld/ Afin de tester une fonctionnalité intéressant de JBOSS :

Modifiez par exemple de fichier web.xml se trouvant dans ressources > WEB-INF Modifiez la valeur du noeud

<context-param>
  <param-name>org.richfaces.SKIN</param-name>
  <param-value>ruby</param-value>
</context-param>

par

<context-param>
  <param-name>org.richfaces.SKIN</param-name>
  <param-value> pop </param-value>
</context-param>

Lorsque vous allez sauvegarder vos modifications, observez la console

on peut observer que le fichier modifié a directement été copié dans :

[copy] Copying 3 files to Y:\java\jboss-4.2.2.GA\server\default\deploy\helloworld.war

Et que sans redémarrer votre serveur, la modification a été prise en compte. Que de temps gagné (ceux qui ont codé sur des gros projets avec maven, spring et Eclipse me comprendront), raffraichissez votre page et observez le nouveau thème appliqué au projet :

Création de la page helloWorld

Nous allons pour cela créer unenouvelle action avec la commande :

eam new-action
C:\dev\projects>seam new-action
Buildfile: C:\java\jboss-seam-2.0.1.GA\seam-gen\build.xml

init:

init-properties:
[echo] C:/java/jboss-4.2.2.GA

validate-workspace:

validate-project:

action-input:
[input] Enter the Seam component name
sayHelloWorld
[input] Enter the local interface name [SayHelloWorld] [SayHelloWorld]

[input] Enter the bean class name [SayHelloWorldBean] [SayHelloWorldBean]

[input] Enter the action method name [sayHelloWorld] [sayHelloWorld]

[input] Enter the page name [sayHelloWorld] [sayHelloWorld]

setup-filters:

new-action-ear:

new-action-war:
[echo] Creating a new JavaBean component with an action method
[copy] Copying 1 file to C:\java\workspace\HelloWorld\src\action\com\mydomain\HelloWorld
[copy] Copying 1 file to C:\java\workspace\HelloWorld\src\test\com\mydomain\HelloWorld\test
[copy] Copying 1 file to C:\java\workspace\HelloWorld\src\test\com\mydomain\HelloWorld\test
[copy] Copying 1 file to C:\java\workspace\HelloWorld\view
[echo] Type ’seam explode’ and go to http://localhost:8080/HelloWorld/sayHelloWorld.seam

new-action:

BUILD SUCCESSFUL
Total time: 31 seconds

C:\dev\projects>

Création de la page helloWorld

La création d’une action nécessite de redémarrer le serveur, faites le avec la commande :

seam restart

Votre serveur d’application devrait redéployer tout seul l’application helloworld

Afin de voir notre helloworld, il suffit maintenant d’afficher la page http://localhost:8080/HelloWorld/sayHelloWorld.seam

Afin que l’application fasse ce qu’on lui demande, c’est à dire “dire bonjour”, il ne vous reste plus qu’a cliquer sur le bouton sayHelloWorld qui lancera la méthode sayHelloWorld de l’action que nous venons de créer.

...
public void sayHelloWorld()
{
  //implement your business logic here
  log.info(”sayHelloWorld.sayHelloWorld() action called”);
  facesMessages.add(”sayHelloWorld”);
}
...