Java でのメッセージ処理ノードまたは出力ノードの作成

始める前に

WebSphere Message Broker では、SwitchNode および TransformNode という名前の 2 つのサンプル・ユーザー定義ノードのソースが準備されています。 これらのノードは現行の状態で使用することもできますし、変更を加えてもかまいません。

概念上、メッセージ処理ノードは何らかの形でメッセージを処理するために使用され、出力ノードはメッセージをビット・ストリームとして出力するために使用されます。 しかし、メッセージ処理ノードや出力ノードをコーディングするとき、 これらは基本的に同じものです。 出力ノードでメッセージ処理を実行することもできますし、同様に、メッセージ処理ノードを使用してメッセージをビット・ストリームとして出力することもできます。 単純化するため、 このトピックではメッセージ処理ノードとしてノードを主に参照していますが、 どちらのタイプのノードの機能についても取り上げます。

新規 Java プロジェクトの作成

ワークベンチ内から Java ノードを作成できます。 このためには、次のようにして新規 Java プロジェクトを作成する必要があります。
  1. Java パースペクティブに切り替えます。
  2. 「ファイル」>「新規」>「プロジェクト」をクリックします。 左方のメニューから「Java」を選択して、右方のメニューから「Java プロジェクト」を選択します。
  3. プロジェクトに名前を付けます。

    「Java 設定」パネルが表示されます。

  4. 「ライブラリー」タブを選択して、「外部 JAR の追加」をクリックします。
  5. install_dir¥classes¥jplugin2.jar を選択します。
  6. 「その他」タブのプロンプトに従って、他のビルド設定を定義します。
  7. 「完了」をクリックします。
このようにしたら、次はこのプロジェクトの中で Java ノードのソースを開発することができます。

メッセージ処理ノード・クラスの宣言

MbNodeInterface をインプリメントし、ブローカーの LIL パスに含められるクラスは、メッセージ処理ノードとしてブローカーに登録されます。 MbNodeInterface をインプリメントする際は、このクラスの evaluate メソッドもインプリメントする必要があります。evaluate メソッドは、 フローに渡される各メッセージごとに、ブローカーによって呼び出されます。

メッセージ処理ノード・クラスを宣言するには、例えば次のようにします。
package com.ibm.jplugins;

import com.ibm.broker.plugin.*;

public class BasicNode extends MbNode implements MbNodeInterface
次のようにして、ワークベンチで実行できます。
  1. 「ファイル」>「新規」>「クラス」をクリックします。
  2. パッケージおよびクラス名フィールドに適切な値を設定します。
  3. 「スーパークラス」テキスト・フィールドのテキストを削除し、「ブラウズ」をクリックします。
  4. MbNode を選択して、「OK」をクリックします。
  5. 「インターフェース」テキスト・フィールドの横にある「追加」ボタンをクリックして、MbNodeInterface を選択します。
  6. 「完了」をクリックします。

ノードのコンストラクターの定義

ノードがインスタンス化されるときは、 ユーザーのノード・クラスのコンストラクターが呼び出されます。 これは、ノードのターミナルを作成し、属性のデフォルト値を初期設定する場所です。

メッセージ処理ノードには、 いくつかの入力ターミナルと出力ターミナルが関連付けられています。 メソッド createInputTerminal および createOutputTerminal は、 ノードがインスタンス化される時にノードにターミナルを追加するために使用されます。 例えば、1 つの入力ターミナルと 2 つの出力ターミナルを持つノードを作成するには、 次のようにします。

public MyNode() throws MbException
{
// create terminals here
createInputTerminal ("in");
createOutputTerminal ("out");
createOutputTerminal ("failure");
}

メッセージ・データへのアクセス

多くの場合、ユーザー定義ノードは、 その入力ターミナルで受け取ったメッセージの内容にアクセスする必要があります。 メッセージは、構文エレメントのツリーとして表されます。 ユーティリティー関数のグループが evaluate メソッドでの使用のために提供され、メッセージ管理、メッセージ・バッファー・アクセス、構文エレメント・ナビゲーション、および構文エレメント・アクセスのために使用されます。

