転送 SDK のインタフェースおよびクラス

この章では、転送 SDK で提供されるクラスとインタフェースを示し、それらについて簡単に説明します。カスタム転送プロバイダの開発に必要なインタフェースについては、「転送プロバイダの開発」を参照してください。

はじめに

この章で説明されているクラスおよびインタフェースは、特に記載のない限り、BEA_HOME/lib/sb-kernel-api.jar にあります。

スキーマで生成されるインタフェース

インタフェースの多くは、XML スキーマコンパイラツールによって XML から生成されます。以下のインタフェースのソース (XML スキーマ) は、ファイル TransportCommon.xsd で提供されています。このファイルは、サービスエンドポイントのコンフィグレーション用の基本となるスキーマ定義ファイルです。このファイルは、BEA_HOME/ALSB_HOME/lib/sb-schemas.jar にあります。

ここで、BEA_HOME は Oracle Service Bus をインストールしたディレクトリです。

EndPointConfiguration - エンドポイントコンフィグレーションの基本型。エンドポイントは、メッセージの送信元または送信先となる Oracle Service Bus リソースです。EndPointConfiguration は、着信エンドポイントまたは発信エンドポイントのデプロイメントおよび操作に必要なパラメータ一式を示します。
RequestMetaDataXML - 着信要求または発信要求のメタデータの基本型。メタデータは、メッセージのペイロードに含まれず、個別に送信され、メッセージを処理するための「コンテキスト」として使用されます。メタデータとして送信できる情報の例には、Content-Type ヘッダ、セキュリティ情報、ロケール情報などがあります。
RequestHeadersXML - 一連の着信または発信要求ヘッダの基本型。
ResponseMetaDataXML - 着信メッセージまたは発信メッセージの応答メタデータの基本型。
ResponseHeadersXML - 一連の応答ヘッダの基本型。
TransportProviderConfiguration - このプロバイダが (a) エンドポイントのサービスの説明 (WSDL など) を生成するかどうか、(b) 着信 (プロキシ) エンドポイントをサポートするかどうか、または (c) 発信 (ビジネスサービス) エンドポイントをサポートするかどうかをコンフィグレーションできます。

汎用クラスおよびインタフェース

この節では、転送 SDK の汎用クラスおよびインタフェースについて簡単に説明します。

汎用クラスの概要

TransportManagerHelper クラス - クライアントが転送サブシステムに関する一部の一般的なタスクを実行できるようにするヘルパークラス。
ServiceInfo クラス - 転送のコンフィグレーションおよびバインディングタイプなどのサービスについての情報を示すラッパークラス。
TransportOptions クラス – メッセージの送受信に関するオプションを提供します。TransportOptions には、複数行セットアップおよび単一行使用の 2 つの使用スタイルがあります。
EndPointOperations クラス - さまざまなタイプの転送エンドポイントのライフサイクル関連のイベントについて説明します。このイベントによって、転送プロバイダへの通知を行います。ネストされたクラスには、CommonOperation、Create、Delete、EndPointOperationTypeEnum、Resume、Suspend、および Update があります。
Ref クラス - コンフィグレーションシステムで管理されるリソース、プロジェクトまたはフォルダをユニークに表します。このクラスは、BEA_HOME/modules/com.bea.common.configfwk_<version>.jar にあります。
TransportValidationContext クラス - エンドポイントコンフィグレーションの検証チェックを実装する際に使用できる情報を転送プロバイダに提供するコンテナ。
Diagnostics クラス - 特定のリソースに関連する Diagnostic エントリの集合が含まれます。このクラスは、BEA_HOME/modules/com.bea.common.configfwk_<version>.jar にあります。
Diagnostic クラス - リソースに関連する特定の検証メッセージを表します。Diagnostic オブジェクトは、リソースに変更があった際に実行される検証の結果として生成されます。このようなシステム内の変更は、変更されたリソース、および変更されたリソースに (過渡的に) 依存するその他のすべてのリソースの検証をトリガします。このクラスは、BEA_HOME/modules/com.bea.common.configfwk_<version>.jar にあります。
NonQualifiedEnvValue クラス – コンフィグレーションデータ内にある環境依存の値のインスタンスを表します。通常、環境依存の値は、あるドメインから別のドメインにコンフィグレーションが移動された場合に変わります。たとえば、サービスの URI は、テストドメインとプロダクションドメインで異なる場合があります。このクラスは、BEA_HOME/modules/com.bea.common.configfwk_<version>.jar にあります。

汎用インタフェースの概要

