この章ではおなじみの Hello World プログラムの分散システム版を Java の RMI (Remote Method Invocation) を使って作成する手順をステップを追って説明します。

分散バージョンの Hello World はアプレットを使ってサーバのリモートメソッドを呼び出し、ここからプログラムをダウンロードして "Hello World" というメッセージを取り出します。このアプレットが走るとクライアント側にメッセージが表示されます。

これを完成させるには、次の3つのレッスンを実行しなければなりません。

• HTML と Java のソースファイルを書く
• クラスファイルと HTML ファイルをコンパイルと分配
• リモートオブジェクトレジストリ、サーバ、そしてアプレットのスタート

HTML と Java のソースファイルを書く

1. Java リモートインタフェース
2. リモートインタフェースを実装するためのリモートオブジェクト(サーバ)
3. サーバのメソッドをリモートから呼び出すための Java アプレット
4. アプレットを参照する web ページのための HTML コード

mkdir $HOME/jdk1.1/mysrc/examples/hello

リモートインタフェースを定義する

リモートオブジェクトであることをはっきりさせるために、オブジェクトはリモートインタフェースを実装しますが、このインタフェースは次の特徴を持っています。

• リモートインタフェースは public でなければならない。そうでないと、クライアントはリモートインタフェースを実装してリモートオブジェクトをロードしようとした時点でエラーとなる。
• リモートインタフェースは java.rmi.Remote インタフェースを拡張する。
• 各メソッドは、アプリケーションに固有の例外に加えて、throws 節の中で java.rmi.RemoteException を宣言しなければならない。
• 引数または返り値として渡されたリモートオブジェクト（直接またはローカルオブジェクトとして埋め込まれた）は実装クラスとしてではなく、リモートインタフェースとして宣言されなければならない。

package examples.hello;
public interface Hello extends java.rmi.Remote {
	String sayHello() throws java.rmi.RemoteException;
}

実装クラスを書く

1. 一つ以上のリモートインタフェースを実装するよう指定します。
2. リモートオブジェクトのコンストラクタを定義します。
3. リモートに呼び出される可能性のあるメソッドを実装します。
4. セキュリティマネージャを作成してインストールします。
5. リモートオブジェクトのインスタンスを1つ以上作成します。
6. ブートストラッピングのために、リモートオブジェクトの少なくとも一つを RMI リモートオブジェクトレジストリに登録します。

package examples.hello;

import java.rmi.*;
import java.rmi.server.UnicastRemoteObject;

public class HelloImpl
	extends UnicastRemoteObject
	implements Hello
{
	private String name;

	public HelloImpl(String s) throws RemoteException {
		super();
		name = s;
	}

	public String sayHello() throws RemoteException {
		return  "Hello World!";
	}

	public static void main(String args[])
	{
		// Create and install a security manager
		System.setSecurityManager(new RMISecurityManager());

		try {
			HelloImpl obj = new HelloImpl("HelloServer");
			Naming.rebind("//myhost/HelloServer", obj);
			System.out.println("HelloServer bound in registry");
		} catch (Exception e) {
			System.out.println("HelloImpl err: " + e.getMessage());
			e.printStackTrace();
		}
	}
}

リモートインタフェースの実装

public class HelloImpl
	implements Hello
	extends java.rmi.server.UnicastRemoteObject

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

次に示すのは HelloImpl クラスのコンストラクタで、private な文字列変数 name をリモートオブジェクトの名前で初期化します。

private String name;
public HelloImpl(String s) throws java.rmi.RemoteException {
	super();
	name = s;
}

• メソッド super を呼び出すと java.rmi.server.UnicastRemoteObject の引数を持たないコンストラクタが呼び出され、無名ポート上にあるリモートオブジェクトに対する外部からの呼び出しに応じてそのリモートオブジェクトを "export（エクスポート）" する。
• RMI がコンストラクタの中でリモートオブジェクトをエクスポートすると、もし通信リソースが利用できない場合には失敗してしまうので、コンストラクタは必ず java.rmi.RemoteException をスローしなければならない。

それぞれのリモートメソッドに実装を与える

一例として次に sayHello メソッドの実装例を示します。この例では文字列 "Hello World!" を呼び出し側に返します。

public String sayHello() throws RemoteException {
	return  "Hello World!";
}

• ローカルオブジェクトはコピーにより渡されるが、デフォルトでコピーされるのは static でないフィールドと transient でないフィールドだけである。
• リモートオブジェクトは参照し渡される。リモートオブジェクトへの参照は実際にはスタブへの参照であり、このスタブがリモートオブジェクトへのクライアント側プロキシになる。スタブについての詳細な説明は次の項スタブとスケルトンの生成を参照

セキュリティマネージャの生成とインストール

System.setSecurityManager(new RMISecurityManager());

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

HelloImpl obj = new HelloImpl("HelloServer");

リモートオブジェクトを登録する

ブートストラッピングの場合には、RMI システムが URL を基礎とするレジストリを与え、これにより //host/objectname の形式の URL を単なる文字列で指定されたリモートオブジェクトに結び付けることができます。いったんリモートオブジェクトがサーバに登録されると、呼び出し側はオブジェクトを名前で探し、リモートオブジェクトへの参照を得ることができ、そのオブジェクトのメソッドをリモートから呼び出すことができるようになります。

例えば、次のコードは HelloServer という名前のリモートオブジェクトの URL をリモートオブジェクトへの参照と結び付けるものです。

