Java IDL: POA-Tie サーバー側モデルを使った「Hello World」の例

このドキュメントは、インタフェースを定義する IDL (Interface Definiton Language) とスタブおよびスケルトンを生成する Java IDL コンパイラを使い、完全な CORBA (Common Object Request Broker Architecture) アプリケーションを作成する方法について、高レベルの概要を説明したものです。このドキュメントでは、POA-Tie サーバー側モデルの使い方を説明します。ほかの実装から継承しなければならない場合、標準の継承モデルではなく Tie モデルを使用することがあります。Java の場合は、インタフェースの継承の個数に制限はありませんが、クラスの継承に使用できるスロットは 1 つだけです。継承モデルを使用した場合は、そのスロットが占有されます。Tie モデルを使用した場合は、そのスロットが使用されず、ユーザーが独自の目的で使用することができます。ただし、間接参照のレベルが 1 つ導入されるという欠点があります。つまり、メソッドを呼び出すときに余分なメソッド呼び出しが発生します。

このプログラミングモデルの別の側面にはポータブルオブジェクトアダプタ (POA) があり、次の目標を満たすように設計されています。

プログラマが異なる ORB 製品間で移植可能なオブジェクト実装を作成できるようにする。
オブジェクトの識別情報の永続性を保持する。
オブジェクトが透過的に起動できるようにする。
1 つのサーバントが同時に複数のオブジェクト識別情報を利用できるようにする。

このドキュメントでは、次の内容について説明します。

単純な「Hello World」プログラムの IDL
オブジェクトを作成し、POA-Tie サーバー側実装を使ってネーミングサービスによりオブジェクトを公開するサーバー
オブジェクト名を知っていて、それの参照をネーミングサービスから探し、オブジェクトを呼び出すアプリケーションクライアント
サンプルのコンパイル方法と実行方法についての説明

インタフェースの定義 (`Hello.idl`)

CORBA アプリケーション作成の第一段階は、OMG のインタフェース定義言語 (IDL) を使って、オブジェクトとインタフェースをすべて記述することです。IDL には C++ に似た構文があり、これを使ってモジュール、インタフェース、データ構造などを定義することができます。IDL はさまざまなプログラミング言語にマッピングできます。IDL を Java にマッピングする方法は「IDL と Java 言語のマッピングのサマリー」で説明しています。

次のコードは OMG IDL で記述されたもので、sayHello() オペレーションが文字列 (string) を返し shutdown() メソッドが ORB を停止させる CORBA オブジェクトを記述しています。OMG IDL の構文とセマンティクスの詳細は、CORBA 2.3.1 仕様の第 3 章を参照してください。

Hello.idl

module HelloApp
{
  interface Hello
  {
  string sayHello();
  oneway void shutdown();
  };
};

注: OMG IDL でコードを記述する場合、モジュール名にインタフェース名を使用しないでください。モジュール名にインスタンス名を使用すると、異なるベンダーのツールを使ったコンパイル実行時に、結果の整合性が維持されなくなる危険があります。その結果、コードの移植性が損なわれます。たとえば、同じ名前を含むコードを Sun Microsystems の IDL-to-Java コンパイラを使ってコンパイルすると、1 つの結果が得られます。同じコードを別のベンダーの IDL-to-Java コンパイラを使ってコンパイルすると、別の結果になる場合があります。

アプリケーションを完成させるには、サーバー (HelloServer.java) およびクライアント (HelloClient.java) 実装を提供します。

サーバーの実装 (`HelloServer.java`)

ここで紹介するサーバーは、サーバントとサーバーの 2 つのクラスで構成されます。サーバント HelloImpl は Hello IDL インタフェースの実装で、各 Hello インスタンスは HelloImpl インスタンスによって実装されます。サーバントは、idlj コンパイラにより例の IDL から生成される HelloPOA のサブクラスです。サーバントには、IDL オペレーションごとに 1 つのメソッドが含まれます (この例では、sayHello() および shutdown() メソッド)。サーバントメソッドは、Java の通常のメソッドと変わりはありません。ORB の処理、引数や結果の整列化などを行うコードは、スケルトンで実装します。

HelloServer クラスにはサーバーの main() メソッドが含まれます。