TransportManager インタフェース - さまざまな転送プロバイダの管理、エンドポイントの登録、制御、着信メッセージおよび発信メッセージの処理などを一元化するための主要ポイントを提供するシングルトンオブジェクト。
TransportProvider インタフェース - 転送プロトコル固有のコンフィグレーションおよび実行時プロパティの中心的な管理ポイントを表します。サポートされているプロトコルごとに、TransportProvider の単一のインスタンスが存在します。たとえば、HTTP 転送プロバイダや JMS 転送プロバイダに、それぞれ単一のインスタンスが存在します。
BindingTypeInfo インタフェース - サービスのバインディングの詳細について説明します。実装は、Oracle Service Bus の複数の内部構造を包むコンビニエンスラッパークラスです。転送プロバイダの必要に応じて他のメソッドを追加できます。
TransportWLSArtifactDeployer インタフェース - Oracle Service Bus のデプロイメントと共に、WLS 関連のアーティファクトをデプロイ、アンデプロイ、または変更する必要があるモジュール用のプラグインインタフェース。たとえば、場合によっては、サービスの作成に応じて WLS のキューをデプロイする必要があります。

ヒント :

詳細については、「TransportWLSArtifactDeployer の実装が適している場合」を参照してください。

SelfDescribedTransportProvider インタフェース – TransportProvider を拡張します。任意の転送エンドポイントからサービスのバインディングタイプについての説明を生成する転送プロバイダは、このインタフェースを実装する必要があります。この例としては、EJB 転送プロバイダがあります。
SelfDescribedBindingTypeInfo インタフェース - (EJB サービスなどの) 自己記述型のサービスの BindingTypeInfo インタフェースを拡張します。
WsdlDescription インタフェース - 登録されている Oracle Service Bus サービスに関連付けられている WADL について説明します。
ServiceTransportSender インタフェース - 転送エンドポイントに関連付けられている登録済みのサービスに発信メッセージを送信します。TransportProvider.sendMessageAsync() は、(TransportSender を拡張する) ServiceTransportSender のインスタンスを取得します。プロバイダは、このインスタンスから、発信要求のペイロードおよびメタデータを取得できます。
CredentialCallback インタフェース – 転送プロバイダは、Oracle Service Bus からこのコールバックインタフェースのインスタンスを取得します。転送プロバイダは、そのメソッドを呼び出して、発信認証に使用する資格を取得できます。
TransportEndPoint インタフェース - 転送エンドポイントは、サービスメッセージの送信元または送信先となる Oracle Service Bus のエンティティまたはリソースです。

Source および Transformer クラスとインタフェース

以下に、Source および Transformer の基本インタフェース、Oracle Service Bus で提供される具体的な Source、およびサポートクラスについて説明します。

Source および Transformer インタフェースの概要

Source インタフェース - 任意の形式のソースコンテンツを表します。Source は、Transformer インスタンスを介して他の Source に変換できます。Source は、少なくとも、このインスタンスで定義されている 2 つのメソッドを介して、バイトベースのストリームへの変換をネイティブにサポートする必要があります。Source では、シリアライゼーション中に文字セットエンコーディングなどのさまざまな TransformOptions を考慮することもできます。
SingleUseSource インタフェース - あるタイプの Source が 1 回に限り使用できることを示すマーカーインタフェース。Source がまだ「使用できる」(有効である) かどうかを判断するために使用できる 1 つのヘルパーメソッドも提供します。

Source インタフェースを実装する Source クラスを作成する場合、Oracle Service Bus は、最初から入力ストリームを取得するたびに複数回 getInputStream() メソッドを呼び出すことができます。Source クラスが SingleUseSource を実装する場合、Oracle Service Bus は、getInputStream() を 1 回だけ呼び出します。ただし、この場合、Oracle Service Bus は、メッセージ全体をメモリにバッファします。

Transformer インタフェース - あるタイプの Source を別のタイプに変換します。このインスタンスは、どのタイプのソース間で変換できるかを示します。サポートされる入力ソースおよび出力ソースによって示される完全な製品間トランスフォーメーションをサポートするには、トランスフォーマが必要です。つまり、トランスフォーマは、サポートされるすべての入力ソースを、サポートされるすべての出力ソースに変換できる必要があります。

Source および Transformer クラスの概要

StreamSource クラス - InputStream からコンテンツを読み込むバイトストリーム Source。バイトストリーム Source であるため、シリアライゼーションメソッドはトランスフォーメーションのオプションを考慮しません。

