このチュートリアルでは、おなじみの「Hello World」プログラムの分散システム版を、Java ^TM の RMI (Remote Method Invocation、リモートメソッド呼び出し) を Internet Inter-ORB Protocol (IIOP) 経由で使用して作成する手順を説明します。 RMI-IIOP は、Java RMI に CORBA (Common Object Request Broker Architecture) 機能を追加することにより、標準規格に基づいた相互運用性と接続性を、ほかの多くのプログラミング言語およびプラットフォームに提供します。 RMI-IIOP を利用すると、Web ベースの分散 Java アプリケーションから、Object Management Group によって定義された業界標準である IIOP を使用しているリモートネットワークサービス上の操作を、透過的に呼び出すことができます。 ランタイムコンポーネントには、IIOP 通信を使った分散コンピューティング用の Java ORB が含まれています。

RMI-IIOP は、IIOP を背後のトランスポートとして使用して、RMI インタフェースに対するプログラムを作成したい Java プログラマ向けです。 RMI-IIOP はさまざまな言語で実装される CORBA オブジェクトとの相互運用性を提供しますが、リモートインタフェースをあらかじめ Java RMI インタフェースとして定義しておく必要があります。 EJB のリモートオブジェクトモデルは RMI ベースなので、Enterprise JavaBeans (EJB) を使うプログラマには特に有用です。

分散アプリケーションを作成するためのその他のオプションは次のとおりです。

• Java ^TM インタフェース定義言語 (IDL)

  Java IDL は、CORBA インタフェース定義言語 (IDL) で定義されたインタフェースに基づいて Java プログラミング言語でプログラムを記述したい CORBA プログラマ向けです。 これは「通常どおりの」CORBA プログラミングで、C++ や COBOL のような他の言語とまったく同じ方法で Java をサポートしています。

• Java ^TM Remote Method Invocation (RMI)

  Java RMI システムを使って、ある Java 仮想マシン (VM) で実行中のオブジェクトから別の Java VM で実行中のオブジェクトのメソッドを呼び出すことができます。 RMI は、Java リモートメソッドプロトコル (JRMP) を介して、Java プログラミング言語で書かれたプログラム間のリモート通信を実現します。

チュートリアル: 「Hello World」アプリケーション

ここで例として紹介する分散型の「Hello World」プログラムでは、クライアントアプリケーションから IIOP 経由でサーバ (そのクライアントアプリケーションのダウンロード元のホスト上で稼動している) に対してリモートメソッド呼び出しを行います。 このクライアントアプリケーションを実行すると、「Hello from MARS!」が表示されます。

このチュートリアルの構成は、次のとおりです。

1. ソースファイルを作成する手順
2. 例のコンパイル手順
3. 例の実行手順

チュートリアルに含まれる各手順は、このイラストで表されます。

ソースファイルの作成

ここで行う作業は 4 つあります。

1. リモートクラスの関数を Java プログラミング言語で作成されたインタフェースとして定義する
2. 実装クラスを作成する
3. サーバクラスを作成する
4. リモートサービスを利用するクライアントプログラムを作成する

• HelloInterface.java - リモートインタフェース
• HelloImpl.java - HelloInterface を実装するリモートオブジェクトの実装
• HelloServer.java - リモートオブジェクト実装のインスタンスを作成し、そのインスタンスをネームサービスの名前にバインドする、RMI サーバ
• HelloClient.java - リモートメソッド sayHello() を呼び出すクライアントアプリケーション

リモートクラスの関数を Java プログラミング言語で作成されたインタフェースとして定義する

• リモートインタフェースは、public として宣言する必要がある。 そうしないと、クライアントがリモートインタフェースと同じパッケージ内にある場合を除いて、リモートインタフェースを実装しているリモートオブジェクトをクライアントがロードしようとした時点でエラーが発生する
• リモートインタフェースは、java.rmi.Remote インタフェースを継承する
• 各メソッドは、アプリケーション固有の例外のほかに、throws 節内で java.rmi.RemoteException (または RemoteException のスーパークラス) を宣言する必要がある
• 引数か戻り値として (直接に、またはローカルオブジェクト内に埋め込まれて) 受け渡しされるリモートオブジェクトのデータ型は、実装クラス (HelloImpl) ではなく、リモートインタフェースの型 (たとえば、HelloInterface) として宣言する必要がある

この例では、すべてのソースファイルを同じディレクトリ (たとえば、$HOME/mysrc/helloWorld) 内に作成します。

HelloInterface.java ファイルを作成します。 次のコードは、リモートインタフェース HelloInterface のインタフェース定義です。この定義には、ただひとつのメソッド sayHello が含まれています。

//HelloInterface.java
import java.rmi.Remote;

public interface HelloInterface extends java.rmi.Remote {
   public void sayHello( String from ) throws java.rmi.RemoteException;
}

