リファレンス・ガイド

「SALTデプロイメント・ファイルのリファレンス」

次の項では、SALTデプロイメント・ファイルのリファレンス情報について説明します。

概要

SALTデプロイメント・ファイル(SALTDEPLOY)は、XMLベースのファイルであり、SALT GWWSサーバー・デプロイメント情報をTuxedoマシンごとに定義するために使用されます。SALTDEPLOYは、次の処理を行います。

必要なすべてのWebサービス定義ファイル(WSDF)をリストします。
Tuxedoマシン上にデプロイされたGWWSサーバーの数を指定します。
GWWSサーバーごとに着信と発信Webサービス・アクセス・エンドポイントを関連付けます。

SALTDEPLOYには、グローバル・リソース(たとえば、証明書およびプラグイン・ロード・ライブラリなど)を設定するシステム・セクションがあります。

SALT SALTDEPLOYの形式

図B-1では、SALT SALTDEPLOYファイル書式のグラフィカルな表現を示します。

図B-1 SALTデプロイメント・ファイルの書式

XMLスキーマ

XMLスキーマはSALT SALTDEPLOYファイルに関連付けられています。SALT SALTDEPLOYファイルの書式を記述するXMLスキーマ・ファイルは、$TUXDIR/udataobj/salt/saltdep.xsdディレクトリにあります。

SALT SALTDEPLOYの例

SALT SALTDEPLOYの要素の説明

<デプロイメント>

SALT SALTDEPLOYの例

リストB-1に、SALT SALTDEPLOYファイルの例を示します。

リストB-1 SALT SALTDEPLOYファイルの例

<Deployment xmlns="http://www.bea.com/Tuxedo/SALTDEPLOY/2007">

  <WSDF>

    <Import location="/home/myapp/bankapp.wsdf" />

    <Import location="/home/myapp/amazon.wsdf" />

  </WSDF>

  <WSGateway>

    <GWInstance id="GW1">

      <Inbound>

        <Binding ref="bankapp:bankapp_binding">

          <Endpoint use="http1"/>

          <Endpoint use="https1" />

        </Binding>

      </Inbound>

      <Outbound>

        <Binding ref="amazon:default_binding"/>

      </Outbound>

      <Properties>

        <Property

         name="socksAddrList"

         value="proxy.server.com,10.123.10.10:1080"/>

      </Properties>

    </GWInstance>

  </WSGateway>

  <System>

    <Certificate>

      <PrivateKey>/home/user/cert.pem</PrivateKey>

    </Certificate>

    <Plugin>

      <Interface library="/home/user/mydatahandler.so" />

    </Plugin>

  </System>

</Deployment>

SALT SALTDEPLOYの要素の説明

次のセクションに、SALTDEPLOYF書式要素およびこれらの属性を一覧表示し説明します。

<Deployment>

SALTDEPLOYファイルのルート要素です。

この要素に対する属性はありません。

<Deployment>要素内で次の3つのセクションを定義する必要があります。

<WSDF>要素
<WSGateway>要素
<System>要素

SALTDEPLOYファイルには<Deployment>要素を1つのみ定義できます。

<WSDF>

すべてのインポートしたWSDFファイルをカプセル化する先頭の要素です。

この要素に対する属性はありません。

<Import>

SALTDEPLOYファイルにインポートするWSDFを指定します。複数のWSDFを同時にインポートできます。各WSDFファイルは一回だけインポートできます。同じWSDF名のある複数のWSDFは同じSALTDEPLOYファイルにインポートできません。

表B-1 <Import>属性
属性	説明	必須
`location`	`WSDF`のローカルのファイル・パスを指定します。	はい

<WSGateway>

すべてのGWWSインスタンス定義をカプセル化する先頭の要素です。

この要素に対する属性はありません。

<GWInstance>

単一のGWWSインスタンスを指定します。

表B-2 <GWInstance>属性
属性	説明	必須
`id`	GWWS識別子を指定します。この属性の値としては、最大で12文字列を入力できます(NULLで終わる文字列を除く)。識別子の値は、`SALTDEPLOY`ファイル内でユニークである必要があります。	はい