注意 : このストリームは InputStream によってバックアップされるため、このソースは 1 回のみ使用するソースとなります。両方のシリアライゼーションメソッドは、基底の同じ InputStream から取得され、そのコンテンツは 1 度使用すると、失われます。エラーが発生しないことを前提とした場合、プッシュベースの writeTo() メソッドによりすべてのデータが即時に使用されます。プルベースの getInputStream() は、実際に基底の InputStream を呼び出し元に直接提供します。

ByteArraySource クラス - バイト配列からコンテンツを読み込むバイトストリーム Source。バイトストリーム Source であるため、シリアライゼーションメソッドはトランスフォーメーションのオプションを考慮しません。
StringSource クラス - 単一の String によってバックアップされる Source。シリアライゼーションは、単に、文字セットエンコーディングが設定された文字データです。
XmlObjectSource クラス - Apache XBean の Source コンテンツは Apache XBean として表されます。XBean は、型付きであるため、SchemaType オブジェクトおよび関連する ClassLoader が付随する場合があります。ただし、これらはどちらも省略可能であり、XBean を型なしの XML にすることもできます。
DOMSource クラス - そのコンテンツが DOM ノードに由来する Source。参照されるノードは、独立した org.w3c.dom.Document である場合も、より大きなドキュメント内の内部ノードである場合もあります。
MFLSource クラス - MFL コンテンツを表します。MFL データは、基本的には、MFL 定義によって論理構造が指定されたバイナリデータです。CSV は MFL データの簡単な例ですが、構造は任意に複雑になる場合もあります。データの論理的表現およびメモリ内表現は、XML ドキュメントですが、シリアライズされた表現は構造化されていない生のバイナリデータです。
SAAJSource クラス - SAAJ SOAPMessage オブジェクトによってバックアップされる Source。通常、SAAJSource は、MessageContextSource および MimeSource との間で変換されます。
MimeSource クラス - ヘッダを持つ任意のコンテンツを示す Source。基本的に、これは MIME の部分を表す Source です。ヘッダは RFC822 に準拠する必要がありますが、Source は任意のタイプのソースでかまいません。この Source のシリアライゼーション形式は、完全準拠の MIME パッケージです。このソースは、Content-Transfer-Encoding にも対応しており、ヘッダがある場合、基底のコンテンツストリームを適切にエンコードします。これは、コンストラクタに提供されている Source が、まだエンコードされておらず、生の形式である必要があることを意味しています。
MessageContextSource クラス - すべてのメッセージコンテンツを示す Source。メッセージと添付の Source は、後で処理できるように型なしのままになっています。ただし、最終的に、添付ソースの多くはオブジェクトに変換され、メッセージソースの多くは、XmlObjectSource や StringSource などの特定の型付きのソースに変換されます。

注意 :

MessageContextSource のシリアライゼーション形式は、メッセージソースおよび添付ソースのネイティブのシリアライゼーションにかかわらず、MIME multipart/related パッケージです。ただし、シリアライズされたオブジェクトが複数回必要な場合は、Source を MimeSource に変換する方法が最適です。

TransformOptions クラス - 一連のトランスフォーメーションのオプションを表します。このクラスのインスタンスは、Transformer クラスと併せて使用され、入力ソースの出力ソースへの変換方法に影響を及ぼします (たとえば、SHIFT_JIS から EUC-JP への文字セットエンコーディングの変更など)。このクラスは、Source インタフェースの InputStream/OutputStream メソッドでも使用されます。これは、事実上この使用方法が、InputStream/OutputStream における Source とバイトレベルの表現との変換でもあるためです。

要求および応答メッセージのメタデータおよびヘッダの表現

この章では、要求メッセージおよび応答メッセージのメタデータ表現を処理するクラスおよびインタフェースを示します。「メッセージの処理」および「メッセージコンテンツの設計」も参照してください。

メッセージコンテンツの実行時表現

