WSDL の生成
Related information
サポートされている標準
TIBCO EBX®は、W3C Webサービス記述言語 1.1 標準に準拠する WSDL を生成します。
操作の種類
WSDL は、さまざまな種類の操作に対して生成できます。
|
操作の種類
|
WSDL の説明
|
|---|---|
custom
|
EBX® アドオンの WSDL。
|
dataset
|
データセットおよびレプリケーション操作用の WSDL。
|
directory
|
デフォルト EBX® ディレクトリ操作用の WSDL。 tablePaths または operations パラメーターを使用してデータをフィルタリングすることもできます。
|
repository
|
データスペースまたはスナップショット管理操作用の WSDL。
|
tables
|
特定のデータセットのテーブルに対する操作の WSDL。
|
userInterface
|
バージョン 5.8.1 以降非推奨。この操作タイプは、
administration に置き換えられました。下位互換性の理由から、ユーザーインターフェイス管理操作は引き続き使用できますが、このタイプは使用しないことをお勧めします。
ユーザーインターフェイス管理操作用の WSDL (これらの操作には管理者のみがアクセスできます)。
|
administration
|
次のような管理操作用の WSDL
これらの操作には、管理者のみがアクセスできます。
|
workflow
|
EBX® ワークフロー管理操作用の WSDL。
|
WSDL のダウンロード方法
EBX® は次の方法をサポートしています。
-
ユーザーインターフェイスから
-
HTTP プロトコルから
WSDL は、許可されたプロファイルによってのみダウンロードできます。
|
操作の種類
|
アクセス権限
|
|---|---|
custom
|
少なくとも 1 つの Web サービスが登録されている場合は、すべてのプロファイル。
|
dataset
|
すべてのプロファイル。
|
directory
|
次の条件が有効な場合のすべてのプロファイル
|
repository
|
すべてのプロファイル。
|
tables
|
すべてのプロファイル。
|
userInterface
|
バージョン 5.8.1 以降非推奨。この操作タイプは、
administration に置き換えられました。下位互換性の理由から、ユーザーインターフェイス管理操作は引き続き使用できますが、このタイプは使用しないことをお勧めします。
すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル
|
administration
|
すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル
|
workflow
|
すべてのプロファイル。
|
ユーザーインターフェイスからの WSDL のダウンロード
許可されたユーザーは、データサービス管理領域から EBX® WSDL をダウンロードできます。
注意:
詳細については、『ユーザーガイドの』データスペース操作用の WSDL の生成を参照してください。
HTTP プロトコルからの WSDL ダウンロード
アプリケーションは、
GET または POST HTTPメソッドを使用して、EBX® WSDL をダウンロードできます。アプリケーションは、適切な権限を持つプロファイルを使用して認証される必要があります。
URL フォーマット
http[s]://<host>[:<port>]/<ebx-dataservices>/{type}[/{dataspace}[/{dataset}]]?{queryParameters}
説明
-
<ebx-dataservices>は、'ebx-dataservices.war' Web アプリケーションのパスに対応します。このパスは、複数の URI セグメント (またはなし) と Web アプリケーションの名前の順序で構成されます。 -
{type}は、操作タイプに対応します。 -
{dataspace}は、データスペースまたはスナップショット識別子に対応します。 -
{dataset}は、データセット名に対応します。 -
{queryParameters}は、URL で渡される共通または専用の操作パラメーターに対応します。
パラメーター
リクエストパラメーターは、次のいずれかの方法で指定できます。
-
URL からのパスセグメントに対応する
PathParam(推奨) -
値を持つ標準の HTTP パラメーターに対応する
QueryParam
|
パラメーター名
|
PathParam
|
QueryParam
|
必須
|
説明
|
|---|---|---|---|---|
WSDL
|
いいえ
|
はい
|
はい
|
WSDL のダウンロード操作を指定します。
空の値。
|
login
|
いいえ
|
はい
|
いいえ
|
ユーザー ID を指定します。
標準の認証方法を使用する場合に必要です。
文字列型の値。
|
password
|
いいえ
|
はい
|
いいえ
|
ユーザーパスワードを指定します。
標準の認証方法を使用する場合に必要です。
文字列型の値。
|
type
|
はい
|
いいえ
|
はい
|
操作タイプを指定します。
custom、dataset、directory、administration、userInterface、repository、tables、workflow のいずれかの値を指定します。
文字列型の値。
|
branch
version
|
はい
|
はい
|
(*)
|
データスペースまたはスナップショット識別子を指定します。
(*)
tables および dataset タイプに必要です。それ以外の場合は無視されます。
文字列型の値。
|
instance
|
はい
|
はい
|
(*)
|
データセット名を指定します。
文字列型の値。
|
tablePaths
|
いいえ
|
はい
|
いいえ
|
テーブルパスのリストを指定します。
tables または directory タイプの場合はオプション。それ以外の場合は無視されます。
定義されていない場合、すべてのテーブルが選択されます。
各テーブルパスはカンマで区切られます。
文字列型の値。
|
operations
|
いいえ
|
はい
|
いいえ
|
操作のサブセットの WSDL を生成できます。
tables または directory の操作タイプではオプションです。それ以外の場合は無視されます。定義されていない場合、指定されたタイプのすべての操作が生成されます。
このパラメーターの値は、次の 1 つ以上の文字を連結したものです。
文字列型の値。
|
namespaceURI
|
はい
|
はい
|
(**)
|
カスタム Web サービスの一意の名前空間 URI を指定します。
(**)
type パラメーターが custom に設定されている場合は必須であり、それ以外の場合は無視されます。
URI タイプの値。
|
attachmentFilename
|
いいえ
|
はい
|
(***)
|
添付ファイル名を指定します。
(***)
isContentInAttachment パラメーターが定義され、true に設定されている場合はオプション、それ以外の場合は無視されます。
文字列型の値。
|
isContentInAttachment
|
いいえ
|
はい
|
いいえ
|
WSDL を添付ファイルとしてダウンロードするかどうかを指定します。
ブール値型の値。
デフォルト値は false です。
|
targetNamespace
|
いいえ
|
はい
|
いいえ
|
WSDL のターゲット名前空間 URI をオーバーライドします。
URI タイプの値。
デフォルト値は urn:ebx:ebx-dataservices です。
|
メッセージ本文
メッセージ本文は必要ありません。
HTTP コード
HTTP コードが常に返されます。エラーは 400 を超えるコードで示されます。
|
ステータスコード
|
情報
|
|---|---|
200 (OK)
|
WSDL コンテンツは正常に生成され、リクエストによって返されます (オプションで添付ファイル)。
|
400 (Bad request)
|
リクエストが正しくありません。これは次の場合に発生します。
|
401 (Unauthorized)
|
リクエストには認証されたユーザーが必要です。
|
403 (Forbidden)
|
認証されたユーザーに対する要求は許可されていません。
|
405 (メソッドは許可されていません)
|
この構成ではリクエストは許可されていません。
|
500 (Internal error)
|
リクエストはエラーを生成します (スタックトレースと詳細なエラーメッセージが返されます)。
|
応答本文
応答本文は、返されたステータスコードと要求された WSDL コンテンツによって異なります。
-
200(OK) ：HTTP ヘッダーContent-Typeがtext/xml;charset=UTF-8に設定されています。コンテンツが添付ファイルの場合、HTTP ヘッダーContent-Dispositionはattachment; filename*=UTF-8''<filename.wsdl>に設定されます。 -
4xx：詳細なメッセージが本文に返されます。HTTPヘッダーContent-Typeはtext/html;charset=utf-8に設定されます。
HTTP の例
次の例の一部は、
PathParam と QueryParam の 2 つのメソッドで表示されます。
-
WSDL には、標準の認証方法を使用したすべてのリポジトリ操作が含まれます。
http[s]://<host>[:<port>]/<ebx-dataservices>/repository?WSDL&login=<login>&password=<password> -
WSDL には、すべてのワークフロー操作が含まれます。
http[s]://<host>[:<port>]/<ebx-dataservices>/workflow?WSDL -
WSDL には、
'dataspace1'データスペース内の'dataset1'データセットのすべてのテーブル操作が含まれます。PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDLQueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=<dataspace1>&instance=<dataset1> -
WSDL には、
'dataspace1'データスペースの'dataset1'データセットに対して選択された 2 つのテーブル操作が含まれます。PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDL&operations=RQueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=dataspace1&instance=dataset1&operations=R -
WSDL には、
'dataspace1'データスペースの'dataset1'データセットに対して選択された 2 つのテーブル操作が含まれます。PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDL&tablePaths=/root/table1,/root/table2QueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=dataspace1&instance=dataset1&tablePaths=/root/table1,/root/table2 -
WSDL には、専用 URI のカスタム Web サービス操作が含まれます。
PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/custom/urn:ebx-test:com.orchestranetworks.dataservices.WSDemo?WSDLQueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/custom?WSDL&namespaceURI=urn:ebx-test:com.orchestranetworks.dataservices.WSDemo