<Inbound>

GWWSサーバーに対する着信WSBindingオブジェクトを指定します。<Binding>サブ要素を使用して各着信WSBindingオブジェクトを指定します。

この要素に対する属性はありません。

<HTTP>

RESTモードでアクセス可能なサービスのリストを指定します。この要素で指定するすべてのOracle Tuxedoサービス名は、HTTPまたはRESTメカニズムを使用して呼び出されます。このリストにないサービスを指定したURLの呼出し結果は404エラーになります。このリストにあるサービスを指定したURL(Oracle Tuxedoサービスの通知対象でない)の呼出し結果は451エラーになります。

この要素に対する属性はありません。

<Network>

この要素には、httpまたはhttps (SSL用)、HTTP/RESTのリスニング・エンドポイントを指定する2つの属性が含まれています。GWWSインスタンスごとに許可される<Network>要素は1つのみです。httpおよびhttps要素はオプションですが、少なくとも1つ指定する必要があります。httpおよびhttps属性の構造を次に示します。

<host>: HTTP/RESTリスニング・エンドポイントの名前IPアドレスです。

<port>: HTTP/RESTリスニング・エンドポイントのポート値です。

すべてのHTTP/RESTリクエストは、同じ<host>:<port>の組合せで実行されます(プロトコル(httpおよびhttps)ごと、ゲートウェイごとにそのような組合せを複数使用できないため)。

表B-3 <Network>属性
属性	説明	必須
`http`	RESTリクエスト用のHTTPホストとポート・リスニング・エンドポイント形式は、次に対応する`<host>:<port>`のペアを含む文字列です。 `<host>` = `HTTP/REST`リスニング・エンドポイントの名前またはIPアドレス。 `<port>` = `HTTP/REST`リスニング・エンドポイントのポート値。	いいえ*
https	SSL HTTPホストおよびポート・リスニング・エンドポイントを指定します。 http属性と同じ形式です。	いいえ*

* 必須ではありませんが、<Network>要素にはhttpまたはhttps属性のいずれかが含まれている必要があります。

<Service>

HTTP/RESTメカニズムを使用して呼出し可能な単一のサービスを指定します。実際に呼び出されたOracle Tuxedoサービスは、さらに<Method>要素を使用して指定されるHTTPメソッドによって修飾されます。

属性

説明

必須

name

通知されているTuxedoサービスの名前。

注意: これは、 <Method>要素を使用して構成される実際のOracle Tuxedoサービスではありません。

はい

method

対応する'GET'、'DELETE'、'POST'、'PUT'の呼出しで使用されるHTTPメソッド。

outputbuffer

Tuxedoバッファ・タイプ/オプションでレスポンス・メッセージの変換に使用されるサブタイプ。値は既存のすべての既存のTuxedoバッファ・タイプと同じです。VIEW/VIEW32バッファ・タイプの場合は、注釈{VIEW|VIEW32}/<Subtype>を使用してサブタイプの概念が伝達されます。例: 'VIEW32/customer'。

address

アクセスしているHTTPサービスのURL。サポートされるスキームは'http'および'https'です。

content-type

JSONマッピングの場合は'JSON'、XMLマッピングの場合は'XML'。これはオプションであり、VIEW/VIEW32/X_C_TYPE/X_COMMONおよびFML/FML32のタイプ・バッファでのみ有効です。

<Method>

Oracle TuxedoサービスへのHTTPメソッド・マッピングを指定します。これは、CRUDメソッド(作成、読取り、更新、削除)をモデル化するために設計されています。