ORB のインスタンスを生成し初期化する
ルート POA の参照を取得し、POAManager を起動する
サーバントのインスタンス (1 つの CORBA Hello オブジェクトの実装) を生成し、それを ORB に伝える
委譲するサーバントで Tie を作成する
ネーミングコンテキストの CORBA オブジェクト参照を取得し、Tie を登録する。この手順でオブジェクトを暗黙に起動します。POA のポリシーとアクティブ化についての詳細は、「POA」を参照してください。
ルートのネーミングコンテキストを取得する
新しいオブジェクトを「Hello」という名前でネーミングコンテキストに登録する
クライアントから新しいオブジェクトが呼び出されるのを待つ

デフォルトのチュートリアルと異なるコードは、太字で強調表示されます。

HelloServer.java

// Copyright and License 
import HelloApp.*;
import org.omg.CosNaming.*;
import org.omg.CosNaming.NamingContextPackage.*;
import org.omg.CORBA.*;
import org.omg.PortableServer.*;
import org.omg.PortableServer.POA;

import java.util.Properties;

class HelloImpl extends HelloPOA{
  private ORB orb;

  public void setORB(ORB orb_val){
    orb = orb_val;
  }
  
  public String sayHello(){
    return "\nHello world !!\n";
  }
  
  public void shutdown(){
    orb.shutdown(false);
  }
}

public class HelloServer{

  public static void main(String args[]){
    try{
      // create and initialize the ORB
      ORB orb = ORB.init(args, null);

      // Get reference to rootpoa & activate the POAManager
      POA rootpoa = POAHelper.narrow(orb.resolve_initial_references("RootPOA"));
      rootpoa.the_POAManager().activate();

      // create servant and register it with the ORB
      HelloImpl helloImpl = new HelloImpl();
      helloImpl.setORB(orb); 

      // create a tie, with servant being the delegate.
      HelloPOATie tie = new HelloPOATie(helloImpl, rootpoa);

      // obtain the objectRef for the tie
      // this step also implicitly activates the object
      Hello href = tie._this(orb);
           
      // get the root naming context
      org.omg.CORBA.Object objRef = orb.resolve_initial_references("NameService");
      
      // Use NamingContextExt which is part of the Interoperable
      // Naming Service specification.
      NamingContextExt ncRef = NamingContextExtHelper.narrow(objRef);

      // bind the Object Reference in Naming
      String name = "Hello";
      NameComponent path[] = ncRef.to_name( name );
      ncRef.rebind(path, href);

      System.out.println("HelloServer ready and waiting ...");

      // wait for invocations from clients
      orb.run();
      } 
      
    catch (Exception e){
      System.err.println("ERROR: " + e);
      e.printStackTrace(System.out);
    }
    
    System.out.println("HelloServer Exiting ...");
        
  }
}

クライアントアプリケーションの実装 (`HelloClient.java`)

後述のアプリケーションクライアントの例は、デフォルトのチュートリアルにあるものと同じです。この例で変更するファイルはサーバー実装だけです。クライアントアプリケーションの例:

ORB を生成し初期化する
ルートネーミングコンテキストへの参照を取得する
ネーミングコンテキストから「Hello」を探し、その CORBA オブジェクトへの参照を受け取る
オブジェクトの sayHello() および shutdown() オペレーションを呼び出し、結果を出力する

HelloClient.java

// Copyright and License 
 
import HelloApp.*;
import org.omg.CosNaming.*;
import org.omg.CosNaming.NamingContextPackage.*;
import org.omg.CORBA.*;

public class HelloClient{

  public static void main(String args[]){
  
    try{
      // create and initialize the ORB
      ORB orb = ORB.init(args, null);

      // get the root naming context
      org.omg.CORBA.Object objRef = 
          orb.resolve_initial_references("NameService");
          
      // Use NamingContextExt instead of NamingContext. This is 
      // part of the Interoperable naming Service.  
      NamingContextExt ncRef = NamingContextExtHelper.narrow(objRef);
 
      // resolve the Object Reference in Naming
      String name = "Hello";
      Hello helloImpl = HelloHelper.narrow(ncRef.resolve_str(name));

      System.out.println("Obtained a handle on server object: " + helloImpl);
      System.out.println(helloImpl.sayHello());
      helloImpl.shutdown();
      }
      
    catch (Exception e) {
      System.out.println("ERROR : " + e) ;
      e.printStackTrace(System.out);
    }
  }
}

「Hello World」の構築方法と実行方法

