Java IDL: 「Hello World」の例

POA モデルと一時サーバ

このドキュメントは、インタフェースを定義する IDL (Interface Definiton Language) とスタブおよびスケルトンを生成する Java IDL コンパイラを使い、完全な CORBA (Common Object Request Broker Architecture) アプリケーションを作成する方法について、高レベルの概要を説明したものです。 開発プロセスと、IDL を使って CORBA アプリケーションを作成するチュートリアルの詳細は、「Java IDL 入門: 「Hello World」のチュートリアル」を参照してください。 また、Java プログラミング言語でインタフェースを定義して CORBA アプリケーションを作成することもできます。 この開発プロセスの詳細とチュートリアルについては、Java RMI-IIOP ドキュメントを参照してください。

J2SE 1.4 の新機能 - idlj コンパイラで生成したサーバ側実装は Portable Servant Inheritance Model で、POA モデルとも呼ばれます。 POA (ポータブルオブジェクトアダプタ) については「ポータブルオブジェクトアダプタ」で説明します。 このドキュメントでは idlj コンパイラのデフォルトの動作を使って作成したサンプルアプリケーションを扱い、POA サーバ側モデルを使用します。

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

このチュートリアルでは、サーバ側実装の POA 継承モデルを扱います。 他のサーバ側実装を使用するチュートリアルは、次のドキュメントを参照してください。

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

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

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

次のコードは OMG IDL で記述されたもので、CORBA オブジェクトの sayHello() オペレーションが文字列 (string) を返し shutdown() メソッドが ORB を停止させています。 OMG IDL の構文とセマンティクスの詳細は、OMG の Web サイトで CORBA Specification の第 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 は、IDL インタフェース Hello の実装です。つまり、Hello の各インスタンスは、 HelloImpl のインスタンスにより実装されます。 このサーバントは HelloPOA のサブクラスで、 例題 IDL から idlj コンパイラにより生成されます。 サーバントには、IDL のオペレーションごとに 1 つのメソッドが含まれます。 この例では sayHello() メソッドと shutdown() メソッドが含まれます。 サーバントメソッドは、 Java の通常のメソッドと変わりません。ORB 関連処理を行うコードは 引数や結果の整列化などを行い、 スケルトンで提供されます。

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

この例では、一時オブジェクトサーバの例を示します。 持続オブジェクトサーバを使用する「Hello World」プログラムの例については、「例 2: 持続性を備えた Hello World」を参照してください。 CORBA サーバの詳細については、「サーバの開発」を参照してください。

コードの詳細は、チュートリアルの「Java IDL 入門: Hello World サーバの開発」を参照してください。

HelloServer.java 

// 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; 
  }
    
  // implement sayHello() method
  public String sayHello() {
    return "¥nHello world !!¥n";
  }
    
  // implement shutdown() method
  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); 

      // get object reference from the servant
      org.omg.CORBA.Object ref = rootpoa.servant_to_reference(helloImpl);
      Hello href = HelloHelper.narrow(ref);
	  
      // get the root naming context
      // NameService invokes the name service
      org.omg.CORBA.Object objRef =
          orb.resolve_initial_references("NameService");
      // Use NamingContextExt which is part of the Interoperable
      // Naming Service (INS) 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)

このアプリケーションクライアントでは、次の処理を行います。

コードの詳細は、チュートリアルの「Java IDL 入門: クライアントアプリケーションの開発」を参照してください。

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");
        // 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";
        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 サービスです。 ネームバインディングはネームサービスに格納され、クライアントは名前を提供して目的のオブジェクト参照を取得できます。 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 ディレクトリのパスを、使用するパスに含めていることを前提にしています。 
      idlj -fall Hello.idl

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

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

    • HelloPOA.java

      この抽象クラスはストリームベースのサーバスケルトンで、サーバ用に基本的な CORBA 機能を提供します。 これは org.omg.PortableServer.Serva nt を継承し、InvokeHandler インタフェースと HelloOperations インタフェースを実装します。 サーバクラス HelloImpl は HelloPOA を継承します。

    • _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&

    Windows の MS-DOS システムプロンプトでは、次のように入力します。 

      start orbd -ORBInitialPort 1050

    1050 はネームサーバを実行するポートです。 -ORBInitialPort は必要なコマンド行の引数です。 Solaris ソフトウェアの使用時は、1024 より小さいポートでプロセスを開始する場合は、root ユーザになる必要があります。このため、1024 以上のポートを使用することをお勧めします。

    このプログラムを 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 台のマシンで簡単なアプリケーションを分散させる方法の一例を示します。

ホーム

Copyright © 1995-2001 Sun Microsystems, Inc. All Rights Reserved.