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

このドキュメントは、インタフェースを定義する IDL (Interface Definiton Language) と、スタブおよびスケルトンを生成する Java IDL コンパイラを使い完全な CORBA (Common Object Request Broker Architecture) アプリケーションを作成する方法について、高レベルの概要を説明したものです。 このドキュメントでは、ImplBase 継承サーバ側モデルの使い方を説明します。

idlj コンパイラは POA 継承モデルに基づくサーバ側マッピングをデフォルトで生成します。 既存のアプリケーションとの互換性を保つため、idlj コンパイラに新しいフラグ -oldImplBase が追加されて、ImplBase 継承モデルに基づくサーバ側マッピングを作成することができます。 J2SE バージョン 1.3 以前で作成したサーバと接続する必要がある既存のアプリケーションは、MAKEFILE を更新してこのフラグが利用されるようにする必要があります。ただし、そのような要求がない新規アプリケーションではこうしたマッピングは作成しないことをお勧めします。

注: ImplBase は POA モデルがあるので推奨されませんが、バージョン 1.3 以前の J2SE で記述されたサーバと互換性を持つために提供されています。これは非標準モデルなので、これを使って新しいサーバを作成することはお勧めしません。

CORBA は IDL インタフェースを実装するサーバ側マッピングのうち、少なくとも次の 2 種類をサポートしています。

• 継承モデル

  継承モデルを使って、コンパイラが作成したスケルトンの拡張も行う実装クラスを使い IDL インタフェースの実装を行います。

  継承モデルには、次のものが含まれています。

  • OMG 標準の POA。My.idl 内で My インタフェースが定義されている場合は、idlj コンパイラで MyPOA.java というファイルが生成されます。 My に実装を提供する必要があり、MyPOA を継承している必要があります。MyPOA はストリームベースのスケルトンで、すべての POA サーバント実装の基底クラスになっている org.omg.PortableServer.Servant を拡張します。

  • ImplBase。My.idl 内で My インタフェースが定義されている場合は、_MyImplBase.java というファイルが生成されます。My に対してその実装を提供し、この実装は _MyImplBase から継承しなければなりません。

• 委譲モデル

  委譲モデルを使い、次の 2 つのクラスを使って IDL インタフェースを実装します。

  • IDL で生成された Tie クラス。コンパイラで生成されたスケルトンから継承されますが、呼び出しはすべて実装クラスに委譲されます。
  • IDL が生成したオペレーションインタフェース (HelloOperations など) を実装するクラスで、それは IDL 関数を定義します。

  委譲モデルは、Tie モデルや Tie Delegation モデルとしても知られています。 このモデルは POA または ImplBase コンパイラで作成されたスケルトンのどちらかを継承するので、このドキュメントでは POA/Tie または ImplBase/Tie モデルのように記述されます。

このチュートリアルでは、サーバ側実装の ImplBase 継承モデルを扱います。 このモデルを使って新規アプリケーションを作成することはできません。 他のサーバ側実装を使用するチュートリアルは、次のドキュメントを参照してください。

• Java IDL:「Hello World」の例

  このドキュメントは完全な CORBA アプリケーションの作成を説明したチュートリアルで、IDL を使ってインタフェースを定義し、Java IDL コンパイラを使って POA 継承モデルであるデフォルトの IDL-to-Java 言語マッピングを定義します。

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

  他の実装から継承しなければならない場合、標準の継承モデルではなく Tie 委譲モデルを使用することがあります。Java の場合は、インタフェースの継承の個数に制限はありませんが、クラスの継承に使用できるスロットは 1 つだけです。継承モデルを使用した場合は、そのスロットが占有されます。Tie モデルを使用した場合は、そのスロットが使用されず、ユーザが独自の目的で使用することができます。ただし、間接参照のレベルが 1 つ導入されるという欠点があります。つまり、メソッドを呼び出すときに余分なメソッド呼び出しが発生します。

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

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

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

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

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

Hello.idl

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

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

サーバの実装 (HelloServer.java)

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

HelloServer クラスにはサーバの main() メソッドが含まれます。この main() メソッドでは、次の処理を行います。

• ORB のインスタンスを生成し初期化する
• サーバントのインスタンス (1 つの CORBA Hello オブジェクトの実装) を生成し、それを ORB に伝える
• ネーミングコンテキストの CORBA オブジェクト参照を取得し、 新しい CORBA オブジェクトを登録する
• ルートのネーミングコンテキストを取得する
• 新しいオブジェクトを「Hello」という名前でネーミングコンテキストに登録する
• クライアントから新しいオブジェクトが呼び出されるのを待つ

注: ImplBase は POA モデルがあるので推奨されませんが、バージョン 1.3 以前の J2SE で記述されたサーバと互換性を持つために提供されています。 これは非標準モデルなので、これを使って新しいサーバを作成することはお勧めしません。

ImplBase サーバ側実装の HelloServer は、POA 実装の場合とは少し異なります。 ルート POA の参照を取得して POAManager を起動する POA ベースのサーバのセクションは必要ありません。次のようになります。

HelloServer.java

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

import java.util.Properties;

class HelloImpl extends _HelloImplBase{

  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);

      // create servant and register it with the ORB
      HelloImpl helloImpl = new HelloImpl();
      helloImpl.setORB(orb); 
	    
      // get the root naming context
      org.omg.CORBA.Object objRef = 
          orb.resolve_initial_references("NameService");
      NamingContext ncRef = NamingContextHelper.narrow(objRef);

      Hello href = HelloHelper.narrow(helloImpl);

      // bind the Object Reference in Naming
      NameComponent nc = new NameComponent("Hello", "");
      NameComponent path[] = {nc};
      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 ...");
	
  }
}
 