• 少なくとも 1 つのリモートインタフェースの実装を宣言している
• リモートオブジェクトのコンストラクタを定義する
• リモートから呼び出せるメソッドの実装を提供している

HelloImpl.java ファイルを作成します。 このファイルのコードは以下のとおりです。 ソースコードを紹介したあと、上記の各ステップについて説明します。

//HelloImpl.java
import javax.rmi.PortableRemoteObject;

public class HelloImpl extends PortableRemoteObject implements HelloInterface{
   public HelloImpl() throws java.rmi.RemoteException {
       super();     // invoke rmi linking and remote object initialization
   }

   public void sayHello( String from ) throws java.rmi.RemoteException {
       System.out.println( "Hello from " + from + "!!" );
       System.out.flush();
   }
}

リモートインタフェースを実装する

Java プログラミング言語では、あるインタフェースを実装することをクラスが宣言すると、そのクラスとコンパイラの間で契約が結ばれます。 この契約によって、そのクラスは、そのインタフェース内で宣言された各メソッドシグニチャーに対して、メソッドの本体 (つまり定義) を提供することを約束します。 インタフェースのメソッドは、暗黙のうちに public および abstract として宣言されているため、実装クラスでその契約が果たされない場合、そのクラスは定義に基づき abstract になります。そのクラスが abstract として宣言されていない場合は、コンパイラによってその事実が指摘されます。