Hello World プログラムは単純ですが、このプログラムを通して、静的な呼び出しを使用するほとんどの CORBA プログラムの開発に必要なタスクすべてを学び、経験できます。

この例ではネームサービスが必要です (オブジェクト参照に名前をバインドして CORBA オブジェクトに命名できる CORBA サービス)。ネームバインディングはネームサービスに格納され、クライアントは名前を与えて目的のオブジェクト参照を取得できます。今回のバージョンの Java SE に同梱されているネームサービスには、2 つのオプションがあります。一時ネームサービスである tnameserv と、ネームサービスを含む orbd です。この例では orbd を使用しています。

この例を実行するにあたって、Solaris ソフトウェアの使用時は、ポート 1024 未満でプロセスを開始する場合、root になる必要があることを思い出してください。このため、1024 以上のポートを使用することをお勧めします。この例では、-ORBInitialPort オプションを使ってデフォルトのポート番号をオーバーライドします。次の説明では、Java IDL Object Request Broker Daemon orbd 用にポート 1050 を使用できることを前提としています。必要であれば別のポートに変更してください。Windows でこの例を実行する場合は、パス名にバックスラッシュ (\) を使用します。

開発マシンでこのクライアントサーバーアプリケーションを実行するには、次のようにします。

プログラムファイルを作成するか、HelloTie.zip をダウンロードして解凍します。
プログラムファイルが置かれているディレクトリに移動します。
IDL ファイルから IDL-to-Java コンパイラ idlj を 2 回実行して、スタブとスケルトンを作成します。この手順は、java/bin ディレクトリのパスを、使用するパスに含めていることを前提にしています。
```
  idlj -fall  Hello.idl
  idlj -fallTie Hello.idl
```
idlj コンパイラの -fall オプションを使って、クライアントとサーバー側のバインディングの両方を生成する必要があります。このコマンド行でデフォルトのサーバー側バインディングが生成されます。これは POA プログラミングモデルであることを前提にしています。-fallTie オプションで別のファイル HelloPOATie を作成し、Tie の作成に使います。idlj オプションの詳細については、IDL-to-Java コンパイラオプションを参照してください。

idlj コンパイラではいくつかのファイルが生成されます。実際に生成されるファイルの数は、IDL ファイルのコンパイル時に選択されたオプションによって異なります。生成されたファイルには標準の機能があるので、プログラムを配置して実行するまでは無視してもかまいません。Hello.idl の idlj コンパイラで、-fall コマンド行オプションを使って生成されるファイルは次のとおりです。
- HelloPOA.java
  この abstract クラスは、ストリームベースのサーバースケルトンで、サーバー用に基本的な CORBA 機能を提供します。これは org.omg.PortableServer.Servant を拡張し、InvokeHandler インタフェースと HelloOperations インタフェースを実装します。サーバークラス HelloImpl は HelloPOA を拡張します。
- _HelloStub.java
  このクラスはクライアントスタブで、クライアント用に CORBA 機能を提供します。これは org.omg.CORBA.portable.ObjectImpl を拡張し、Hello インタフェースを実装します。
- Hello.java
  このインタフェースには作成した IDL インタフェースの Java 版が含まれます。Hello インタフェースは、標準的な CORBA オブジェクト機能を提供する org.omg.CORBA.Object を拡張します。また HelloOperations インタフェースおよび org.omg.CORBA.portable.IDLEntity も拡張します。
- HelloHelper.java
  このクラスは補助機能、特に CORBA オブジェクト参照を適切な型にキャストする必要がある narrow() メソッドを提供します。Helper クラスは CORBA ストリームへのデータ型の入出力と、Any のデータ型の挿入と抽出を扱います。Holder クラスは、Helper クラスのメソッドに入出力を委譲します。
- HelloHolder.java
  この final クラスは、Hello 型の public インスタンスメンバーを保持します。IDL 型のパラメータが out または inout であれば Holder クラスが使用されます。これは、org.omg.CORBA.portable.OutputStream および org.omg.CORBA.portable.InputStream 引数 (CORBA は許可しますが、Java のセマンティクスには簡単にマッピングできません) に対するオペレーションを提供します。Holder クラスは Helper クラスのメソッドに入出力を委譲します。これは org.omg.CORBA.portable.Streamable を実装します。
- HelloOperations.java
  このインタフェースには sayHello() メソッドおよび shutdown() メソッドが含まれます。IDL-to-Java マッピングは、IDL インタフェースで定義されたオペレーションをすべてこのファイルに組み込み、スタブとスケルトンで共有します。