Naming.rebind("//myhost/HelloServer", obj);

• URL でホスト名を省略すると自動的に現在のホストが仮定され、この場合は URL にプロトコルを指定する必要はない。
• RMI のランタイムはリモートオブジェクトのスタブへの参照を、オブジェクトへの引数が指定する実際のオブジェクトへの参照と置き換える。HelloImpl のインスタンスのようなリモート実装オブジェクトはその上で生成された仮想マシンを離れることはない。したがってクライアントがサーバのリモートオブジェクトのルックアップを行った場合には、スタブへの参照が返される。
• オプションとして URL にポート番号を付け加えることができる。例: //myhost:1234/HelloServer。デフォルトでは 1099 になる。ポート番号を指定しなければならないのはサーバがポート上にデフォルト値 1099 以外のレジストリを作成する場合のみである。

リモートサービスを使うアプレットの書き方

package examples.hello;

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

public class HelloApplet extends java.applet.Applet {
	String message = "";
	public void init() {
		try {
			Hello obj = (Hello)Naming.lookup("//" +
				getCodeBase().getHost() + "/HelloServer");
			message = obj.sayHello();
		} catch (Exception e) {
			System.out.println("HelloApplet exception: " +
				e.getMessage());
			e.printStackTrace();
		}
	}
	public void paint(Graphics g) {
		g.drawString(message, 25, 50);
	}
}

1. アプレットは最初にサーバのレジストリから "HelloServer" への参照を取り出し、getCodeBase メソッドと getHost メソッドを使うことにより URL を作ります。
2. アプレットはリモートオブジェクト HelloServer の sayHello メソッドをリモートから呼び出し、その結果得られる返り値（"Hello World!" という文字列）を message という名前の変数に格納します。
3. アプレットは paint メソッドを呼び出してアプレットを画面に表示します。この結果 "Hello World!" が画面に現れます。

アプレットを含んだ Web ページを書く

<HTML>
<title>Hello World</title>
<center> <h1>Hello World</h1> </center>

The message from the HelloServer is:
<p>
<applet codebase="../.."
	code="examples.hello.HelloApplet"
	width=500 height=120>
</applet>
</HTML>

• そこからクラスをダウンロードしようとするマシン上で HTTP サーバが実行されていなければならない。アプレットの codebase 属性が URL をここで示すように表示する。

  codebase="../.."
  

  この例での codebase は web ページ自体がそこからロードされるディレクトリの2段上のレベルを示している。このように相対パスを使うのは良い方法である。

• アプレットのコード属性は完全パッケージ修飾されたアプレット名を指定し、この例では examples.hello.HelloApplet となる。

  code="examples.hello.HelloApplet"
  

クラスファイルと HTML ファイルのコンパイルと分配

• Hello.java, このファイルには Hello リモートインタフェースのソースコードが書かれている。
• HelloImpl.java, このファイルには HelloImpl リモートオブジェクトを実装するためのソースコードが書かれており、hello World アプレットのサーバになる。
• HelloApplet.java, これはアプレットのソースコードである。
• index.html, これは Hello World アプレットを参照する web ページである。

javac や rmic コンパイラを使用するときは、その結果生成するクラスファイルをどのディレクトリに置くかを指定しなければなりません。アプレットの場合には全てのファイルをそのアプレットの codebase ディレクトリに置かなければなりません。この例では $HOME/public_html/codebase になります。
Web サーバの中には、"http://host/‾username/" の形式で構成された HTTP URL によってユーザの public_html ディレクトリにアクセスできるものがあります。もし Web サーバがこの規約をサポートしていなければ "file://home/username/public_html" の形式のファイル URL を使うことになります。

Java ソースファイルのコンパイル

Java ソースファイルをコンパイルするには、次の形式の javac コマンドを実行します。:

javac -d $HOME/public_html/codebase
	Hello.java HelloImpl.java HelloApplet.java

スタブとスケルトンの生成

例えば、HelloImpl リモートオブジェクト実装のスタブとスケルトンを作成するには次の形式で rmic を実行します。

rmic -d $HOME/public_html/codebase examples.hello.HelloImpl

• HelloImpl_Stub.class
• HelloImpl_Skel.class

HTML ファイルを配置ディレクトリへ移す

mv $HOME/jdk1.1/mysrc/examples/hello/index.html
	$HOME/public_html/codebase/examples/hello

ランタイムパスの設定

リモートオブジェクトレジストリ、サーバ、そしてアプレットのスタート

RMI ブートストラップレジストリのスタート

サーバ上でレジストリをスタートされるためには rmiregistry コマンドを実行します。このコマンドは何も出力せず、一般にバックグランドで実行されます。Windows95、および Windows NT では次のようになります。

start rmiregistry

Solaris 上では次のようになります。

rmiregistry &

start rmiregistry 2001

Naming.rebind("//myhost:2001/HelloServer", obj);

<PARAM name="url" value="//myhost:2001/HelloServer">

サーバのスタート

次のコマンドは、このプロパティを含んで HelloImpl サーバをスタートさせる方法を示します。

java -Djava.rmi.server.codebase=http://myhost/‾myusrname/codebase/
	examples.hello.HelloImpl &

スタブクラスはそれがすでにローカルで利用できる状態になっていない場合に限り、クライアントの仮想マシンへ動的にロードされます。

アプレットの実行

appletviewer
	http://myhost/‾myusrname/codebase/examples/hello/index.html &