166 UTL_DBWS

UTL_DBWSパッケージは、データベースWebサービスを提供します。

この章では、次の項目について説明します。

UTL_DBWSの使用方法
- 標準のコール・プロパティでサポートされるキーおよびデフォルト設定
UTL_DBWSサブプログラムの要約

UTL_DBWSの使用方法

標準のコール・プロパティでサポートされるキーおよびデフォルト設定

標準のコール・プロパティでサポートされるキーおよびデフォルト設定

表166-1 標準のコール・プロパティでサポートされるキーおよびデフォルト設定

キー	値の説明およびデフォルト値
`USERNAME`	認証に使用するユーザー名。
`PASSWORD`	認証に使用するパスワード。
`ENCODINGSTYLE_URI`	ネームスペースURIとして指定するエンコーディング・スタイル。デフォルト値はSOAP 1.1エンコーディングです。http://schemas.xmlsoap.org/soap/encoding/を参照してください。
`OPERATION_STYLE`	操作スタイルの標準プロパティ。操作スタイルがRPCであれば'`RPC`'に、ドキュメントであれば'`DOCUMENT`'に設定します。
`SESSION_MAINTAIN`	サービス・エンドポイントのあるセッションに参加するかどうかを示すためにサービス・クライアントが使用するブール型プロパティ。'`TRUE`'に設定すると、サービス・クライアントはセッションの維持を希望することになります。'`FALSE`'に設定されると、セッションは維持されません。このプロパティのデフォルト値は'`FALSE`'です。
`SOAPACTION_USE`	SOAPActionを使用するかどうかを示すブール型プロパティ。このプロパティのデフォルト値は'`FALSE`'です。
`SOAPACTION_URI`	`SOAPACTION_USE`プロパティを'`TRUE'`に設定した場合はSOAPAction URIを示します。

UTL_DBWSサブプログラムの要約

表166-2 UTL_DBWSサブプログラム

サブプログラム	説明
CREATE_CALLファンクション	コール・インスタンスを作成します。
CREATE_SERVICEファンクション	サービス・インスタンスを作成します。
GET_IN_PARAMETER_TYPESファンクション	戻されるコールのXMLタイプの入力パラメータをリストします。
GET_OUT_PARAMETER_TYPESファンクション	戻されるコールのXMLタイプの出力パラメータをリストします。
GET_OUTPUT_VALUESファンクション	コール起動後の出力引数を取得します。
GET_PORTSファンクション	サービスにおけるすべてのポートの修飾名をリストします。
GET_PROPERTYファンクション	コールの特定のプロパティの値を戻します。
GET_RETURN_TYPEファンクション	指定したコールによって戻されるXMLタイプをリストします。
GET_SERVICESファンクション	WDSLドキュメント内で定義されるサービスの修飾名をリストします。
INVOKEファンクション	同期式要求応答対話モードを使用する特定の操作を起動します。
RELEASE_ALL_SERVICESプロシージャ	すべてのサービス・インスタンスを解放します。
RELEASE_CALLプロシージャ	特定のコール・インスタンスを解放します。
RELEASE_SERVICEプロシージャ	特定のサービス・インスタンスを解放します。
REMOVE_PROPERTYプロシージャ	コールの特定のプロパティの値を消去します。
SET_PROPERTYプロシージャ	コールの特定のプロパティの値を設定します。

CREATE_CALLファンクション

このプロシージャは、コール・インスタンスを作成します。

構文

UTL_DBWS.CREATE_CALL (
   service_handle    SERVICE,
   port_name         QNAME,
   operation_name    QNAME)
 RETURN CALL;

パラメータ

表166-3 CREATE_CALLファンクションのパラメータ

パラメータ	説明
`service_handle`	コールするサービス・インスタンス。
`port_name`	ポートの修飾名。NULLに設定すると、1つ目のポートが使用されます。
`operation_name`	操作の修飾名。

戻り値

表166-4 CREATE_CALLの戻り値

パラメータ	説明
`CALL`	コール・インスタンスへのハンドルを戻します。

CREATE_SERVICEファンクション

このプロシージャは、サービス・インスタンスを作成します。

構文

UTL_DBWS.CREATE_SERVICE(
   wsdl_document_location  URITYPE,
   service_name            QNAME)
  RETURN SERVICE;

パラメータ

表166-5 CREATE_SERVICEファンクションのパラメータ

パラメータ	説明
`wsdl_document_location`	サービスに使用するWSDLドキュメントがある場所のURL。
`service_name`	サービスの修飾名。`NULL`に設定すると、1つ目のサービスが使用されます。

戻り値

表166-6 CREATE_SERVICEの戻り値

パラメータ	説明
`SERVICE`	サービス・インスタンスへのハンドルを戻します。

GET_IN_PARAMETER_TYPESファンクション

このプロシージャは、戻されるコールのXMLタイプの入力パラメータをリストします。

構文

UTL_DBWS.GET_IN_PARAMETER_TYPES(
   call_handle    CALL)
 RETURN QNAME_LIST;

パラメータ

表166-7 GET_IN_PARAMETER_TYPESファンクションのパラメータ

パラメータ	説明
`call_handle`	入力タイプを戻すサービス・インスタンス。

戻り値

表166-8 GET_IN_PARAMETER_TYPESファンクションの戻り値

パラメータ	説明
`QNAME_LIST`	戻されるコールのXMLタイプの入力パラメータのリスト。

GET_OUT_PARAMETER_TYPESファンクション

このプロシージャは、戻されるコールのXMLタイプの出力パラメータをリストします。

構文

UTL_DBWS.GET_OUT_PARAMETER_TYPES(
   call_handle    CALL)
 RETURN QNAME_LIST;

パラメータ

表166-9 GET_OUT_PARAMETER_TYPESファンクションのパラメータ

パラメータ	説明
`call_handle`	出力タイプを戻すサービス・インスタンス。

戻り値

表166-10 GET_OUT_PARAMETER_TYPESファンクションの戻り値

パラメータ	説明
`QNAME_LIST`	戻されるコールのXMLタイプの出力パラメータのリスト。

GET_OUTPUT_VALUESファンクション

このプロシージャは、コール起動後の出力引数を取得します。

構文

UTL_DBWS.GET_OUTPUT_VALUES(
   call_handle    CALL)
 RETURN ANYDATA_LIST;

パラメータ

表166-11 GET_OUTPUT_VALUESファンクションのパラメータ

パラメータ	説明
`call_handle`	コールのインスタンス。

戻り値

表166-12 GET_OUTPUT_VALUESファンクションの戻り値

パラメータ	説明
`ANYDATA_LIST`	出力引数を順番に戻します。

GET_PORTSファンクション

このプロシージャは、サービスにおけるすべてのポートの修飾名をリストします。

構文

UTL_DBWS.GET_PORTS(
   service_handle    SERVICE)
 RETURN QNAME_LIST;

パラメータ

表166-13 GET_PORTSファンクションのパラメータ

パラメータ	説明
`service_handle`	ポートを戻すサービス・インスタンス。

戻り値

表166-14 GET_PORTSファンクションの戻り値

パラメータ	説明
`QNAME_LIST`	サービスにおけるすべてのポートの修飾名のリストを戻します。

GET_PROPERTYファンクション

このプロシージャは、コールの特定のプロパティの値を戻します。

構文

UTL_DBWS.GET_PROPERTY(
   call_handle    CALL,
   key            VARCHAR2)
  RETURN value VARCHAR2;

パラメータ

表166-15 GET_PROPERTYファンクションのパラメータ

パラメータ	説明
`call_handle`	コールのインスタンス。
`key`	プロパティのキー（「UTL_DBWSの使用方法」を参照）。

戻り値

表166-16 GET_PROPERTYファンクションの戻り値

パラメータ	説明
`value`	コールの特定のプロパティの値を戻します。

GET_RETURN_TYPEファンクション

このプロシージャは、指定したコールによって戻されるXMLタイプをリストします。

構文

UTL_DBWS.GET_RETURN_TYPE (
   call_handle    CALL)
 RETURN QNAME;

パラメータ

表166-17 GET_RETURN_TYPEファンクションのパラメータ

パラメータ	説明
`call_handle`	戻り型を戻すサービス・インスタンス。

戻り値

表166-18 GET_RETURN_TYPEファンクションの戻り値

パラメータ	説明
`QNAME`	戻される型。

GET_SERVICESファンクション

このファンクションは、WDSLドキュメント内で定義されるサービスの修飾名をリストします。

構文

UTL_DBWS.GET_SERVICES(
   wsdl_document_location  URITYPE)
 RETURN QNAME_LIST;

パラメータ

表166-19 GET_SERVICESファンクションのパラメータ

パラメータ	説明
`wsdl_document_location`	戻り型を戻すサービス・インスタンス。

戻り値

表166-20 GET_SERVICESファンクションの戻り値

パラメータ	説明
`QNAME_LIST`	WSDLドキュメント内に定義されているサービスの修飾名のリスト。

INVOKEファンクション

このファンクションは、同期式要求応答対話モードを使用する特定の操作を起動します。

構文

UTL_DBWS.INVOKE(
   call_handle    CALL,
   input_params   ANYDATA_LIST)
 RETURN ANYDATA;

パラメータ

表166-21 INVOKEファンクションのパラメータ

パラメータ	説明
`call_handle`	戻り型を戻すサービス・インスタンス。
`input_params`	この起動に使用する入力パラメータ。

戻り値

表166-22 INVOKEファンクションの戻り値

パラメータ	説明
`ANYDATA`	戻り値または`NULL`を戻します。

RELEASE_ALL_SERVICESプロシージャ

このプロシージャは、すべてのサービス・インスタンスを解放します。

構文

UTL_DBWS.RELEASE_ALL_SERVICES;

RELEASE_CALLプロシージャ

このプロシージャは、特定のコール・インスタンスを解放します。

構文

UTL_DBWS.RELEASE_CALL(
   call_handle    CALL);

パラメータ

表166-23 RELEASE_CALLプロシージャのパラメータ

パラメータ	説明
`call_handle`	解放するコール・インスタンス。

RELEASE_SERVICEプロシージャ

このプロシージャは、特定のサービス・インスタンスを解放します。

構文

UTL_DBWS.RELEASE_SERVICE (
   service_handle     SERVICE);

パラメータ

表166-24 RELEASE_SERVICEプロシージャのパラメータ

パラメータ	説明
service_handle	解放するコール・インスタンス。

使用上の注意

このプロシージャは、指定したサービス・インスタンスに対して作成されているすべてのコール・インスタンスを暗黙的に解放します。

REMOVE_PROPERTYプロシージャ

このプロシージャは、コールの特定のプロパティの値を消去します。

構文

UTL_DBWS.REMOVE_PROPERTY(
   call_handle   CALL,
   key           VARCHAR2);

パラメータ

表166-25 REMOVE_PROPERTYプロシージャのパラメータ

パラメータ	説明
`call_handle`	コール・インスタンス。
`key`	プロパティのキー（「UTL_DBWSの使用方法」を参照）。

SET_PROPERTYプロシージャ

このプロシージャは、コールの特定のプロパティの値を設定します。

構文

UTL_DBWS.SET_PROPERTY(
   call_handle    CALL,
   key            VARCHAR2,
   value          VARCHAR2);

パラメータ

表166-26 SET_PROPERTYプロシージャのパラメータ

パラメータ	説明
`call_handle`	コールのインスタンス。
`key`	プロパティのキー（「UTL_DBWSの使用方法」を参照）。
`value`	プロパティの値。