アクティベーションの使用: Activatable を拡張する

このチュートリアルでは、java.rmi.activation.Activatable クラスを拡張することで起動可能なリモートオブジェクトを実装する方法について説明します。このチュートリアルでは、Setup プログラム (「アクティベーションの使用: Setup プログラム」チュートリアルを参照) を使用します。このプログラムは、起動可能なリモートオブジェクトに関する情報を JavaTM Remote Method Invocation (Java RMI) 起動システムデーモン (rmid) に登録し、rmiregistry でそのリモートオブジェクトのスタブをバインドして、クライアントが検索できるようにします。このチュートリアルの前に、Setup プログラムのチュートリアルを読むことをお勧めします。

このチュートリアルでは、次の手順を実行します。

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

起動可能なリモートオブジェクトの実装

起動可能なリモートオブジェクトを実装するには、いくつかの基本的な方法があります。このチュートリアルでは、構築中に起動可能なリモートオブジェクトをエクスポートする java.rmi.activation.Activatable クラスを拡張することで起動可能なリモートオブジェクトを実装する方法について説明します。

リモートオブジェクトは、クライアントが起動可能なリモートオブジェクトのスタブでリモートメソッドを呼び出すときに起動されます。起動可能なリモートオブジェクトのスタブには、リモートオブジェクトの起動識別子と、そのリモートオブジェクトの Java RMI 起動システムデーモン (rmid) にコンタクトする方法に関する情報が含まれます。スタブは、リモートオブジェクトの最新のアドレス (つまり、ホスト/ポート) に接続できない場合、リモートオブジェクトのアクティベータ (rmid) にコンタクトしてそのオブジェクトを起動します。rmid は、起動要求を受け取ると、リモートオブジェクトの起動グループがまだ実行されていない場合は、そのグループ (またはコンテナ) の VM を起動します。次に、rmid は、グループにそのリモートオブジェクトのインスタンスを作成するように要求します。グループは、リモートオブジェクトを構築すると、そのリモートオブジェクトのスタブを rmid に返します。次に、rmid は実際のスタブを起動スタブに返して、起動スタブが将来そのリモートオブジェクトにコンタクトする方法についての情報を更新できるようにします。

このアクティベーションを行う前に、アプリケーションでは、使用する必要のある起動可能なリモートオブジェクトに関する情報を登録する必要があります。次の別個のチュートリアルでは、リモートオブジェクトの起動に必要な情報と、その情報を rmid に登録する方法について説明します。

この例では、起動可能なリモートオブジェクトが次の examples.activation.MyRemoteInterface リモートインタフェースを実装します。

package examples.activation;

import java.rmi.*;

public interface MyRemoteInterface extends Remote {
    Object remoteMethod(Object obj) throws RemoteException;
}

起動可能なリモートオブジェクトの examples.activation.ExtendsActivatable 実装クラスは次のとおりです。

package examples.activation; 

import java.rmi.*;
import java.rmi.activation.*;

public class ExtendsActivatable
        extends Activatable 
        implements MyRemoteInterface
{

    public ExtendsActivatable(ActivationID id, MarshalledObject data) 
        throws RemoteException
    {
        super(id, 0);
    }
        
    public Object remoteMethod(Object obj) {
        return obj;
    }
}

ExtendsActivatable クラスは、Activatable クラスを拡張して、リモートインタフェース MyRemoteInterface を実装します。

ExtendsActivatable クラスは、起動グループが起動プロセス中にインスタンスを構築するために呼び出す特別な「起動」コンストラクタを宣言します。この特別なコンストラクタは、次の 2 つのパラメータを取ります。

コンストラクタは、単純にスーパークラス (Activatable) のコンストラクタを呼び出して、匿名ポートにオブジェクトをエクスポートします。

最後に、クラスは、リモートインタフェースの単一メソッドである remoteMethod を実装して、引数として渡されたオブジェクトを返します。

クライアントの実装

Client プログラムは、オプションの第 1 引数として提供されたホストのレジストリ内のリモートオブジェクトのスタブ (リモートインタフェース MyRemoteInterface を実装するスタブ) を検索して、そのスタブの remoteMethod メソッドを呼び出します。レジストリから獲得したスタブでこのクライアントがリモートメソッドを呼び出すと、リモートオブジェクトが起動されていない場合にはリモートオブジェクトが起動されます。

プログラムのソースは次のとおりです。

package examples.activation; 

import java.rmi.*;
import java.rmi.registry.*;

public class Client {