この例では、実装クラスは HelloImpl です。 このクラスは、どのリモートインタフェースを実装するのかを宣言します。 HelloImpl クラスの宣言は、次のとおりです。

  public class HelloImpl extends PortableRemoteObject
    implements HelloInterface{

リモートオブジェクトのコンストラクタを定義する

さらに、リモートオブジェクトのインスタンスは「エクスポート」される必要があります。 リモートオブジェクトをエクスポートすると、そのオブジェクトは、匿名ポート上でリモートオブジェクトへの着呼を監視することによって、着信したリモートメソッド要求を受け入れることができるようになります。 javax.rmi.PortableRemoteObject を継承すると、そのクラスは作成時に自動的にエクスポートされます。

オブジェクトのエクスポートは、java.rmi.RemoteException をスローする可能性があるため、コンストラクタがほかに何も行わない場合でも、RemoteException をスローするコンストラクタを定義する必要があります。 コンストラクタを定義しなかった場合は、javac は、次のエラーメッセージを生成します。

	HelloImpl.java:3: unreported exception java.rmi.RemoteException; must be
	caught or declared to be thrown.

        public class HelloImpl extends PortableRemoteObject implements HelloInterface{
               ^
        1 error

• リモートインタフェースを実装する
• オブジェクトをエクスポートして、着信するリモートメソッド呼び出しを受け入れ可能にする
• 最低でも、java.rmi.RemoteException をスローするようにコンストラクタを定義する

  public HelloImpl() throws java.rmi.RemoteException {
    super();
  }

• super メソッド呼び出しは、リモートオブジェクトをエクスポートする javax.rmi.PortableRemoteObject の引数なしのコンストラクタを呼び出す
• 通信リソースが利用できない場合は、RMI がリモートオブジェクトを構築中にエクスポートしようとすると失敗する可能性があるため、コンストラクタは java.rmi.RemoteException をスローする必要がある

java.rmi.RemoteException が実行時例外ではなくチェックされる例外である理由については、rmi-users 電子メールリストの下記のアーカイブを参照してください。

http://java.sun.com/products/jdk/rmi/archives/3490.html

スーパークラスの引数なしのコンストラクタ super() への呼び出しは、もし省略したとしてもデフォルトで発生しますが、この例では、クラスの前にスーパークラスが構築されることを明確にするために、この呼び出しを省略せずに記述しました。

各リモートメソッドに実装を提供する

   public void sayHello( String from ) throws java.rmi.RemoteException {
       System.out.println( "Hello from " + from + "!!");
       System.out.flush();
   }

• デフォルトでは、ローカルオブジェクトはコピーによって渡される。つまり、static または transient とマークされたもの以外は、オブジェクトのすべてのデータメンバ (またはフィールド) がコピーされる。 直列化のデフォルト動作を変更する方法については、「Java オブジェクト直列化仕様」を参照
• リモートオブジェクトは参照によって渡される。 リモートオブジェクトへの参照は、実際にはスタブ (クライアント側でのリモートオブジェクトのプロキシ) への参照である。 スタブの詳細については、「Java Remote Method Invocation」を参照。 スタブの作成法については、「rmic を使ってスタブおよびスケルトンを生成する」で説明する。

サーバクラスを作成する

サーバクラスは、リモートオブジェクト実装のインスタンスを生成し、そのインスタンスをネームサービスの名前にバインドする main メソッドを持ちます。 この main メソッドを含むクラスは、実装クラスそのものである場合も、まったく別のクラスである場合もあります。

この例では、main は HelloServer.java の一部として含まれており、次の処理を実行します。

• サーバントのインスタンスを作成する
• オブジェクト参照を公開する

HelloServer.java ファイルを作成します。 このファイルのソースコードは以下のとおりです。 ソースコードを紹介したあと、上記の各ステップについて説明します。

//HelloServer.java
import javax.naming.InitialContext;
import javax.naming.Context;


public class HelloServer {
    public static void main(String[] args) {
        try {
            // STEP 1: Instantiate the Hello servant
            HelloImpl helloRef = new HelloImpl();

            // STEP 2: Publish the reference in the Naming Service
            // using JNDI API
            Context initialNamingContext = new InitialContext();
            initialNamingContext.rebind("HelloService", helloRef );

            System.out.println("Hello Server: Ready...");

         } catch (Exception e) {
            System.out.println("Trouble: " + e);
            e.printStackTrace();
         }
     }
}

リモートオブジェクトのインスタンスを作成する

    HelloImpl helloRef = new HelloImpl();

リモートオブジェクトがサーバに登録されたあとは、呼び出し側は、オブジェクトを名前で検索し (ネームサービスを利用する)、リモートオブジェクトへの参照を取得してはじめて、そのオブジェクトのメソッドをリモートから呼び出せるようになります。 この例では、Object Request Broker Daemon (orbd) の一部であるネームサービスを使用します。

たとえば、次のコードは、「HelloService」という名前をリモートオブジェクトへの参照にバインドします。

            // STEP 2: Publish the reference in the Naming Service
            // using JNDI API
            Context initialNamingContext = new InitialContext();
            initialNamingContext.rebind("HelloService", helloRef );

rebind メソッド呼び出しの引数については、次の点に注意してください。

• 第 1 の引数 "HelloService" は、バインドするリモートオブジェクトの名前を表す java.lang.String である

• 2 番目の引数 helloRef はバインドするリモートオブジェクトのオブジェクト ID である

リモートサービスを利用するクライアントプログラムを作成する

この例のクライアントアプリケーションは、リモートから sayHello メソッドを呼び出して、クライアントアプリケーションが実行されたときに「Hello from MARS!!」という文字列を表示します。

HelloClient.java ファイルを作成します。 クライアントアプリケーションのソースコードは、次のとおりです。

//HelloClient.java
import java.rmi.RemoteException;
import java.net.MalformedURLException;
import java.rmi.NotBoundException;
import javax.rmi.*;
import java.util.Vector;
import javax.naming.NamingException;
import javax.naming.InitialContext;
import javax.naming.Context;

public class HelloClient {

    public static void  main( String args[] ) {
        Context ic;
        Object objref;
        HelloInterface hi;

        try {
            ic = new InitialContext();

        // STEP 1: Get the Object reference from the Name Service
        // using JNDI call.
            objref = ic.lookup("HelloService");
            System.out.println("Client: Obtained a ref. to Hello server.");

        // STEP 2: Narrow the object reference to the concrete type and
        // invoke the method.
            hi = (HelloInterface) PortableRemoteObject.narrow(
                objref, HelloInterface.class);
            hi.sayHello( " MARS " );

        } catch( Exception e ) {
            System.err.println( "Exception " + e + "Caught" );
            e.printStackTrace();
            return;
        }
    }
}

まず、クライアントアプリケーションは、リモートオブジェクト実装 (「HelloService」として公開されている) への参照を、Java Naming and Directory Interface [TM] (JNDI) 呼び出しを使用してネームサービスから取得します。 Naming.rebind メソッドと同じく、Naming.lookup メソッドも、検索するオブジェクトの名前を表す java.lang.String 値を引数として取ります。 検索したいオブジェクトの名前を Naming.lookup() に提供すると、その名前にバインドされたオブジェクトが返されます。 Naming.lookup() は、呼び出し側 (HelloClient) に Hello インタフェースのリモート実装のスタブを返します。

    javac -d . -classpath . HelloImpl.java

    rmic -iiop HelloImpl

    javac -d . -classpath . HelloInterface.java HelloServer.java HelloClient.java

    orbd -ORBInitialPort 1050&

    start orbd -ORBInitialPort 1050

    java
      -classpath .
      -Djava.naming.factory.initial=com.sun.jndi.cosnaming.CNCtxFactory
      -Djava.naming.provider.url=iiop://localhost:1050
      HelloServer

Hello Server: Ready ...

    java
      -classpath .
      -Djava.naming.factory.initial=com.sun.jndi.cosnaming.CNCtxFactory
      -Djava.naming.provider.url=iiop://localhost:1050
      HelloClient

Client: Obtained a ref. to Hello server.
Hello from  MARS