MbElement クラスには、構文エレメントへのインターフェースがあります。 Java API の詳細については、Javadoc を参照してください。

以下に例を示します。

  1. XML メッセージの中の関係のある構文エレメントにナビゲートするには、次のようにします。
        MbElement rootElement = assembly.getMessage().getRootElement();
        MbElement switchElement =
    rootElement.getLastChild().getFirstChild().getFirstChild();
  2. このエレメントの値で示されたターミナルを選択するには、次のようにします。
        String terminalName;
        String elementValue = (String)switchElement.getValue();
        if(elementValue.equals("add"))
          terminalName = "add";
        else if(elementValue.equals("change"))
          terminalName = "change";
        else if(elementValue.equals("delete"))
          terminalName = "delete";
        else if(elementValue.equals("hold"))
          terminalName = "hold";
        else
          terminalName = "failure";
        
        MbOutputTerminal out = getOutputTerminal(terminalName);

メッセージ・オブジェクトの変換

受信した入力メッセージは読み取り専用です。 したがって、メッセージを変換するには、まずそれを新しい出力メッセージに書き込む必要があります。 入力メッセージからエレメントをコピーするか、出力メッセージで新しいエレメントを作成できます。 新しいエレメントは通常はパーサーのドメインに入ります。

MbMessage クラスには、コピー・コンストラクターと、 メッセージのルート・エレメントを取得するメソッドがあります。 MbElement クラスには、構文エレメントへのインターフェースがあります。

例えば、組み込みメッセージを含む着信メッセージ・アセンブリーがある場合は、ユーザー定義ノードの evaluate メソッドに次のコードを含めることができます。
  1. メッセージ・アセンブリーとその組み込みメッセージの新しいコピーを作成します。
        MbMessage newMsg = new MbMessage(assembly.getMessage());
        MbMessageAssembly newAssembly = new MbMessageAssembly(assembly, newMsg);
  2. XML メッセージの中の関係のある構文エレメントにナビゲートするには、次のようにします。
        MbElement rootElement = newAssembly.getMessage().getRootElement();
        MbElement switchElement =
    rootElement.getFirstElementByPath("/XML/data/action");
  3. To change the value of an existing element:
      String elementValue = (String)switchElement.getValue();
        if(elementValue.equals("add"))
          switchElement.setValue("change");
        else if(elementValue.equals("change"))
          switchElement.setValue("delete");
        else if(elementValue.equals("delete"))
          switchElement.setValue("hold");
        else
          switchElement.setValue("failure");
  4. 切り替えタグの子として新しいタグを追加します。
        MbElement tag = switchElement.createElementAsLastChild(MbElement.TYPE_NAME,
                                                               "PreviousValue",
                                                               elementValue);
  5. この新しいタグに属性を追加します。
        tag.createElementAsFirstChild(MbElement.TYPE_NAME_VALUE,
                                      "NewValue",
                                      switchElement.getValue());
    
        MbOutputTerminal out = getOutputTerminal("out");
変換の一部として、新規メッセージ本体を作成する必要があるかもしれません。 新規メッセージ本体を作成するために、以下のメソッドが使用可能です。
createElementAfter(String)
createElementAsFirstChild(String)
createElementAsLastChild(String)
createElementBefore(String)
createElementAsLastChildFromBitstream(byte[], String, String, String, String, int, int, int)
これらのメソッドは、パーサーをメッセージ・ツリー・フォルダーに割り当てるための固有のものであるため、使用する必要があります。
以下のメソッドは、所有パーサーをフォルダーに関連付けないため、メッセージ本体を作成する時、これらを使用しないでください。
createElementAfter(int)
createElementAfter(int, String, Object)
createElementAsFirstChild(int)
createElementAsFirstChild(int, String, Object)
createElementAsLastChild(int)
createElementAsLastChild(int, String, Object)
createElementBefore(int)
createElementBefore(int, String, Object)

メッセージの伝搬

メッセージを伝搬する前に、何のメッセージ・フロー・データを伝搬するか、 また、どのノードのターミナルでデータを受信するかを決定する必要があります。

