24. L'appel de méthodes distantes : RMI

Niveau :

Supérieur

RMI (Remote Method Invocation) est une technologie fournie à partir du JDK 1.1 pour permettre de mettre en oeuvre facilement des objets distribués.

Ce chapitre contient plusieurs sections :

• La présentation et l'architecture de RMI
• Les différentes étapes pour créer un objet distant et l'appeler avec RMI
• Le développement coté serveur
• Le développement coté client
• La génération de la classe stub
• La mise en oeuvre des objets RMI

24.1. La présentation et l'architecture de RMI

Le but de RMI est de permettre l'appel, l'exécution et le renvoi du résultat d'une méthode exécutée dans une machine virtuelle différente de celle de l'objet l'appelant. Cette machine virtuelle peut être sur une machine différente pourvu qu'elle soit accessible par le réseau.

La machine sur laquelle s'exécute la méthode distante est appelée serveur.

L'appel coté client d'une telle méthode est un peu plus compliqué que l'appel d'une méthode d'un objet local mais il reste simple. Il consiste à obtenir une référence sur l'objet distant puis à simplement appeler la méthode à partir de cette référence.

La technologie RMI se charge de rendre transparente la localisation de l'objet distant, son appel et le renvoi du résultat.

En fait, elle utilise deux classes particulières, le stub et le skeleton, qui doivent être générées avec l'outil rmic fourni avec le JDK.

Le stub est une classe qui se situe côté client et le skeleton est son homologue coté serveur. Ces deux classes se chargent d'assurer tous les mécanismes d'appel, de communication, d'exécution, de renvoi et de réception du résultat.

24.2. Les différentes étapes pour créer un objet distant et l'appeler avec RMI

Le développement coté serveur se compose de :

• La définition d'une interface qui contient les méthodes qui peuvent être appelées à distance
  
• L'écriture d'une classe qui implémente cette interface
  
• L'écriture d'une classe qui instanciera l'objet et l'enregistrera en lui affectant un nom dans le registre de noms RMI (RMI Registry)
  

Le développement côté client se compose de :

• L'obtention d'une référence sur l'objet distant à partir de son nom
  
• L'appel à la méthode à partir de cette référence
  

Enfin, il faut générer les classes stub et skeleton en exécutant le programme rmic avec le fichier source de l'objet distant.

24.3. Le développement coté serveur

Côté serveur, l'objet distant est décrit par une interface. Une instance de l'objet doit être créée et enregistrée dans le registre RMI.

24.3.1. La définition d'une interface qui contient les méthodes de l'objet distant

L'interface à définir doit hériter de l'interface java.rmi.Remote. Cette interface ne contient aucune méthode mais indique simplement que l'interface peut être appelée à distance.

L'interface doit contenir toutes les méthodes qui seront susceptibles d'être appelées à distance.

La communication entre le client et le serveur lors de l'invocation de la méthode distante peut échouer pour diverses raisons telles qu'un crash du serveur, une rupture de la liaison, etc ...

Ainsi chaque méthode appelée à distance doit déclarer qu'elle est en mesure de lever l'exception java.rmi.RemoteException.

package fr.jmdoudoux.dej.rmi;

import java.rmi.*;

public interface Information extends Remote {

   public String getInformation() throws RemoteException;

}

24.3.2. L'écriture d'une classe qui implémente cette interface

Cette classe correspond à l'objet distant. Elle doit donc implémenter l'interface définie et contenir le code nécessaire.

Cette classe doit obligatoirement hériter de la classe UnicastRemoteObject qui contient les différents traitements élémentaires pour un objet distant dont l'appel par le stub du client est unique. Le stub ne peut obtenir qu'une seule référence sur un objet distant héritant de la classe UnicastRemoteObject. On peut supposer qu'une future version de RMI sera capable de faire du MultiCast, permettant à RMI de choisir parmi plusieurs objets distants identiques la référence à fournir au client.

La hiérarchie de la classe UnicastRemoteObject est :

java.rmi.Server.RemoteObject

java.rmi.Server.RemoteServer

java.rmi.Server.UnicastRemoteObject

Comme indiqué dans l'interface, toutes les méthodes distantes, mais aussi le constructeur de la classe, doivent indiquer qu'elles peuvent lever l'exception RemoteException. Ainsi, même si le constructeur ne contient pas de code il doit être redéfini pour inhiber la génération du constructeur par défaut qui ne lève pas cette exception.

