起動可能オブジェクトの作成

このチュートリアルでは、java.rmi.activation.Activatable を継承して、起動可能オブジェクトを作成する手順について説明します。また、UnicastRemoteObject を起動可能にする方法または java.rmi.activation.Activatable を継承しないオブジェクトの起動方法についての説明もします。

JavaTM 2 SDK をリリースする前は、UnicastRemoteObject のインスタンスへのアクセスは、(1) リモートオブジェクトのインスタンスを生成し、かつ (2) 常時稼動中である、サーバプログラムからアクセスできました。現在では、java.rmi.activation.Activatable クラスおよび RMI デーモン rmid の導入により、常時ではなく「必要に応じて」作成され、実行されるリモートオブジェクトの実装情報を登録するプログラムの記述が可能になりました。RMI デーモン rmid は、Java 仮想マシン* (JVM) を提供します。 この JVM からほかの JVM インスタンスを生成させることも可能です。

注: このチュートリアルでは以降、「起動可能オブジェクトの実装」、「起動可能オブジェクト」、および「実装」という場合は、すべて、リモートインタフェースを実装する起動可能なクラス examples.activation.ActivatableImplementation を指します。

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

このチュートリアルの実行に必要なファイルは、次のとおりです。

ここでは、クライアントコードも示しますが、実装クラスやセットアップクラスの場合のように、手順を追った説明はしません。これは、起動可能オブジェクトのクライアントコードが、起動可能でないリモートオブジェクトにアクセスするための RMI クライアントコードと同じであるためです。起動は、厳密にはサーバ側での実装によって決定されます。

このチュートリアルで使われているソースコードは、次のファイル形式から選ぶことができます。

実装クラスの作成

この例の実装クラスは、examples.activation.ActivatableImplementation です。実装クラスは、次の 4 つのステップで作成します。

  1. 実装クラスに対し適切なインポートを実行する
  2. java.rmi.activation.Activatable からクラスを継承する
  3. 2 つの引数をとる実装クラスのコンストラクタを宣言する
  4. リモートインタフェースメソッドを実装する
ステップ 1:
実装クラスに対し適切なインポートを実行する 
import java.rmi.*;
import java.rmi.activation.*;

ステップ 2:
java.rmi.activation.Activatable からクラスを継承する 