後述のアプリケーションクライアントの例はデフォルトのチュートリアルで示したものと似ていますが、この例では下位互換性を保つ新機能の Interoperable Naming Service は使用されていません。クライアントアプリケーションの例:

• 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{

  static Hello helloImpl;
  
  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");
      NamingContext ncRef = NamingContextHelper.narrow(objRef);
 
      // resolve the Object Reference in Naming
      NameComponent nc = new NameComponent("Hello", "");
      NameComponent path[] = {nc};
      Hello helloImpl = HelloHelper.narrow(ncRef.resolve(path));

      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 プログラムは単純ですが、このプログラムを通して、静的呼び出しを使用する CORBA プログラムの開発に必要な作業すべてを学び、経験できます。

この例ではネーミングサービスが必要です。ネーミングサービスとは、オブジェクト参照に名前をバインドして CORBA オブジェクトに命名することができる CORBA サービスです。ネームバインディングはネームサービスに格納され、クライアントは名前を与えて目的のオブジェクト参照を取得できます。 J2SE v.1.4 のネーミングサービスには 2 つのオプションがあります。一時ネーミングサービスである tnameserv、ブートストラップサービス、一時ネーミングサービス、持続ネーミングサービス、サーバマネージャを含むデーモンプロセスである orbd です。 この例では orbd を使用します。

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

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

1. Hello.idl ファイルが置かれているディレクトリに移動します。

2. IDL ファイルから IDL-to-Java コンパイラ idlj を使って、スタブとスケルトンを作成します。 この手順は、java/bin ディレクトリのパスを、実行パスに含めていることを前提にしています。

   注: ImplBase は POA モデルがあるので推奨されませんが、バージョン 1.3 以前の J2SE で記述されたサーバと互換性を持つために提供されています。 これは非標準モデルなので、これを使って新しいサーバを作成することはお勧めしません。
   

     idlj -fall -oldImplBase Hello.idl
   

   idlj コンパイラの -fall オプションを使って、クライアントとサーバ側のバインディングの両方を生成する必要があります。 このコマンド行でデフォルトのサーバ側バインディングが生成されます。これは POA プログラミングモデルであることを前提にしています。 -oldImplBase オプションは、デフォルトの POA 継承モデルサーバ側バインディングではなく ImplBase 継承モデルサーバ側バインディングを生成するよう、コンパイラに指示します。idlj オプションの詳細については、IDL-to-Java コンパイラのオプションを参照してください。

   idlj コンパイラでは多数のファイルが生成されます。 実際に生成されるファイルの数は、IDL ファイルのコンパイル時に選択されたオプションによって異なります。生成されたファイルには標準の機能があるので、プログラムを配置して実行するまでは無視してもかまいません。 Hello.idl の idlj コンパイラで、コマンド行の -fall オプションを使って生成されるファイルは次のとおりです。

   • _HelloImplBase.java

     この抽象クラスはサーバスケルトンで、サーバ用に基本的な CORBA 機能を提供します。このクラスで、InvokeHandler と Hello インタフェースが実装されます。 これは org.omg.CORBA.portable.ObjectImpl を継承します。 サーバクラス HelloImpl は _HelloImplBase を継承します。

   • _HelloStub.java

     このクラスはクライアントスタブで、クライアント用に基本的な CORBA 機能を提供します。これは org.omg.CORBA.portable.ObjectImpl を継承し、Hello.java インタフェースを実装します。

   • Hello.java

     このインタフェースには作成した IDL インタフェースの Java 版が含まれます。Hello.java インタフェースは標準的な CORBA オブジェクト機能を与える org.omg.CORBA.Object インタフェースを継承します。 また HelloOperations インタフェースと org.omg.CORBA.portable.IDLEntity も継承します。

   • HelloHelper.java

     このクラスは補助機能、特に CORBA オブジェクト参照を適切な型にキャストする narrow() メソッドを提供します。Helper クラスは CORBA ストリームへのデータ型の入出力と、Any のデータ型の挿入と抽出を扱います。Holder クラスは、Helper クラスのメソッドに入出力を委譲します。

   • HelloHolder.java

     この final クラスには、Hello 型のパブリックインスタンスメンバが入ります。 IDL 型のパラメータが out または inout であれば Holder クラスが使用されます。ここでは、org.omg.CORBA.portable.OutputStream および org.omg.CORBA.portable.InputStream 引数に対するオペレーションが規定されます。これらの引数は CORBA には存在しますが、Java のセマンティクスには簡単にマッピングできません。 Holder クラスは Helper クラスのメソッドに入出力を委譲します。Holder クラスは org.omg.CORBA.portable.Streamable を実装します。

   • HelloOperations.java

     このインタフェースには sayHello() メソッドと shutdown() メソッドが含まれます。 IDL-to-Java マッピングは、IDL インタフェースで定義されたオペレーションをすべてこのファイルに組み込み、スタブとスケルトンで共有します。

3. HelloApp ディレクトリにあるスタブとスケルトンも含め、.java ファイルをコンパイルします。 この手順は、java/bin ディレクトリが実行パスに含まれていることを前提にしています。

      javac *.java HelloApp/*.java
   

4. 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 プログラム」を参照してください。

5. 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 のようになります。

6. クライアントアプリケーションを実行します。

     java HelloClient -ORBInitialPort 1050 -ORBInitialHost localhost
   

   この例の -ORBInitialHost localhost は省略することができます。ネームサーバが Hello クライアントと同一ホスト上で動作しているからです。 ネームサーバが別のホストで動作している場合は、IDL ネームサーバが動作しているホストを -ORBInitialHost nameserverhost で指定します。

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

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

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