package fr.jmdoudoux.dej.rmi;

import java.rmi.RemoteException;
import java.rmi.server.UnicastRemoteObject;

public class InformationImpl extends UnicastRemoteObject implements Information {

  private static final long serialVersionUID = 2674880711467464646L;

  protected InformationImpl() throws RemoteException {
    super();
  }

  public String getInformation() throws RemoteException {
    System.out.println("Invocation de la méthode getInformation()");
    return "bonjour";
  }
}

24.3.3. L'écriture d'une classe pour instancier l'objet et l'enregistrer dans le registre

Ces opérations peuvent être effectuées dans la méthode main d'une classe dédiée ou dans la méthode main de la classe de l'objet distant. L'intérêt d'une classe dédiée et qu'elle permet de regrouper toutes ces opérations pour un ensemble d'objets distants.

La marche à suivre contient trois étapes :

• la mise en place d'un security manager dédié qui est facultative
• l'instanciation d'un objet de la classe distante
• l'enregistrement de la classe dans le registre de noms RMI

24.3.3.1. La mise en place d'un security manager

Cette opération n'est pas obligatoire mais elle est recommandée en particulier si le serveur doit charger des classes récupérées sur des machines distantes. Sans security manager, il faut obligatoirement mettre à la disposition du serveur toutes les classes dont il aura besoin (Elles doivent être dans le CLASSPATH du serveur). Avec un security manager, le serveur peut charger dynamiquement certaines classes.

Cependant, le chargement dynamique de ces classes peut poser des problèmes de sécurité car le serveur va exécuter du code d'une autre machine. Cet aspect peut conduire à ne pas utiliser de security manager.

public static void main(String[] args) {
  try {
    if (System.getSecurityManager() == null) {
      System.setSecurityManager(new RMISecurityManager());
    }
  } catch (Exception e) {
     e.printStrackTrace();
  }
}

Il est aussi possible d'activer un security manager en utilisant simplement l'option -Djava.security.manager de la JVM.

24.3.3.2. L'instanciation d'un objet de la classe distante

Cette opération est très simple puisqu'elle consiste simplement en la création d'un objet de la classe de l'objet distant

public static void main(String[] args) {
  try {
    if (System.getSecurityManager() == null) {
      System.setSecurityManager(new RMISecurityManager());
    }
    
    InformationImpl informationImpl = new InformationImpl();
  } catch (Exception e) {
     e.printStrackTrace();
  }
}

24.3.3.3. L'enregistrement dans le registre de noms RMI

La dernière opération consiste à enregistrer l'objet créé dans le registre de noms en lui affectant un nom. Ce nom est fourni au registre sous forme d'une URL constituée du préfix rmi://, du nom du serveur (hostname) et du nom associé à l'objet précédé d'un slash.

Le nom du serveur peut être fourni « en dur » sous forme d'une constante chaîne de caractères ou peut être dynamiquement obtenu en utilisant la classe InetAddress pour une utilisation en locale.

C'est ce nom qui sera utilisé dans une URL par le client pour obtenir une référence sur l'objet distant.

L'enregistrement se fait en utilisant la méthode rebind de la classe Naming. Elle attend en paramètre l'URL du nom de l'objet et l'objet lui-même.

public static void main(String[] args) {
  try {
    if (System.getSecurityManager() == null) {
      System.setSecurityManager(new RMISecurityManager());
    }
    
    InformationImpl informationImpl = new InformationImpl();
    String url = "rmi://" + InetAddress.getLocalHost().getHostAddress() + "/TestRMI";
    System.out.println("Enregistrement de l'objet avec l'url : " + url);
    Naming.rebind(url, informationImpl);

    System.out.println("Serveur lancé");
  } catch (RemoteException e) {
    e.printStackTrace();
  } catch (MalformedURLException e) {
    e.printStackTrace();
  } catch (UnknownHostException e) {
    e.printStackTrace();
  }
}

24.3.3.4. Le lancement dynamique du registre de noms RMI

Sur le serveur, le registre de noms RMI doit s'exécuter avant de pouvoir enregistrer un objet ou obtenir une référence.