表B-5 <Service>属性
属性	説明	必須
`name`	メソッド識別子の`GET`、`PUT`、`POST`、`DELETE`。これ以外の値では構成エラーになります。	はい
service	マッピングされているOracle Tuxedoサービスの名前。	はい
inputbuffer	Oracle Tuxedoバッファ・タイプ/オプションで入力の変換に使用されるサブタイプ。値は既存のすべてのOracle Tuxedoバッファ・タイプと同じです。VIEW/VIEW32バッファ・タイプの場合は、注釈{VIEW\|VIEW32}/`<Subtype>`を使用してサブタイプの概念が伝達されます。例: VIEW32/`customer`。	はい
reposservice	メタデータ・リポジトリ・エントリへの参照です。これは、インタフェース・データと`HTTP/REST`サービスおよびメソッドと関連付けるために使用されます。構成ツールでサービス・メタデータ(インタフェース)に基づいた自動テスト・コードを生成する際にも使用されます。	いいえ

<Outbound>

GWWSサーバーに対する発信WSBindingオブジェクトを指定します。<Binding>サブ要素を使用して各発信WSBindingオブジェクトを指定します。

この要素に対する属性はありません。

<Binding>

親要素に応じて、着信バインディングまたは発信バインディングとして具体的なWSBindingオブジェクトを指定します。

表B-6 <Binding>属性
属性	説明	必須
ref	以下の修飾名の形式を使用して具体的なWSBindingオブジェクトを指定します。 `「<WSDF_name>:<WSBinding_id>」`	はい

注意:

GWWSサーバーごとに参照できる最大のWSBindingオブジェクトを以下に示します。

GWWSサーバーごとに最大で64着信WSBindingオブジェクトを参照できます。
GWWSサーバーごとに最大で128発信WSBindingオブジェクトを参照できます。

TCP/IPアドレスの場合、表B-7に示すように、次のいずれかの形式が使用されます。

表B-7 IPv4およびIPv6のアドレス形式
IPv4	IPv6
`//IP:port`	`//[IPv6 address]:port`
`//hostname:port_number`	`//hostname:port_number`
`//#.#.#.#:port_number`	`Hex format is not supported`

詳細は、Tuxedo 10g R3リファレンス・ガイドのセクション5 - 「ファイル形式、データ記述、MIBおよびシステム・プロセス・リファレンス」にあるTUXENV(5)環境変数リスト内のTMUSEIPV6を参照してください。

<Endpoint>

単一のWSBindingオブジェクトのエンドポイント・リファレンスを指定します。

参照したエンドポイントを着信エンドポイントとして指定すると、GWWSサーバーは対応するHTTPまたはHTTPSリスニング・エンドポイントを作成します。1つの着信WSBindingオブジェクトに対して少なくとも1つの着信エンドポイントを指定する必要があります。

参照したエンドポイントを発信エンドポイントとして指定すると、GWWSサーバーは発信WSBindingオブジェクトのSOAPリクエストごとにHTTPまたはHTTPSの接続を作成します。

発信WSBindingオブジェクトに対して発信エンドポイントを指定しない場合、最初の10エンドポイント(最大)が自動的に選択されます。

参照したエンドポイントはWSDFであらかじめ定義されている必要があります。

表B-8 <Endpoint>属性
属性	説明	必須
`use`	参照したエンドポイントIDは、WSDFで定義されます。	はい

注意:

GWWSサーバーごとに作成できる最大のエンドポイントを以下に示します。

SOAPリクエストを受け付けるためにすべての着信WSBindingオブジェクトでGWWSサーバーごとに最大で128着信エンドポイントを作成できます。
すべての発信WSBindingオブジェクトでGWWSサーバーごとに最大で256発信エンドポイントとの接続を作成できます。

<WSAddressing>

発信WSBindingオブジェクトに対してWS-Addressingを有効にするかどうかを指定します。

この要素が存在する場合、デフォルトでは、すべてのSOAPメッセージがWS-Addressingメッセージ・ヘッダーに送信されます。この要素が存在する場合、リスニング・エンドポイント・アドレスに対して<Endpoint>サブ要素を指定する必要があります。

この要素に対する属性はありません。

<Endpoint>

参照した発信WSBindingオブジェクトに対するWS-Addressingリスニング・エンドポイントのアドレスを指定します。