    public static void main(String args[])  throws Exception {

  
        String hostname = "localhost";
        if (args.length < 1) {
            System.err.println(
                "usage: java [options] examples.activation.Client <hostname>");
            System.exit(1);
        } else {
            hostname = args[0];
        }

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

        String name = System.getProperty("examples.activation.name");
        Registry registry = LocateRegistry.getRegistry(hostname);
        MyRemoteInterface stub =
            (MyRemoteInterface) registry.lookup(name);
        System.err.println("Obtained stub from the registry.");
                
        System.err.println("Invoking remote method...");
        String result = (String) stub.remoteMethod("hello there!");
        System.err.println("Returned from remote call.");
        System.err.println("Result: " + result);
    }
}

このプログラムを次のように実行します。

java -cp clientDir                               \
     -Djava.security.policy=client.policy        \
     -Dexamples.activation.client.codebase=clientCodebase   \
     -Dexamples.activation.name=name             \
     examples.activation.Client [host]

次にそれぞれの意味を示します。

注:このプログラムを実行する前に、rmid がそのデフォルトポートで稼働し、rmiregistry がそのデフォルトポート (両方ともリモートホスト上) で稼働している必要があります。

アクティベーションの例として、適切なアクセス権を付与する client.policy ファイルの例を次に示します。

grant codeBase "${examples.activation.client.codebase}" {

    // permissions to read system properties required by the client
    permission java.util.PropertyPermission "examples.activation.name","read";

    // permission to connect to the registry, activation system, and remote host
    permission java.net.SocketPermission "*:1024-","connect";
};

アクセス権が付与されるコードベースは、クライアントのクラスの場所を指定するファイル URL です。このファイル URL は、examples.activation.client.codebase システムプロパティーの値で、クライアントプログラムの実行時に定義されます。クライアントには 2 つのアクセス権が必要です。

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

この例のソースファイルは、次のようにしてコンパイルできます。

javac -d implDir MyRemoteInterface.java ExtendsActivatable.java 
javac -d clientDir MyRemoteInterface.java Client.java

implDir は実装のクラスファイルを配置する生成先ディレクトリで、clientDir はクライアントのクラスファイルを配置する生成先ディレクトリです。

Setup プログラムの実行

実装段階が完了したら、起動可能なオブジェクトに関する情報を登録して、クライアントが使えるようにする必要があります。Setup プログラムは、「アクティベーションの使用: Setup プログラム」チュートリアルで説明されているように、起動可能なオブジェクトの起動記述子を rmid に登録し、rmiregistry でリモートオブジェクトのスタブをバインドして、クライアントが検索できるようにします。

この例の Setup プログラムを実行するには、Setup プログラムのチュートリアルのセクション「rmid、rmiregistry、および Setup プログラムの起動」を参照してください。rmid、rmiregistry、および Setup プログラム自体の起動方法について説明しています。

Setup チュートリアルの手順に従って rmid と rmiregistry を実行したら、Setup プログラムを実行して、examples.activation.ExtendsActivatable クラスを実装する起動可能なオブジェクトの起動記述子を登録する必要があります。次のコマンド行では、使用する各コードベースの適切なファイル URL を指定して Setup プログラムを実行します。

java -cp setupDir:implDir                       \
     -Djava.security.policy=setup.policy                      \
     -Djava.rmi.server.codebase=file:/implDir/                \
     -Dexamples.activation.setup.codebase=file:/setupDir/     \
     -Dexamples.activation.impl.codebase=file:/impDir/        \
     -Dexamples.activation.name=examples.activation.MyRemoteInterface       \
     -Dexamples.activation.policy=group.policy                \
     examples.activation.Setup examples.activation.ExtendsActivatable

次にそれぞれの意味を示します。

examples.activation.file システムプロパティーは、ExtendsActivatable 実装クラスでは使用されないため、指定する必要はありません。前述の各ファイル URL には、必須の末尾のスラッシュがあることにも注意してください。このチュートリアルに適したグループとセットアップポリシーファイルの例は、セットアップのチュートリアルに示されていますが、次にも示しておきます。

Setup プログラムからの出力は、次のようになります。

Activation group descriptor registered.
Activation descriptor registered.
Stub bound in registry.

クライアントの実行

正常に ExtendsActivatable 実装の起動記述子を登録したら、クライアントプログラムを実行できるようになります。クライアントプログラムは、最初の実行時に起動可能なオブジェクトを起動します。

次のコマンド行は、クライアントコードベースのファイル URL を指定してクライアントプログラムを実行する方法を示しています。

java -cp clientDir                                              \
     -Djava.security.policy=client.policy                       \
     -Dexamples.activation.client.codebase=file:/clientDir/     \
     -Dexamples.activation.name=examples.activation.MyRemoteInterface         \
     examples.activation.Client [host]

次にそれぞれの意味を示します。

注:

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

Obtained stub from the registry.
Invoking remote method...
Returned from remote call.
Result: hello there!
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.