CoLocatedMessageContext 抽象クラス - 転送レイヤの代わりに Java メソッド呼び出しを実行するために、同じ場所に配置されている発信呼び出しの最適化を実装する転送プロバイダによって拡張される必要があります。実装の例については、com.bea.alsb.transports.sock.SocketCoLocatedMessageContext.java クラスを参照してください。このクラスは、「転送 SDK のインタフェースおよびクラス」で説明されているサンプルソケット転送に組み込まれています。「同じ場所に配置された呼び出し」も参照してください。
RequestHeaders 抽象クラス - 任意の着信要求メッセージまたは発信要求メッセージの、標準およびユーザ定義のヘッダのユニオンを表します。一連の標準ヘッダは、各転送プロバイダに固有です。これは、それぞれのバージョンの要求ヘッダを実装するために、各転送プロバイダによって拡張される必要のある抽象クラスです。
RequestMetaData<T extends RequestHeaders> 抽象クラス - 着信要求メッセージまたは発信要求メッセージのメタデータ情報 (ヘッダ、要求の文字セットエンコーディングなど) を表します。転送プロバイダは、転送プロバイダに応じたメタデータ情報を追加する、このクラスの拡張を提供します。たとえば、HTTP 転送プロバイダは、get/setQueryString() メソッド、get/setClientHost() メソッド、およびその他のメソッドを追加します。
ResponseHeaders 抽象クラス - 任意の着信応答メッセージまたは発信応答メッセージの、標準およびユーザ定義のヘッダのユニオンを表します。一連の標準ヘッダは、各転送プロバイダに固有です。これは、それぞれのバージョンの応答ヘッダを実装するために、各転送プロバイダによって拡張される必要のある抽象クラスです。
ResponseMetaData<T extends ResponseHeaders> 抽象クラス - 着信応答メッセージまたは発信応答メッセージのメタデータ情報 (ヘッダ、要求の文字セットエンコーディングなど) を表します。転送プロバイダは、転送プロバイダに応じたメタデータ情報を追加する、このクラスの拡張を提供します。たとえば、HTTP 転送プロバイダは、get/setHttpResponseCode() メソッドおよびその他のメソッドを追加します。

インタフェース

TransportMessageContext インタフェース - ほとんどのメッセージ指向ミドルウェア (MOM) 製品は、メッセージをヘッダとペイロードで構成される軽量エンティティとして処理します。ヘッダにはメッセージのルーティングおよび識別情報に使用されるフィールドが含まれ、ペイロードには送信中のアプリケーションデータが含まれます。通常、転送レベルのメッセージコンテキストは、メッセージ ID、RequestMetadata、要求ペイロード、ResponseMetaData、応答ペイロード、および関連プロパティで構成されます。
InboundTransportMessageContext インタフェース - 着信メッセージのメッセージコンテキストの抽象化を実装します。
OutboundTransportMessageContext インタフェース - 発信メッセージのメッセージコンテキストの抽象化を実装します。
ServiceTransportSender インタフェース - 登録済みのサービスに発信メッセージを送信します。サービスは、転送エンドポイントに関連付けられています。
TransportSendListener インタフェース - これは、発信転送に提供されるコールバックオブジェクトで、システムに応答処理を進めることができることを通知できるようにします。このコールバックオブジェクトは、要求メッセージとは別のスレッドで呼び出す必要があります。

ユーザインタフェースのコンフィグレーション

概要

各転送プロバイダは、永続化するサービスエンドポイント固有のコンフィグレーションプロパティのリストを決定できるため、ユーザが新しいサービスエンドポイントごとの転送固有のコンフィグレーションプロパティを入力できる、柔軟なユーザインタフェースが必要です。Oracle Service Bus のサービス定義ウィザードの一環としてユーザが入力する各転送プロバイダのプロパティを、エクスポーズできるようにする一連のクラスおよびインタフェースを以下に示します。

この節では、新しい転送のユーザインタフェースを開発するために必要なインタフェースおよびクラスを示します。

UI インタフェースの概要

TransportUIBinding インタフェース - サービスの定義、概要、および転送プロバイダ固有のエンドポイントのコンフィグレーションの検証で使用される、プロバイダ固有の UI ページを表示するオブジェクトを表します。
CustomHelpProvider インタフェース – Oracle Service Bus Console に追加する、カスタム転送などの機能の状況依存ヘルプを提供できます。実装の詳細については、「Oracle Service Bus Console でのカスタム転送のヘルプの提供」を参照してください。

UI クラスの概要

TransportUIContext クラス - 転送プロバイダ固有のユーザインタフェースのオプションを提供します。Oracle Service Bus Console によって各転送プロバイダに渡されます。
TransportUIGenericInfo クラス - Oracle Service Bus のサービス定義ウィザードでの、共通の転送ページの転送固有の UI 情報を保持します。
TransportUIFactory クラス - 転送の変更フィールドおよびフィールドに関連付けられているさまざまな Transport UI オブジェクトを作成するファクトリメソッドを提供します。これらのオブジェクト内の値にアクセスするためのヘルパーメソッドも提供します。
TransportEditField クラス - Oracle Service Bus Console のサービス登録ウィザードのプロバイダ固有の部分で、編集可能な単一の UI 要素を表します。
TransportViewField クラス - Oracle Service Bus Console のサービス登録ウィザードのサービスの概要ページのプロバイダ固有の部分で、読み込み専用の単一の UI 要素を表します。
TransportUIError クラス - Oracle Service Bus Console に検証エラーを返します。

転送 SDK ユーザーズ ガイド