XQuery の実装

Oracle Service Bus XQuery エンジンは、1 つの例外モジュールを除き、XQuery の World Wide Web (W3C) の仕様に記載されているすべての言語機能を完全にサポートしています。XQuery 1.0 および XPath 2.0 の関数と演算子の詳細 (2004 年 7 月 23 日に公開された W3C の作業草案) については、次の URL を参照してください。

Oracle Service Bus では、以下の XQuery 関数をサポートしています。

Oracle Data Service Integrator でサポートされる拡張関数

Oracle Service Bus は、以下の関数を除き、Oracle Data Service Integrator が提供するすべての拡張関数をサポートしています。

fn-bea:is-access-allowed
fn-bea:is-user-in-group
fn-bea:is-user-in-role
fn-bea:userid
fn-bea:async
fn-bea:timeout
fn-bea:get-property
fn-bea:execute-sql()

以下の関数は使用しないでください。他の言語機能で代用することをお勧めします。

Oracle Data Service Integrator のすべての拡張関数のリストと各関数の説明については、『XQuery 開発者ガイド』の「XQuery の実装」を参照してください。

Oracle Service Bus での拡張関数

Oracle Service Bus には、以下の XQuery 関数が用意されています。

fn-bea:lookupBasicCredentials

fn-bea:lookupBasicCredentials 関数は、指定されたサービスアカウントのユーザ名と暗号化されていないパスワードを返します。任意のタイプのサービスアカウントを指定できます (静的、パススルー、またはユーザマッピング)。詳細については、『Oracle Service Bus Console の使い方』の「サービスアカウント」を参照してください。

fn-bea:lookupBasicCredentials 関数は、カスタム転送ヘッダ、または SOAP エンベロープのアプリケーション固有の場所にあるユーザ名とパスワードのエンコードに使用する XQuery 関数の大規模なセットの一部として使用します。HTTP 認証ヘッダにユーザ名とパスワードだけを含める必要がある場合、または WS-Security ユーザ名トークンとしてユーザ名とパスワードだけを必要とする場合は、この関数を使用する必要はありません。Oracle Service Bus は事前にサービスアカウントからユーザ名とパスワードを取得し、必要に応じて HTTP 認証ヘッダにエンコードします (WS-Security ユーザ名トークンの場合も同様)。

fn-bea:lookupBasicCredentials( $service-account as xs:string ) as UsernamePasswordCredential

ここで、$service-account は、以下の形式のサービスアカウントのパスと名前です。

<UsernamePasswordCredential 
   xmlns="http://www.bea.com/wli/sb/services/security/config">
   <username>

name

</username>
   <password>

unencrypted-password

</password>
</UsernamePasswordCredential>

返された要素をユーザ定義の変数に保管し、必要なときにこの変数からユーザ名とパスワード値を取得できます。

たとえば、Oracle Service Bus プロジェクトには、myProject という名前が付けられます。myServiceAccount という名前の静的なサービスアカウントを、myFolder1/myFolder2 という名前のフォルダに作成します。サービスアカウントに、ユーザ名 pat とパスワード patspassword を保存します。

サービスアカウントのユーザ名とパスワードを取得するには、以下の関数を呼び出します。

<UsernamePasswordCredential 
   xmlns="http://www.bea.com/wli/sb/services/security/config">
   <username>pat</username>
   <password>patspassword</password>
</UsernamePasswordCredential>

fn-bea: uuid()

関数 fn-bea:uuid() は、汎用一意識別子を返します。関数には以下の署名が含まれます。

この関数をプロキシパイプラインで使用して、ユニークな識別子を生成できます。生成されたユニークな識別子を、要素として XML ドキュメントに挿入できます。システム変数にユニークな識別子は生成できません。これを、メッセージペイロードの変更に使用できます。

たとえば、トラッキング用にユニークな識別子を生成してメッセージに追加するとします。この関数を使用してユニークな識別子を生成できます。関数が返す文字列を SOAP ヘッダに追加できます。

fn-bea:execute-sql()

fn-bea:execute-sql() 関数を使用すると、Oracle Service Bus のメッセージフローで XQuery から低レベルのデータベースにアクセスできます。詳細については、「XQuery を使用したデータベースへのアクセス」を参照してください。クエリは、型付きデータを含むフラットな行要素のシーケンスを返します。

fn-bea:execute-sql( $datasource as xs:string, $rowElemName as xs:QName, $sql as xs:string, $param1, ..., $paramk) as element()*

