Historique de la page

h2. Généralités

Le support de JMX dans Spring offre des fonctionnalités simples et   transparentes pour intégrer votre application Spring dans une   infrastructure JMX.
Spring JMX vous permet entre autres d'enregistrer automatiquement n'importe quel bean Spring en tant que *MBean* JMX.

La classe principale de Spring JMX est *MBeanExporter*. Cette classe  est  responsable de prendre en charge et d'enregistrer vos beans Spring  dans  un *MBeanServer*.

Pour exposer les propriétés et les méthodes d'un bean en tant   qu'attributs et opérations d'un MBean, il faut simplement configurer   une instance de la classe MBeanExporter dans le fichier de   configuration.

La propriété "beans" de la classe MBeanExporter permet de savoir exactement  quels beans doivent être exporté au MBeanServer.

Spring JMX offre aussi la possibilité de créer un connecteur serveur  pour  permettre l'accès au MBeanServer à distance. Pour cela il utilise  le  connecteur JSR-160.

h2. Exemple: surveillance de la disponibilité d'un service CMIS par une application "cliente"

Une application de gestion de fichier s'appuie sur un serveur CMIS  pour stocker ses fichiers. Si ce serveur CMIS n'est pas disponible (pour  maintenance, par exemple), l'application doit continuer à fonctionner  en "mode dégradé" .

Le service *cmisFileStorageService* doit savoir en temps réel  si le service CMIS est actif ou non. Le bean *jmxTestCmis,** *grâce à sa méthode \*getCmisIsReady()*, donne cette information.

Les attributs et méthodes de ce bean sont exposés comme MBean  grâce à la classe Spring *MBeanExporter.*

h3. *Les beans Spring :*

    

{code}
<bean id="cmisFileStorageService" class="org.esupportail.application.service.fileStorage.CmisFileStorageServiceImpl" lazy-init="true">
        <description>A bean to manage files upload and download to the CMIS server.</description>
         ...
        <property name="jmxTestCmis" ref="jmxTestCmis"/>
    </bean>

    <bean id="jmxTestCmis"
        class="org.esupportail.application.service.fileStorage.JmxTestCmisImpl">
        ...
    </bean>

    <!-  JMX to control CMIS ->
    <bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
        <property name="beans">
            <map>
                <entry key="bean:name=testCmis" value-ref="jmxTestCmis"/>
            </map>
        </property>
    </bean>
{code}
&nbsp;&nbsp; &nbsp;
&nbsp;&nbsp;&nbsp;

h3. La classe métier cliente JMX

Avant toute opération sur les fichiers elle contrôle la disponibilité  du serveur CMIS et affiche un message d'erreur s'il n'est pas actif.

{code}

public class CmisFileStorageServiceImpl  {
     ....

    /**
     * Bean to test if cmis is ready.
     */
    private JmxTestCmis jmxTestCmis;

    public void afterPropertiesSet() throws Exception{
          ....
          Assert.notNull(this.jmxTestCmis,
             "property jmxTestCmis of class " + this.getClass().getName() + " can not be null");
    }
    ...
    /**
     * @param jmxTestCmis the jmxTestCmis to set
     */
    public void setJmxTestCmis(final JmxTestCmis jmxTestCmis){
          this.jmxTestCmis = jmxTestCmis;
    }

    public FileStorage getFile(...) throws IOException {
        FileStorage file = null;
        if (jmxTestCmis.getCmisIsReady()) {
            file= ...;
        }
        else {
             System.err.println("--------le service CMIS est indisponible");
        }

        return file;
    }
}
{code}

h3. e bean JMXpackage 

public interface JmxTestCmis {
        /*\*
         * Enable the use of CMIS.
     \*/
         */
    void enabledCmis();
    
    /*\*
    

    /**
     * Disable the use of CMIS.
     \*/
         */
    void disabledCmis();
    
    /*\*
    
    /**
     * @return the cmisIsReady
     \*/
         */
    Boolean getCmisIsReady();
}

package org.esupportail.application.services.fileStorage;
import java.io.Serializable;
public class JmxTestCmisImpl implements JmxTestCmis, Serializable {
        /*\*
         * True if cmis is ready.
         * Default value = true.
     \*/
         */
    private Boolean cmisIsReady;
        public JmxTestCmisImpl() {
        super();
        cmisIsReady
{         super();         cmisIsReady = true;
         }

    @Override
        @Override
    public void disableCmis() {
        cmisIsReady
{         cmisIsReady = false;
         }

    @Override
        @Override
    public void enableCmis() {
        cmisIsReady
{         cmisIsReady = true;
    }
    
         }


    public Boolean getCmisIsReady() {
        return
{         return cmisIsReady;
         }

}

h3. 

-Dcom.sun.management.jmxremote
\-Dcom.sun.management.jmxremote.port=9656
\-Dcom.sun.management.jmxremote.authenticate=false
\-Dcom.sun.management.jmxremote.ssl=false

h3.