public class ActivatableImplementation extends Activatable
    implements examples.activation.MyRemoteInterface {
ステップ 3:
2 つの引数をとる実装クラスのコンストラクタを宣言する 
public ActivatableImplementation(ActivationID id, MarshalledObject data)
    throws RemoteException {
    // Register the object with the activation system
    // then export it on an anonymous port
    super(id, 0);
}

ステップ 4:
リモートインタフェースメソッドを実装する 

public Object callMeRemotely() throws RemoteException {
    return "Success";
}

「セットアップ」クラスの作成

「セットアップ」クラスの役割は、リモートオブジェクトのインスタンスを生成しない場合でも、起動可能クラスに必要なすべての情報を作成することです。この例のセットアップクラスは、 examples.activation.Setup です。

セットアップクラスは、起動可能クラスに関する情報を rmid に渡し、リモート参照 (実行可能クラスのスタブクラスのインスタンス) および識別子 (名前) を rmiregistry に登録します。そのあと、セットアップクラスは終了できます。セットアップクラスは、7 つのステップで作成します。

  1. セットアップクラスで適切なインポートを実行する
  2. SecurityManager をインストールする
  3. ActivationGroup のインスタンスを生成する
  4. ActivationDesc のインスタンスを生成する
  5. リモートインタフェースのインスタンスを宣言し、rmid に起動記述子を登録する
  6. スタブを rmiregistry の名前にバインドする
  7. セットアップアプリケーションを終了する

ステップ 1:
セットアップクラスで適切なインポートを実行する 

import java.rmi.*;
import java.rmi.activation.*
import java.util.Properties;

ステップ 2:
SecurityManager をインストールする 

System.setSecurityManager(new RMISecurityManager());

ステップ 3:
ActivationGroup のインスタンスを生成する

注: ここでは、例を単純にするために、すべての位置のすべてのユーザにグローバルなアクセス権を与える policy ファイルを使用します。このポリシーファイルは、実稼働環境では使用しないでください。java.security.policy ファイルを使ってアクセス権を適切に指定する方法については、次のドキュメントを参照してください。

セットアップアプリケーションにおける起動グループ記述子の役割は、rmid が適切な既存の JVM にアクセスしたり、起動可能オブジェクト用の新しい JVM を生成したりする際に必要になるすべての情報を提供することです。

注 - このコードを実際にシステム上で実行するには、ポリシーファイルの位置を、ソースコードに付属するサンプルのポリシーファイルをインストールした絶対パスに変更する必要があります。 

// Because of the Java 2 security model, a security policy should
// be specified for the ActivationGroup VM. The first argument
// to the Properties put method, inherited from Hashtable, is
// the key and the second is the value
//
Properties props = new Properties();
props.put("java.security.policy",
   "/home/rmi_tutorial/activation/policy");

ActivationGroupDesc.CommandEnvironment ace = null;
ActivationGroupDesc exampleGroup = new ActivationGroupDesc(props, ace);

// Once the ActivationGroupDesc has been created, register it
// with the activation system to obtain its ID
//
ActivationGroupID agi =
   ActivationGroup.getSystem().registerGroup(exampleGroup);

ステップ 4:
ActivationDesc のインスタンスを生成する

起動記述子の役割は、rmid が実装クラスの新しいインスタンスの生成に必要とするすべての情報を提供することです。

注 - このコードをシステム上で実行するには、ファイルの URL の位置を、サンプルソースコードを実際にインストールしたディレクトリの位置に変更する必要があります。 

// The "location" String specifies a URL from where the class
// definition will come when this object is requested (activated).
// Don't forget the trailing slash at the end of the URL
// or your classes won't be found.
//
String location = "file:/home/rmi_tutorial/activation/";

// Create the rest of the parameters that will be passed to
// the ActivationDesc constructor
//
MarshalledObject data = null;

// The location argument to the ActivationDesc constructor will be used
// to uniquely identify this class; it's location is relative to the
// URL-formatted String, location.
//
ActivationDesc desc = new ActivationDesc
    (agi, "examples.activation.ActivatableImplementation",
      location, data);

ステップ 5:
リモートインタフェースのインスタンスを宣言し、rmid に起動記述子を登録する

MyRemoteInterface mri = (MyRemoteInterface)Activatable.register(desc);
System.out.println("Got the stub for the ActivatableImplementation");

ステップ 6:
Activatable.register メソッドによって返されたスタブを rmiregistry の名前にバインドする

Naming.rebind("ActivatableImplementation", mri);
System.out.println("Exported ActivatableImplementation");

ステップ 7:
セットアップアプリケーションを終了する

System.exit(0);

コードのコンパイルおよび実行

コードのコンパイルおよび実行は、次の 6 つのステップで行います。

  1. リモートインタフェース、実装、クライアント、およびセットアップの各クラスをコンパイルする
  2. 実装クラス上で rmic を実行する
  3. rmiregistry を開始する
  4. 起動デーモン rmid を開始する
  5. セットアッププログラムを実行する
  6. クライアントを実行する

ステップ 1:
リモートインタフェース、実装、クライアント、およびセットアップの各クラスをコンパイルする 

% javac -d . MyRemoteInterface.java
% javac -d . ActivatableImplementation.java
% javac -d . Client.java
% javac -d . Setup.java

ステップ 2:
実装クラス上で rmic を実行する 

% rmic -d . examples.activation.ActivatableImplementation

ステップ 3:
rmiregistry を開始する 

% rmiregistry &

注 - rmiregistry を開始する前に、registry を実行するシェルまたはウィンドウに CLASSPATH が設定されていないこと、あるいは設定されていても、クライアントにダウンロードするクラスへのパス (リモートオブジェクトの実装クラスのスタブを含む) が含まれていないことを確認してください。

rmiregistry が、その開始時に CLASSPATH 内でスタブクラスを見つけると、サーバの java.rmi.server.codebase プロパティは無視されます。その結果、クライアントは、そのリモートオブジェクトのスタブコードをダウンロードできません。

ステップ 4:
起動デーモン rmid を開始する 

% rmid -J-Djava.security.policy=rmid.policy &
rmid.policy は、rmid のセキュリティポリシーファイル名です。

注: デフォルトでは、rmid は現在、セキュリティポリシーファイルを要求します。 このファイルは、起動グループ用の JVM の起動に、各 ActivationGroupDescriptor の情報を使用できるかどうかを確認するために使用されます。完全な詳細については、rmid の Solaris オペレーティング環境用マニュアルページおよび rmid の Microsoft の Windows プラットフォーム用マニュアルページを参照してください。

ステップ 5:
セットアッププログラムを実行する

コードベースのプロパティを実装スタブの位置に設定して、セットアップを実行します。次の 4 つを同じコマンド行に記述する必要があります。

  1. java」コマンド
  2. セキュリティポリシーファイルの位置を指定するプロパティの「名前」=「値」のペア
  3. スタブコードの位置を指定するプロパティ (「-D」から最後の「/」まで空白文字は含めない)
  4. セットアッププログラムの完全指定されたパッケージ名

空白文字は、java という語の直後に 1 つ、2 つのプロパティの間に 1 つ、および (ブラウザまたは紙上では判別しにくいですが) examples という語の直前に 1 つ必要です。

% java  -Djava.security.policy=/home/rmi_tutorial/activation/policy   -Djava.rmi.server.codebase=file:/home/rmi_tutorial/activation/  examples.activation.Setup

コードベースプロパティは URL として解釈処理されます。 このため、コードベースプロパティは http://aHost/somesource/ か file:/myDirectory/location/ の形式、またはオペレーティングシステムによっては file:///myDirectory/location/ (file:のあとにスラッシュが 3 つ続く) の形式でなければなりません。

サンプルコードを実行するには file:形式の URL の方が使いやすい場合があります。しかし、この場合、サーバにアクセスできるクライアントは、(サーバと同じマシン上で実行したり NFS などの共用ファイルシステムを使用して) サーバと同じファイルシステムにアクセスできるクライアントだけになります。HTTP サーバがまだ稼動していない場合は、米国サン・マイクロシステムズ社またはその関係会社の HTTP サーバからダウンロードすることができます。

これらのサンプル URL の各文字列には、末尾に「/」があることに注意してください。java.rmi.server.codebase プロパティで指定する URL では、実装がクラス定義を適切に解釈処理 (検索) するために、末尾のスラッシュが必要です。コマンド行からの java.rmi.server.codebase プロパティの設定についての詳細は、java.rmi.server.codebase プロパティを使用した動的なコードのダウンロードについてのチュートリアルを参照してください。

プロパティ上の末尾のスラッシュを忘れたり、ソース位置にクラスファイルが見つからない (ダウンロード可能ではない) 場合、またはプロパティ名の入力を間違えた場合は、java.lang.ClassNotFoundException がスローされます。この例外は、リモートオブジェクトを rmiregistry にバインドしようとした場合、または最初のクライアントがそのオブジェクトのスタブにアクセスしようとした場合にスローされます。後者の場合は、rmiregistry が CLASSPATH 内でスタブを検索するため、さらに問題が発生する場合があります。

サーバ側の出力は、次のようになります。 

      Got the stub for the ActivatableImplementation
      Exported ActivatableImplementation

ステップ 6:
クライアントを実行する

examples.activation.Client プログラムへの引数は、実装サーバのホスト名で、この場合は vector です。 

% java -Djava.security.policy=/home/rmi_tutorial/activation/policy 
 examples.activation.Client vector

クライアント側の出力は次のようになります。 

      Got a remote reference to the object that extends Activatable.
      Making remote call to the server
      Returned from remote call
      Result: Success
* この Web サイトで使用されている用語「Java 仮想マシン」または「JVM」は、Java プラットフォーム用の仮想マシンを表します。
Copyright © 1999 Sun Microsystems, Inc. All Rights Reserved. 
コメントの送付先: rmi-comments@java.sun.com 		 Sun