例えば、次のようにします。
  1. 出力ターミナル "out" にメッセージを伝搬するには、次のようにします。
    MbOutputTerminal out = getOutputTerminal("out");
            out.propagate(newAssembly);

メッセージ・ツリー用に割り振られているメモリーをクリアするには、最後の try/catch ブロック内で clearMessage() 関数を呼び出します。

ノード名の宣言

ノードの名前を宣言して、ノードがワークベンチに識別されるようにする必要があります。 すべてのノード名は末尾が "Node" でなければなりません。 名前は以下のメソッドを使用して宣言します。

public static String getNodeName()
{
      return "BasicNode";
}
このメソッドが宣言されていない場合は、 Java API フレームワークが以下の規則に従ってデフォルトのノード名を作成します。
  • パッケージ名にはクラス名が付加されます。
  • ドットは除去され、 パッケージ名とクラス名の各部の最初の文字が大文字になります。
例えば、 デフォルトでは以下のクラスにノード名 "ComIbmPluginsamplesBasicNode" が割り当てられます。
package com.ibm.pluginsamples;
public class BasicNode extends MbNode implements MbNodeInterface
{
   ...

属性の宣言

ノード属性は、Java Bean プロパティーと同じ方法で宣言します。 属性の getter メソッドおよび setter メソッドはユーザーが作成しなければなりません。 API フレームワークは、Java Bean 内視規則を使用して属性名を推測します。 例えば、以下の 2 つのメソッドを宣言するには、次のようにします。

private String attributeVariable;

public String getFirstAttribute()
{
    return attributeVariable;
}

publc void setFirstAttribute(String value)
{
    attributeVariable = value;
}

ブローカーは、このノードが firstAttribute という属性を持つことを推測します。 この名前は、内部クラス・メンバー変数名ではなく、get または set メソッドの名前に由来します。 属性はストリングとしてしか公開できないので、 get または set メソッドで、数値タイプとストリングの変換を行う必要があります。 例えば、次のメソッドは timeInSeconds という属性を定義します。

int seconds;

public String getTimeInSeconds()
{
  return Integer.toString(seconds);
}

public void setTimeInSeconds(String value)
{
  seconds = Integer.parseInt(value);
}

ノード機能のインプリメント

先に述べたとおり、 メッセージ処理ノードまたは出力ノードの場合、 MbNodeInterface で定義されている、 evaluate メソッドをインプリメントする必要があります。 これは、メッセージを処理するためにブローカーによって呼び出されます。 このメソッドは、ノード用のすべての処理関数を提供します。

evaluate メソッドには、ブローカーによって渡される以下の 2 つのパラメーターがあります。
  1. MbMessageAssembly。 これには、適切なメソッドを使用してアクセスできる以下のオブジェクトが含まれています。
    • 着信メッセージ
    • ローカル環境
    • グローバル環境
    • 例外リスト
  2. メッセージが着信した入力ターミナル。
例えば、次のコードの抜粋は、evaluate メソッドをどのように書き表せばよいかを示しています。
public void evaluate(MbMessageAssembly assembly, MbInputTerminal inTerm) throws MbException
  {
    // add message processing code here

    getOutputTerminal("out").propagate(assembly);
  }

メッセージ・フロー・データ (メッセージ、グローバル環境、ローカル環境、および例外リスト) が、 ノードの入力ターミナルで受信されます。

ノードのインスタンスの削除

ノードのインスタンスは、次のいずれかの場合に削除します。
  • ブローカーがシャットダウンされた。
  • ノードまたはノードを含むメッセージ・フローを除去し、 構成を再デプロイした。
ノードの削除中は、 ノードがソケットの終了などの終結処理操作を実行できるよう、 ノードに情報が通知されるようにする必要がある場合があります。 ノードがオプションの onDelete メソッドをインプリメントしていれば、 ノードが削除される前にこれがブローカーによって呼び出されます。

onDelete メソッドは次のようにしてインプリメントします。

public void onDelete()
{
    // perform node cleanup if necessary
}
関連資料
例外リスト構造
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック
Copyright IBM Corporation 1999, 2006 最終更新: 08/21/2006
as09970_