Ce registre peut être lancé en tant qu'application fournie dans le JDK (rmiregistry) comme indiqué dans un chapitre suivant ou être lancé dynamiquement dans la classe qui enregistre l'objet. Ce lancement ne doit avoir lieu qu'une seule et unique fois. Il peut être intéressant d'utiliser le code ci-dessous si l'on crée une classe dédiée à l'enregistrement des objets distants.

Le code pour exécuter le registre est la méthode createRegistry() de la classe java.rmi.registry.LocateRegistry. Cette méthode attend en paramètre un numéro de port.

package fr.jmdoudoux.dej.rmi;

import java.net.InetAddress;
import java.net.MalformedURLException;
import java.net.UnknownHostException;
import java.rmi.Naming;
import java.rmi.RMISecurityManager;
import java.rmi.RemoteException;
import java.rmi.registry.LocateRegistry;

public class LanceServeur {

  public static void main(String[] args) {
    try {
      LocateRegistry.createRegistry(1099);

      System.out.println("Mise en place du Security Manager ...");
      if (System.getSecurityManager() == null) {
        System.setSecurityManager(new RMISecurityManager());
      }

      InformationImpl informationImpl = new InformationImpl();

      String url = "rmi://" + InetAddress.getLocalHost().getHostAddress() + "/TestRMI";
      System.out.println("Enregistrement de l'objet avec l'url : " + url);
      Naming.rebind(url, informationImpl);

      System.out.println("Serveur lancé");
    } catch (RemoteException e) {
      e.printStackTrace();
    } catch (MalformedURLException e) {
      e.printStackTrace();
    } catch (UnknownHostException e) {
      e.printStackTrace();
    }
  }
}

24.4. Le développement coté client

L'appel d'une méthode distante peut se faire dans une application ou dans une applet.

24.4.1. La mise en place d'un security manager

Comme pour le coté serveur, cette opération est facultative.

Le choix de la mise en place d'un sécurity manager côté client suit des règles identiques à celles appliquées côté serveur. Sans son utilisation, il est nécessaire de mettre dans le CLASSPATH du client toutes les classes nécessaires dont la classe stub.

public static void main(String[] args) {
  if (System.getSecurityManager() == null) {
    System.setSecurityManager(new RMISecurityManager());
  }
}

24.4.2. L'obtention d'une référence sur l'objet distant à partir de son nom

Pour obtenir une référence sur l'objet distant à partir de son nom, il faut utiliser la méthode statique lookup() de la classe Naming.

Cette méthode attend en paramètre une URL indiquant le nom qui référence l'objet distant. Cette URL est composée de plusieurs éléments : le préfix rmi://, le nom du serveur (hostname) et le nom de l'objet tel qu'il a été enregistré dans le registre précédé d'un slash.

Il est préférable de prévoir le nom du serveur sous forme de paramètres de l'application ou de l'applet pour plus de souplesse.

La méthode lookup() va rechercher l'objet dans le registre du serveur et retourner un objet stub. L'objet retourné est de la classe Remote (cette classe est la classe mère de tous les objets distants).

Si le nom fourni dans l'URL n'est pas référencé dans le registre, la méthode lève l'exception NotBoundException.

public static void main(String[] args) {

  if (System.getSecurityManager() == null) {
    System.setSecurityManager(new RMISecurityManager());
  }

  try {
    Remote r = Naming.lookup("rmi://10.0.0.13/TestRMI");
  } catch (Exception e) {
    e.printStrackTrace();
  }
  
}

24.4.3. L'appel de la méthode à partir de la référence sur l'objet distant

L'objet retourné étant de type Remote, il faut réaliser un cast vers l'interface qui définit les méthodes de l'objet distant. Pour plus de sécurité, on vérifie que l'objet retourné est bien une instance de cette interface.

Un fois le cast réalisé, il suffit simplement d'appeler la méthode.

package fr.jmdoudoux.dej.rmi;

import java.net.MalformedURLException;
import java.rmi.Naming;
import java.rmi.NotBoundException;
import java.rmi.RMISecurityManager;
import java.rmi.Remote;
import java.rmi.RemoteException;

public class LanceClient {

  public static void main(String[] args) {
    System.out.println("Lancement du client");
    if (System.getSecurityManager() == null) {
      System.setSecurityManager(new RMISecurityManager());
    }
    try {
      Remote r = Naming.lookup("rmi://10.0.0.13/TestRMI");
      System.out.println(r);
      if (r instanceof Information) {
        String s = ((Information) r).getInformation();
        System.out.println("chaine renvoyee = " + s);
      }
    } catch (MalformedURLException e) {
      e.printStackTrace();
    } catch (RemoteException e) {
      e.printStackTrace();
    } catch (NotBoundException e) {
      e.printStackTrace();
    }
    System.out.println("Fin du client");
  }
}