Hello.idl の idlj コンパイラで、-fallTie コマンド行オプションを使って生成されるファイルは次のとおりです。
- HelloPOATie.java
  MyPOATie のコンストラクタは delegate と poa、またはそのいずれかを引数として取ります。delegate と poa、またはそのどちらかに実装を提供する必要があります。ただし、この delegate は、HelloOperations インタフェース以外に、ほかのクラスから継承する必要はありません。詳細については、IDL から Java 言語へのマッピング仕様を参照してください。
HelloApp ディレクトリにあるスタブとスケルトンも含め、.java ファイルをコンパイルします。この手順は、java/bin ディレクトリが実行パスに含まれていることを前提にしています。
```
   javac *.java HelloApp/*.java
```
orbd を起動します。
UNIX コマンドシェルで orbd を起動するには、次のように入力します。
```
  orbd -ORBInitialPort 1050 -ORBInitialHost localhost&
```
Windows の MS-DOS システムプロンプトでは、次のように入力します。
```
  start orbd -ORBInitialPort 1050 -ORBInitialHost localhost
```
1050 はネームサーバーを実行するポートです。-ORBInitialPort は必須のコマンド行引数です。Solaris ソフトウェアの使用時は、1024 より小さいポートでプロセスを開始する場合は、root ユーザーになる必要があります。このため、1024 以上のポートを使用することをお勧めします。

-ORBInitialHost は、オプションのコマンド行引数です。この例では、クライアントとサーバーはどちらも開発マシンで実行しているので、ホストを localhost に設定しました。複数のマシンで開発する場合は、ホスト名に置き換えます。このプログラムを 2 台のマシンで実行する方法の例は、「2 台のマシンで実行する Hello World プログラム」を参照してください。
Hello サーバーを起動します。
UNIX コマンドシェルで Hello サーバーを起動するには、次のように入力します。
```
  java HelloServer -ORBInitialPort 1050 -ORBInitialHost localhost&
```
Windows の MS-DOS システムプロンプトでは、次のように入力します。
```
  start java HelloServer -ORBInitialPort 1050 -ORBInitialHost localhost
```
この例の -ORBInitialHost localhost は、ネームサーバーが Hello サーバーとして同一ホスト上で動作しているため、省略できます。ネームサーバーが別のホストで動作している場合は、IDL ネームサーバーが動作しているホストを -ORBInitialHost nameserverhost で指定します。

前回の手順と同様にネームサーバー (orbd) のポートを指定します (たとえば -ORBInitialPort 1050)。

サーバーが起動して、次のようなメッセージが端末に表示されます。
```
HelloServer ready and waiting ...
```
クライアントアプリケーションを実行します。
```
  java HelloClient -ORBInitialPort 1050 -ORBInitialHost localhost
```
この例の -ORBInitialHost localhost は、ネームサーバーが Hello クライアントとして同一ホスト上で動作しているため、省略できます。ネームサーバーが別のホストで動作している場合は、IDL ネームサーバーが動作しているホストを -ORBInitialHost nameserverhost で指定します。

前回の手順と同様にネームサーバー (orbd) のポートを指定します (たとえば -ORBInitialPort 1050)。

クライアントが実行されて、次のような情報が端末に表示されます。
```
Obtained a handle on server object: IOR: 
...
Hello World!
Hello Server Exiting ...
```

このチュートリアルを終了したら、ネームサーバー (orbd) を停止するか終了してください。DOS プロンプトでは、orbd を実行しているウィンドウを選択して Ctrl+C と入力すると停止します。UNIX シェルでは、プロセスを検出して終了 (kill) します。ネームサーバーを明示的に停止するまでは、呼び出し待機状態が続きます。

「2 台のマシンで実行する Hello World プログラム」では、クライアントとサーバーという 2 台のマシンで簡単なアプリケーションを分散させる方法の一例を示します。

連絡先

Java IDL: POA-Tie サーバー側モデルを使った「Hello World」の例

インタフェースの定義 (Hello.idl)

サーバーの実装 (HelloServer.java)

クライアントアプリケーションの実装 (HelloClient.java)

「Hello World」の構築方法と実行方法

インタフェースの定義 (`Hello.idl`)

サーバーの実装 (`HelloServer.java`)

クライアントアプリケーションの実装 (`HelloClient.java`)