表B-9 <Endpoint>属性
属性	説明	必須
`address`	WS-Addressingリスニング・エンドポイントのアドレスを指定します。アドレス値は次の形式である必要があります。 "`http(s)://<host>:<port>/<context_path>`" GWWSサーバーは、リスニング・エンドポイントを作成し、WS-Addressing SOAPレスポンス・メッセージを受信します。	はい

<TLogDevice>

属性"location"は、トランザクション・ファイルの場所を示します。WS-TXトランザクション・サポートを必要とする場合は、これが必要です。

<TLogName>

属性"id"は、トランザクション・ファイル内のトランザクション・ログの名前を示します。WS-TXトランザクション・サポートを必要とする場合は、これが必要です。

<WSATEndpoint>

属性"address"は、WS-ATプロトコル・エンドポイントを示します。

<MaxTran>

属性"value"は、同時に実行できるWS-TXトランザクションの最大数を示します。これは、Oracle Tuxedo MAXGTTによってバインドされます。

<Properties>

<Property>サブ要素を使用してすべてのGWWSサーバーのプロパティ設定をカプセル化する先頭の要素です。

表B-10 <Properties>属性
属性	説明	必須
`socksAddrList`	必要に応じて、エンドポイントをGWInstanceでグループ化して、プロキシ使用のエンドポイントとプロキシ不使用のエンドポイント間を区切ることができます。値: プロキシ・サーバーのURLのリストが含まれる文字列タイプ。例: `proxy.server1.com,10.123.1.1:1080`	はい

<Property>

1つのGWWSプロパティを指定します。

表B-11 <Property>属性
属性	説明	必須
`name`	プロパティ名を指定します。表B-12では、すべてのGWWSサーバーのプロパティを示します。	はい
`value`	プロパティの値を指定します。	はい

プロパティ

説明

値

max_content_length

HTTPリクエストのコンテンツ長がプロパティ設定より長い場合にGWWSサーバーでリクエストの受け付けを拒否できます。指定しない場合、GWWSサーバーでコンテンツ長はチェックされません。値は以下3つの形式のいずれかに基づく文字列で指定します。

整数はバイトで表します。接尾辞なしの数値の場合、単位としてバイトを使用します。
浮動小数点数はキロバイトで表します。接尾辞として必ず「K」を付けます。たとえば、10.4K、40Kなど。
浮動小数点数はメガバイトで表します。接尾辞として必ず「M」を付けます。たとえば、100M、20.6Mなど。

指定値は、[1バイト、1Gバイト]の範囲にあるバイト・サイズ値に相当する必要があります。

thread_pool_size

GWWSサーバーに対する最大のスレッド・プール・サイズを指定します。

注意: この値にはGWWSサーバーで発生できる最大のスレッドを指定します。GWWSサーバーの実行中、実際に発生するスレッドは指定した値より小さい場合があります。

有効な値は[1、1024]の範囲にあります。

デフォルト値は16です。

timeout

ネットワークのタイムアウト値を秒の単位で指定します。

有効な値は[1、65535]の範囲にあります。

デフォルト値は300です。

max_backlog

バックログ・リスニング・ソケットの値を指定します。このプロパティは、オペレーティング・システムによる保留中の接続を保持するキューの最大長を制御するために使用します。

注意:

通常に、この値をチューニングする必要はありません。

有効な値は[1 - 255]の範囲にあります。

デフォルト値は16です。

enableMultiEncoding

GWWSサーバーの複数のエンコーディング・メッセージ・サポートをオン/オフに切り替えます。複数のエンコーディング・サポートのプロパティをオフにすると、GWWSサーバーはUTF-8 HTTP / SOAPメッセージのみを受け入れます。

有効な値は、「true」または「false」です。

デフォルト値はfalseです。

enableSOAPValidation

着信SOAPリクエスト・メッセージの対応するTuxedo入力バッファがカスタマイズしたXMLスキーマに関連付けられている場合、XMLスキーマ検証をオン/オフに切り替えます。

有効な値は、「true」または「false」です。