24.4.4. L'appel d'une méthode distante dans une applet

L'appel d'une méthode distante est le même dans une application et dans une applet.

Seule la mise en place d'un security manager dédié dans les applets est inutile car elles utilisent déjà un sécurity manager (AppletSecurityManager) qui autorise le chargement de classes distantes.

package fr.jmdoudoux.dej.rmi;

import java.applet.*;
import java.awt.*;
import java.rmi.*;

public class AppletTestRMI extends Applet {

  private String s;

  public void init() {

    try { 
      Remote r = Naming.lookup("rmi://10.0.0.13/TestRMI");

      if (r instanceof Information) {
       s = ((Information) r).getInformation();
      }
    } catch (Exception e) {
      e.printStrackTrace();
    }
  }

  public void paint(Graphics g) {
    super.paint(g);
    g.drawString("chaine retournée = "+s,20,20);
  }
}

24.5. La génération de la classe stub

Pour générer la classe stub, il suffit d'utiliser l'outil rmic fourni avec le JDK en lui donnant en paramètre le nom pleinement qualifié de la classe.

Attention la classe doit avoir été compilée : rmic a besoin du fichier .class.

rmic fr.jmdoudoux.dej.rmi.InformationImpl

rmic va générer et compiler la classe stub sous le nom InformationImpl_Stub.class. Cette classe sera utilisée par la partie cliente pour invoquer l'objet distant correspondant.

24.6. La mise en oeuvre des objets RMI

La mise en oeuvre et l'utilisation d'objets distants avec RMI nécessite plusieurs étapes :

1. Démarrer le registre RMI sur le serveur soit en utilisant le programme rmiregistry livré avec le JDK soit en exécutant une classe qui effectue le lancement.
2. Exécuter la classe qui instancie l'objet distant et l'enregistre dans le serveur de noms RMI
3. Lancer l'application ou l'applet pour tester.

24.6.1. Le lancement du registre RMI

La commande rmiregistry est fournie avec le JDK. Il faut la lancer en tâche de fond :

Sous Unix : rmiregistry&

Sous Windows : start rmiregistry

Ce registre permet de faire correspondre un objet à un nom et inversement. C'est lui qui est sollicité lors d'un appel aux méthodes Naming.bind() et Naming.lookup()

24.6.2. L'instanciation et l'enregistrement de l'objet distant

Il faut exécuter la classe qui va instancier l'objet distant et l'enregistrer sous son nom dans le registre précédemment lancé.

Pour ne pas avoir de problème, il faut s'assurer que toutes les classes utiles (la classe de l'objet distant, l'interface qui définit les méthodes) sont présentes dans un répertoire défini dans le classpath.

Si un gestionnaire de sécurité est mis en place, il faut définir un fichier qui va contenir la politique de sécurité qu'il doit mettre en oeuvre.

grant{
permission java.net.SocketPermission "localhost:1099", "connect, resolve";
permission java.net.SocketPermission "*:1024-", "connect, resolve";
permission java.net.SocketPermission "*:1024-", "accept, resolve";
};

Les permissions définies concernent les permissions de connexions par socket au serveur.

Lors du lancement du serveur, l'option java.security.policy permet de préciser le fichier qui sera utilisé par le gestionnaire de sécurité.

C:\Users\Jean Michel\workspace\TestRmiServer>java -cp bin -Djava.security.policy
=ma_policy_serveur fr.jmdoudoux.dej.rmi.LanceServeur
Mise en place du Security Manager ...
Enregistrement de l'objet avec l'url : rmi://10.0.0.13/TestRMI
Serveur lancé

24.6.3. Le lancement de l'application cliente

L'archive de la partie cliente doit contenir le client, l'interface de l'objet distant et le stub qui a été généré par rmic.

C:\temp>jar -tf TestRMIClient.jar
META-INF/MANIFEST.MF
com/jmdoudoux/test/rmi/Information.class
com/jmdoudoux/test/rmi/InformationImpl_Stub.class
com/jmdoudoux/test/rmi/LanceClient.class

Le client qui invoque l'objet distant est lancé de manière classique.