$datasource はデータソースの JNDI 名。
$rowElemName は行要素の名前。$rowElemName を、結果の要素シーケンスの各要素に付ける QName として指定します。
$sql は SQL ステートメント。
$param1, ..., $paramk は 1 ～ k 個のパラメータ。
element()* は返された要素のシーケンスを表す。

戻り値は、型付きデータを含むフラットな行要素のシーケンスで、SQL/JDBC データモデルと XQuery データモデル間で値を自動的に変換します。サポート対象のデータベースについて XQuery エンジンが生成する、またはサポートするデータ型マッピングの詳細については、「XQuery-SQL マッピング参照」を参照してください。

Oracle Service Bus メッセージフローから fn-bea:execute-sql() 関数を実行する場合、返された要素をユーザ定義の変数に格納できます。

以下の例では、Oracle Service Bus での fn-bea:execute sql() 関数の使用方法について説明します。

例 1 : 動的ルーティングのデータベースからの URI の取得

Oracle Service Bus プロキシサービスでは、実行時のメッセージのルーティング (動的) 先である URI の仕様をサポートしています。詳細については、「動的ルーティングの使用」を参照してください。コードリスト 9-1 は、動的ルーティングシナリオでデータベースから URI を取得する fn-bea:execute-sql() 関数の使用例を示しています。

ds.myJDBCDataSource はデータソースの JNDI 名。
xs:string($body/m:Request/m:customer_pri/text()) は、要求メッセージを確認し、メッセージに customer_pri の値を含む customer_priority=? を生成する。
/TARGETSERVICE/text() は SQL ステートメントの結果に適用されるパス。返される要素の文字列 (CDATA) コンテンツを生成する。
<ctx:route><ctx:service> ... </ctx:service></ctx:route> は、動的ルーティングシナリオの XQuery ステートメントに必須の要素。
DISPATCH_MAPPING のテーブル定義を以下に示す。

create table DISPATCH_MAPPING

  customer_priority varchar2(256),

  targetService varchar2(256),

  soapPayload varchar2(1024)

);

コードリスト 9-2 に示すように、DISPATCH_MAPPING テーブルが設定されます。

プロキシサービスがコードリスト 9-3 の要求メッセージ (要求メッセージの <customer_pri> の値は 0001) を受信した結果として、コードリスト 9-1 の XQuery が実行された場合、動的ルーティングシナリオで返される URI は次のようになります。

例 2 : データベースからの XMLType データの取得

サポート対象のデータベースについて XQuery エンジンが生成する、またはサポートするデータ型マッピングの詳細については、「XQuery-SQL マッピング参照」を参照してください。SQL の XMLType カラムタイプはサポートされていません。ただし、XMLType オブジェクトの getStringVal() メソッドを使用して XMLType カラムのデータにアクセスし、文字列値に変換できます。

以下のシナリオでは、Oracle データベースの XMLType カラムからデータを選択する際に使用できる手順について説明します。

プロキシサービスのメッセージフローで割り当てアクションを使用して、次の XQuery の結果を変数 ($result) に割り当てます。

コードリスト 9-4 データベースからの XMLType データの取得

fn-bea:execute-sql(

    'ds.myJDBCDataSource',

    'Rec',

    'SELECT a.purchase_order.getStringVal() purchase_order from datatypes a'

ここで、

ds.myJDBCDataSource はデータソースの JNDI 名。
Rec は $rowElemName。したがって、Rec は結果の要素シーケンスの各要素に指定された QName です。
select a.purchase_order.getStringVal() ... は、文字列値に変換するために、XMLType オブジェクトの getStringVal() メソッドを使用する SQL ステートメント。
datatypes は、XML の値の読み込み元であるテーブル (この場合、datatypes テーブルには 1 つの行が含まれている)。

注意 : dataty.pes テーブルのテーブル定義を以下に示す。

create table datatypes

  purchase_order xmltype

);

次の置換アクションを使用して、$body のノードのコンテンツを (前の手順で $result に割り当てた) fn-bea:execute-sql() クエリの結果に置き換えます。

Replace [ node contents ] of [ undefined XPath ] in [ body ] with 
[ $result/purchase_order/text() ]

以下のサンプルコードは、置換後の $body を示します。

fn-bea:serialize()

XML ドキュメントを XML 要素としてではなく文字列として表す必要がある場合は、fn-bea:serialize() 関数を使用します。たとえば、EJB インタフェースを介して XML ドキュメントを交換する場合、EJB メソッドは引数を文字列として受け取ります。関数には以下の署名が含まれます。

ユーザーズ ガイド