デフォルト値はfalseです。

<System>

証明書情報およびプラグイン・インタフェースなどグローバルな設定を指定します。

<Certificate>

サブ要素 <PrivateKey>、 <VerifyClient>、 <TrustedCert>、 <CertPath>を使用してグローバル証明書情報を指定します。

この要素に対する属性はありません。

注意: SEC_PRINCIPAL_PASSWORDが設定されている場合、GWWSは証明書をウォレットに変換します。HTTPのもとでX509証明書のみが使用されている場合、変換は行われません。

<PrivateKey>

Oracleウォレットを使用している場合、Oracleウォレットがあるディレクトリの場所を指定します。

注意:

SALTには、Oracle Tuxedoのようなセキュリティ・プリンシパル名の概念がないので、ウォレットは、指定されたディレクトリに置かれ、サブディレクトリには置かれません。

注意: サーバーID証明書(SALTデプロイ構成ファイルの<PrivateKey>要素)を構成するには、SSL構成ファイルにルート認証局が存在している必要があります。適切な構成は、

ルートCA証明書
中間証明書(存在する場合)
サーバー証明書
サーバーの秘密鍵
が、PEM形式で作成されている必要があります。

レガシー・セキュリティ資格証明形式を使用する場合は、PEM形式の秘密鍵ファイルを指定します。キー・ファイルのパスは、この要素に対するテキスト値として指定します。サーバー証明書もこの秘密鍵ファイル内に格納されます。この属性の値としては、最大で256文字列を入力できます(NULLで終わる文字列を除く)。

セキュリティ資格証明の形式がどちらであっても、OracleウォレットまたはGWWS秘密鍵ファイルのパスワードは、TUXCONFIGファイル内で、SEC_PRINCIPAL_PASSVAR="environment_variable_name"パラメータを使用して指定されます。TUXCONFIGファイルでは、SEC_PRINCIPAL_PASSVARが構成ファイルで正しく処理されるように、SEC_PRINCIPAL_NAME="any_non-null_string(not_used)"パラメータも設定する必要があります。

<Certificate>親要素を構成する場合、この要素は必須です。

<VerifyClient>

Webサービスのクライアントから証明書を送信する際にHTTP over SSL接続の使用を必須とするかどうかを指定します。要素の有効な値は「true」または「false」です。

この要素は省略可能です。指定しない場合、デフォルト値として「false」が使用されます。

<TrustedCert>

信頼されたPEM形式の証明書ファイルのファイル名を指定します。この属性の値としては、最大で256文字列を入力できます(NULLで終わる文字列を除く)。

この要素は省略可能です。

<CertPath>

信頼された証明書が格納されているローカル・ディレクトリを指定します。この属性の値としては、最大で256文字列を入力できます(NULLで終わる文字列を除く)。

この要素は省略可能です。

注意: <VerifyClient>が「true」に設定されている場合、またはWS-AddressingをSSLで使用する場合には、この要素で設定したディレクトリに信頼された証明書を格納する必要があります。

<Plugin>

グローバル・プラグイン・ロード・ライブラリの情報を指定します。<Interface>サブ要素ごとに、ロードする1つのプラグイン・ライブラリを指定します。

この要素に対する属性はありません。

<Interface>

ライブラリ内のすべてのプラグイン・インタフェースに対して特定のプラグイン・インタフェースまたはプラグイン・ライブラリを指定します。

表B-13 <Interface>属性
属性	説明	必須
`library`	必須。ローカル共有ライブラリ・ファイルのパスを指定します。この属性の値としては、最大で256文字列を入力できます(NULLで終わる文字列を除く)。	はい
`params`	オプション。起動時に`GWWS`サーバーにより初期化された場合、ライブラリに渡された特定の文字列値を指定します。この属性の値としては、最大で256文字列を入力できます(NULLで終わる文字列を除く)。	いいえ

注:	SALTプラグイン・インタフェースを開発する方法の詳細は、『SALTプログラミング・ガイド』のSALTプラグインの使用に関する項を参照してください。