C:\temp>java -jar TestRMIClient.jar
Lancement du client
InformationImpl_Stub[UnicastRef [liveRef: [endpoint:[10.0.0.13:62802](remote),ob
jID:[7b7739e4:135b4a87a5e:-7fff, -3323459310870193038]]]]
chaine renvoyee = bonjour
Fin du client

Si le serveur n'est pas démarré, une exception est levée

C:\temp>java -jar TestRMIClient.jar
Lancement du client
java.rmi.ConnectException: Connection refused to host: 10.0.0.13; nested excepti
on is:
        java.net.ConnectException: Connection timed out: connect
        at sun.rmi.transport.tcp.TCPEndpoint.newSocket(Unknown Source)
        at sun.rmi.transport.tcp.TCPChannel.createConnection(Unknown Source)
        at sun.rmi.transport.tcp.TCPChannel.newConnection(Unknown Source)
        at sun.rmi.server.UnicastRef.newCall(Unknown Source)
        at sun.rmi.registry.RegistryImpl_Stub.lookup(Unknown Source)
        at java.rmi.Naming.lookup(Unknown Source)
        at fr.jmdoudoux.dej.rmi.LanceClient.main(LanceClient.java:17)
Caused by: java.net.ConnectException: Connection timed out: connect
        at java.net.TwoStacksPlainSocketImpl.socketConnect(Native Method)
        at java.net.AbstractPlainSocketImpl.doConnect(Unknown Source)
        at java.net.AbstractPlainSocketImpl.connectToAddress(Unknown Source)
        at java.net.AbstractPlainSocketImpl.connect(Unknown Source)
        at java.net.PlainSocketImpl.connect(Unknown Source)
        at java.net.SocksSocketImpl.connect(Unknown Source)
        at java.net.Socket.connect(Unknown Source)
        at java.net.Socket.connect(Unknown Source)
        at java.net.Socket.<init>(Unknown Source)
        at java.net.Socket.<init>(Unknown Source)
        at sun.rmi.transport.proxy.RMIDirectSocketFactory.createSocket(Unknown S
ource)
        at sun.rmi.transport.proxy.RMIMasterSocketFactory.createSocket(Unknown S
ource)
        ... 7 more
Fin du client

La partie client peut être lancée avec un gestionnaire et une politique de sécurité associée.

C:\temp>java -jar -Djava.security.policy=ma_policy_client TestRMIClient.jar
Lancement du client
InformationImpl_Stub[UnicastRef [liveRef: [endpoint:[10.0.0.13:62802](remote),ob
jID:[7b7739e4:135b4a87a5e:-7fff, -3323459310870193038]]]]
chaine renvoyee = bonjour
Fin du client

Si le gestionnaire est activé sans politique de sécurité associée alors la connexion au serveur est impossible.

C:\temp>java -jar -Djava.security.manager TestRMIClient.jar
Lancement du client
Exception in thread "main" java.security.AccessControlException: access denied (
"java.net.SocketPermission" "10.0.0.13:1099" "connect,resolve")
        at java.security.AccessControlContext.checkPermission(Unknown Source)
        at java.security.AccessController.checkPermission(Unknown Source)
        at java.lang.SecurityManager.checkPermission(Unknown Source)
        at java.lang.SecurityManager.checkConnect(Unknown Source)
        at java.net.Socket.connect(Unknown Source)
        at java.net.Socket.connect(Unknown Source)
        at java.net.Socket.<init>(Unknown Source)
        at java.net.Socket.<init>(Unknown Source)
        at sun.rmi.transport.proxy.RMIDirectSocketFactory.createSocket(Unknown S
ource)
        at sun.rmi.transport.proxy.RMIMasterSocketFactory.createSocket(Unknown S
ource)
        at sun.rmi.transport.tcp.TCPEndpoint.newSocket(Unknown Source)
        at sun.rmi.transport.tcp.TCPChannel.createConnection(Unknown Source)
        at sun.rmi.transport.tcp.TCPChannel.newConnection(Unknown Source)
        at sun.rmi.server.UnicastRef.newCall(Unknown Source)
        at sun.rmi.registry.RegistryImpl_Stub.lookup(Unknown Source)
        at java.rmi.Naming.lookup(Unknown Source)
        at fr.jmdoudoux.dej.rmi.LanceClient.main(LanceClient.java:17)