183 DBMS_XDB_CONFIG

DBMS_XDB_CONFIGパッケージは、Oracle XML DBとそのリポジトリを構成するインタフェースを提供します。

DBMS_XDB_CONFIGの使用

概要
セキュリティ・モデル
定数

概要

PL/SQLパッケージDBMS_XDB_CONFIGは、DBAがシステムを構成するためのPL/SQL向けOracle XML DBリソースのアプリケーション・プログラム・インタフェース(API)です。このAPIは、PL/SQLを使用して、Oracle XML DBリポジトリ・リソースにアクセスして管理するためのファンクションとプロシージャを提供します。また、リソースのセキュリティおよびOracle XML DBの構成の管理方法も説明します。

Oracle XML DBリポジトリはXMLでモデル化されており、すべてのデータに対するデータベース・ファイル・システムを提供します。リポジトリは、XMLTypeのデータベース・オブジェクトにパス名(またはURL)をマップし、これらのオブジェクトの管理機能を提供します。

PL/SQLパッケージDBMS_XDB_CONFIGは、次のすべての管理に使用できるAPIです。

Oracle XML DBリソース
Oracle XML DBセキュリティは、アクセス制御リスト(ACL)に基づいています。ACLは、どのリソースへのアクセス権をどのプリンシパル(ユーザーまたはロール)が持つかを決定するアクセス制御エントリ(ACE)のリストです。
Oracle XML DBの構成

セキュリティ・モデル

DBMS_XDB_CONFIGパッケージは、XDBが所有しているため、SYSまたはXDBで作成される必要があります。EXECUTE権限は、PUBLICに付与されます。このパッケージ内のサブプログラムは、現行のユーザーの権限を使用して実行されます。

定数

DBMS_XDB_CONFIGパッケージでは、表183-1「DBMS_XDB_CONFIGの定数」に示す定数が使用されます。

表183-1 DBMS_XDB_CONFIGの定数

定数	タイプ	値	説明
`XDB_ENDPOINT_HTTP`	`NUMBER`	1	最初のHTTPポートのリスナーの定義
`XDB_ENDPOINT_HTTP2`	`NUMBER`	2	2番目のHTTPポートのリスナーの定義
`XDB_PROTOCOL_TCP`	`NUMBER`	1	HTTPプロトコルのリスナーの定義
`XDB_PROTOCOL_TCPS`	`NUMBER`	2	HTTPSプロトコルのリスナーの定義

DBMS_XDB_CONFIGサブプログラムの要約

表183-2 DBMS_XDB_CONFIGパッケージのサブプログラム

サブプログラム	説明
ADDHTTPEXPIREMAPPINGプロシージャ	有効期限に対するURLパターンのマッピングを`XDB$CONFIG`に追加します。これによって、パターンに一致するURLのExpireヘッダーを制御します。
ADDMIMEMAPPINGプロシージャ	XDB構成にMIMEマッピングを追加します。
ADDSCHEMALOCMAPPINGプロシージャ	XDB構成にスキーマ位置マッピングを追加します。
ADDSERVLETプロシージャ	XDB構成にサーブレットを追加します。
ADDSERVLETMAPPINGプロシージャ	XDB構成にサーブレット・マッピングを追加します。
ADDSERVLETSECROLEプロシージャ	XDB構成内の指定したサーブレットにセキュリティ・ロール`REF`を追加します。
ADDXMLEXTENSIONプロシージャ	次のXML拡張子を`<xml-extensions>`: <extension>extension</extension>下のXDB構成に追加します。
CFG_GETファンクション	セッションの構成情報を`XMLType`インスタンスとして取得します。
CFG_REFRESHプロシージャ	セッションの最新の構成情報をデータベースに反映します。
CFG_UPDATEプロシージャ	構成情報を更新し、変更をコミットします。
DELETEHTTPEXPIREMAPPINGプロシージャ	有効期限に対するURLパターンのすべてのマッピングを`XDB$CONFIG`から削除します。
DELETEMIMEMAPPINGプロシージャ	指定した拡張子のMIMEマッピングをXDB構成から削除します。
DELETESCHEMALOCMAPPINGプロシージャ	指定したスキーマURLのスキーマ位置マッピングをXDB構成から削除します。
DELETESERVLETプロシージャ	サーブレットをXDB構成から削除します。
DELETESERVLETMAPPINGプロシージャ	指定したサーブレット名のサーブレット・マッピングをXDB構成から削除します。
DELETESERVLETSECROLEプロシージャ	XDB構成内のサーブレットから指定したロールを削除します。
DELETEXMLEXTENSIONプロシージャ	指定したXML拡張子をXDB構成から削除します。
ENABLEDIGESTAUTHENTICATIONプロシージャ	Digest認証を有効にします。
GETFTPPORTファンクション	現在のFTPポートの値を取得します。
GETHTTPPORTファンクション	現在のHTTPポートの値を取得します。
GETHTTPCONFIGREALMファンクション	レルム名を取得します。
GETHTTPSPORTファンクション	現在のHTTPSポートの値を取得します。
GETLISTENERENDPOINTプロシージャ	XML DB HTTPサーバーに対応するリスナーのエンド・ポイントのパラメータを取得します。
SETFTPPORTプロシージャ	FTPポートを新しい値に設定します。
SETHTTPPORTプロシージャ	HTTPポートに新しい値を設定します。
SETHTTPCONFIGREALMプロシージャ	レルムに新しい値を設定します。
SETHTTPSPORTプロシージャ	HTTPSポートに新しい値を設定します。
SETLISTENERENDPOINTプロシージャ	XML DB HTTPサーバーに対応するリスナーのエンド・ポイントのパラメータを設定します。
SETLISTENERLOCALACCESSプロシージャ	XML DB HTTPサーバーのすべてのリスナーのエンド・ポイントを、ローカルホスト・インタフェースでのみリスニングするか(`l_access`が`TRUE`に設定されている場合)、ローカルホスト・インタフェースと非ローカルホスト・インタフェースの両方でリスニングするか(`l_access`が`FALSE`に設定されている場合)のどちらかに制限します。
USEDPORTプロシージャ	同じ統合データベース内の他のプラガブル・データベースで使用されるポート番号を取得します。

ADDHTTPEXPIREMAPPINGプロシージャ

このプロシージャは、有効期限に対するURLパターンのマッピングをXDB$CONFIGに追加します。これによって、パターンに一致するURLのExpireヘッダーを制御します。

構文

DBMS_XDB_REPOS.ADDHTTPEXPIREMAPPING (
     pattern    IN    VARCHAR2,
     expire     IN    VARCHAR2);

パラメータ

表183-3 ADDHTTPEXPIREMAPPINGプロシージャのパラメータ

パラメータ説明

pattern

URLパターン(ワイルドカードとして*のみ使用可能)。

expire

Apacheのmod_expiresのExpireDefaultに続く次のような有効期限ディレクティブ。

base [plus] (num type)*
-- base: now | modification
-- type: year|years|month|months|week|weeks|day|days|
minute|minutess|second|seconds

例

DBMS_XDB_REPOS.ADDHTTPEXPIREMAPPING ('/public/test1/*', 'now plus 4 weeks');
DBMS_XDB_REPOS.ADDHTTPEXPIREMAPPING (
             '/public/test2/*', 'modification plus 1 day 30 seconds');

ADDMIMEMAPPINGプロシージャ

このプロシージャは、XDB構成に次のMIMEマッピングを追加します。

<mime-mapping>
<extension>extension</extension>
<mime-type>mimetype</mime-type>
</mime-mapping>

構文

DBMS_XDB_CONFIG.ADDMIMEMAPPING(
     extension    IN   VARCHAR2,
     mimetype     IN   VARCHAR2);

パラメータ

表183-4 ADDMIMEMAPPINGプロシージャのパラメータ

パラメータ	説明
`extension`	MIMEタイプが追加される拡張子。
`mimetype`	MIMEタイプ。

ADDSCHEMALOCMAPPINGプロシージャ

このプロシージャは、XDB構成に次のスキーマ位置マッピングを追加します。

<schemaLocation-mapping>
     <namespace>namespace</namespace>
     <element>element</element>
      <schemaURL>schemaURL</schemaURL>
</schemaLocation-mapping>

構文

DBMS_XDB_CONFIG.ADDSCHEMALOCMAPPING(
     namespace    IN   VARCHAR2,
     element      IN   VARCHAR2,
     schemaURL    IN   VARCHAR2);

パラメータ

表183-5 ADDSCHEMALOCMAPPINGプロシージャのパラメータ

パラメータ	説明
`namespace`	名前空間。
`element`	要素
`schemaURL`	スキーマURL。

ADDSERVLETプロシージャ

このプロシージャは、XDB構成に次のサーブレットを追加します。

<servlet>
     <servlet-name>name</servlet-name>     <servlet-language>language</servlet-language>
     <display-name>dispname</display-name>
     <description>descript</description>
     <servlet-class>class</servlet-class>
     <servlet-schema>schema</servlet-schema>
</servlet>

構文

DBMS_XDB_CONFIG.ADDSERVLET(
     name       IN   VARCHAR2,
    language    IN   VARCHAR2,
    dispname    IN   VARCHAR2,
    icon        IN   VARCHAR2 := NULL,
    descript    IN   VARCHAR2 := NULL,
    class       IN   VARCHAR2 := NULL,
    jspfile     IN   VARCHAR2 := NULL,
    plsql       IN   VARCHAR2 := NULL);

パラメータ

表183-6 ADDSERVLETプロシージャのパラメータ

パラメータ	説明
`name`	サーブレット名。
`language`	C、Java、PL/SQLのいずれかを指定する必要があります。
`dispname`	表示名。
`icon`	アイコン。
`descript`	説明
`class`	このサーブレットに対応する`class` / `jspfile` / `plsql`ファンクション。これら3つの引数のうち最初の`NULL`以外の引数が選択され、その他の引数は`NULL`として処理されます。
`jspfile`	このサーブレットに対応する`class` / `jspfile` / `plsql`ファンクション。これら3つの引数のうち最初の`NULL`以外の引数が選択され、その他の引数は`NULL`として処理されます。
`plsql`	このサーブレットに対応する`class` / `jspfile` / `plsql`ファンクション。これら3つの引数のうち最初の`NULL`以外の引数が選択され、その他の引数は`NULL`として処理されます。
`schema`	スキーマ

ADDSERVLETMAPPINGプロシージャ

このプロシージャは、XDB構成に次のサーブレット・マッピングを追加します。

<servlet-mapping>     <servlet-pattern>pattern</servlet-pattern>     <servlet-name>name</servlet-name></servlet-mapping>

構文

DBMS_XDB_CONFIG.ADDSERVLETMAPPING(
     pattern   IN   VARCHAR2,     name      IN   VARCHAR2);

パラメータ

表183-7 ADDSERVLETMAPPINGプロシージャのパラメータ

パラメータ	説明
`pattern`	サーブレットのパターン。
`name`	サーブレット名。

ADDSERVLETSECROLEプロシージャ

このプロシージャは、XDB構成内の指定したサーブレットに次のセキュリティ・ロールREFを追加します。

<security-role-ref>
     <role-name>rolename</role-name>
     <role-link>rolelink</role-link>
     <description>descript</description>
</security-role-ref>

構文

DBMS_XDB_CONFIG.ADDSERVLETSECROLE(
     servname    IN   VARCHAR2,     rolename    IN   VARCHAR2,     rolelink    IN   VARCHAR2,     descript    IN   VARCHAR2 := NULL);

パラメータ

表183-8 ADDSERVLETSECROLEプロシージャのパラメータ

パラメータ	説明
`servname`	サーブレット名。
`rolename`	ロール名。
`rolelink`	ロール・リンク。
`descript`	説明

ADDXMLEXTENSIONプロシージャ

このプロシージャは、<xml-extensions>で、XDB構成に次のXML拡張子を追加します。

<extension>extension</extension>

構文

DBMS_XDB_CONFIG.ADDXMLEXTENSION(
     extension    IN   VARCHAR2);

パラメータ

表183-9 ADDXMLEXTENSIONプロシージャのパラメータ

パラメータ	説明
`extension`	追加するXML拡張子。

CFG_GETファンクション

このファンクションは、セッションの構成情報をXMLTypeインスタンスとして取得します。

構文

DBMS_XDB_CONFIG.CFG_GET 
 RETURN SYS.XMLType;

CFG_REFRESHプロシージャ

このプロシージャは、セッションの最新の構成情報を反映します。

構文

DBMS_XDB_CONFIG.CFG_REFRESH;

CFG_UPDATEプロシージャ

このプロシージャは、構成情報を更新して、変更をコミットします。

構文

DBMS_XDB_CONFIG.CFG_UPDATE(
   xdbconfig   IN  SYS.XMLTYPE);

パラメータ

表183-10 CFG_UPDATEプロシージャのパラメータ

パラメータ	説明
`xdbconfig`	新規の構成データ。

DELETEHTTPEXPIREMAPPINGプロシージャ

このプロシージャは、有効期限に対するURLパターンのすべてのマッピングをXDB$CONFIGから削除します。

構文

DBMS_XDB_REPOS.DELETEHTTPEXPIREMAPPING(
     pattern  IN   VARCHAR2);

パラメータ

表183-11 DELETEHTTPEXPIREMAPPINGプロシージャのパラメータ

パラメータ	説明
`pattern`	URLパターン(ワイルドカードとして*のみ使用可能)。

DELETEMIMEMAPPINGプロシージャ

このプロシージャは、指定した拡張子のMIMEマッピングをXDB構成から削除します。

構文

DBMS_XDB_CONFIG.DELETEMIMEMAPPING(
     extension    IN   VARCHAR2);

パラメータ

表183-12 DELETEMIMEMAPPINGプロシージャのパラメータ

パラメータ	説明
`extension`	MIMEタイプを削除する拡張子。

DELETESCHEMALOCMAPPINGプロシージャ

このプロシージャは、指定したスキーマURLのスキーマ位置マッピングをXDB構成から削除します。

構文

DBMS_XDB_CONFIG.DELETESCHEMALOCMAPPING(
     schemaURL    IN   VARCHAR2);

パラメータ

表183-13 DELETESCHEMALOCMAPPINGプロシージャのパラメータ

パラメータ	説明
`schemaURL`	スキーマURL。

DELETESERVLETプロシージャ

このプロシージャは、XDB構成からサーブレットを削除します。

構文

DBMS_XDB_CONFIG.DELETESERVLET(
     name        IN   VARCHAR2);

パラメータ

表183-14 DELETESERVLETプロシージャのパラメータ

パラメータ	説明
`name`	サーブレット名。

DELETESERVLETMAPPINGプロシージャ

このプロシージャは、指定したサーブレット名のサーブレット・マッピングをXDB構成から削除します。

構文

DBMS_XDB_CONFIG.DELETESERVLETMAPPING(
     name      IN   VARCHAR2);

パラメータ

表183-15 DELETESERVLETMAPPINGプロシージャのパラメータ

パラメータ	説明
`name`	サーブレット名。

DELETESERVLETSECROLEプロシージャ

このプロシージャは、XDB構成内のサーブレットから指定したロールを削除します。

構文

DBMS_XDB_CONFIG.DELETESERVLETSECROLE(
     servname    IN   VARCHAR2,     rolename    IN   VARCHAR2);

パラメータ

表183-16 DELETESERVLETSECROLEプロシージャのパラメータ

パラメータ	説明
`servname`	サーブレット名。
`rolename`	削除するロールの名前。

DELETEXMLEXTENSIONプロシージャ

このプロシージャは、指定したXML拡張子をXDB構成から削除します。

構文

DBMS_XDB_CONFIG.DELETEXMLEXTENSION(
     extension    IN   VARCHAR2);

パラメータ

表183-17 DELETEXMLEXTENSIONプロシージャのパラメータ

パラメータ	説明
`extension`	削除するXML拡張子。

ENABLEDIGESTAUTHENTICATIONプロシージャ

このプロシージャは、Digest認証を有効にします。DigestがXML DB HTTPサーバーで使用される最初の認証メカニズムとしてリストされます。

構文

DBMS_XDB_CONFIG.ENABLEDIGESTAUTHENTICATION;

GETFTPPORTファンクション

このプロシージャは、現在のFTPポートの値を取得します。

構文

DBMS_XDB_CONFIG.GETFTPPORT
 RETURN NUMBER;

GETHTTPPORTファンクション

このファンクションは現在のHTTPポートの値を取得します。

構文

DBMS_XDB_CONFIG.GETHTTPPORT
 RETURN NUMBER;

GETHTTPCONFIGREALMファンクション

このファンクションは、レルム名を取得します。レルムの定義はIETFのRFC2617で参照されます。

構文

DBMS_XDB_CONFIG.GETHTTPCONFIGREALM
 RETURN VARCHAR2;

GETHTTPSPORTファンクション

このプロシージャは、現在のHTTPSポートの値を取得します。

構文

DBMS_XDB_CONFIG.GETHTTPPORT
 RETURN NUMBER;

使用上の注意

ポートが構成されなかった場合、NULLを返します。

GETLISTENERENDPOINTプロシージャ

このプロシージャは、XML DB HTTPサーバーに対応するリスナーのエンド・ポイントのパラメータを取得します。このプロシージャでは、HTTPとHTTP2の両方のエンド・ポイントのパラメータを取得できます。

構文

DBMS_XDB_CONFIG.GETLISTENERENDPOINT (
   endpoint  IN   NUMBER, 
   host      OUT  VARCHAR2,    port      OUT  NUMBER, 
   protocol  OUT  NUMBER);

パラメータ

表183-18 GETLISTENERENDPOINTプロシージャのパラメータ

パラメータ	説明
`endpoint`	取得するエンド・ポイント。この値は、`XDB_ENDPOINT_HTTP`または`XDB_ENDPOINT_HTTP2`に指定できます。
`host`	リスナーのエンド・ポイントがリスニングするインタフェース。
`port`	リスナーのエンド・ポイントがリスニングするポート。
`protocol`	リスナーのエンド・ポイントによって受け入れられた転送プロトコル。

SETFTPPORTプロシージャ

このプロシージャは、FTPポートを新しい値に設定します。

構文

DBMS_XDB_CONFIG.SETFTPPORT(
   new_port  IN  NUMBER);

パラメータ

表183-19 SETFTPPORTプロシージャのパラメータ

パラメータ	説明
`new_port`	FTPポートが設定される値。

SETHTTPPORTプロシージャ

このプロシージャは、HTTPポートを新しい値に設定します。

構文

DBMS_XDB_CONFIG.SETHTTPPORT(
   new_port  IN  NUMBER);

パラメータ

表183-20 SETHTTPPORTプロシージャのパラメータ

パラメータ	説明
`new_port`	HTTPポートが設定される値。

SETHTTPCONFIGREALMプロシージャ

このプロシージャはレルム値を変更します。

構文

DBMS_XDB_CONFIG.SETHTTPCONFIGREALM(
   realm IN VARCHAR2);

パラメータ

表183-21 SETHTTPPORTプロシージャのパラメータ

パラメータ	説明
`realm`	IETFのRFC2617で定義されたレルム。

SETHTTPSPORTプロシージャ

このプロシージャは、HTTPポートを新しい値に設定します。

構文

DBMS_XDB_CONFIG.SETHTTPSPORT(
   new_port  IN  NUMBER);

パラメータ

表183-22 SETHTTPSPORTプロシージャのパラメータ

パラメータ	説明
`new_port`	HTTPSポートに設定される値。

SETLISTENERENDPOINTプロシージャ

このプロシージャは、XML DB HTTPサーバーに対応するリスナーのエンド・ポイントのパラメータを設定します。このプロシージャでは、HTTPとHTTP2の両方のエンド・ポイントを設定できます。

構文

DBMS_XDB_CONFIG.SETLISTENERENDPOINT (
   endpoint  IN  NUMBER, 
   host      IN  VARCHAR2,    port      IN  NUMBER, 
   protocol  IN  NUMBER);

パラメータ

表183-23 SETLISTENERENDPOINTプロシージャのパラメータ

パラメータ	説明
`endpoint`	設定するエンド・ポイント。この値は、`XDB_ENDPOINT_HTTP`または`XDB_ENDPOINT_HTTP2`に指定できます。
`host`	リスナーのエンド・ポイントがリスニングするインタフェース。この値は、'`LOCALHOST`'、`NULL`またはホスト名に指定できます。この値が'`LOCALHOST`'の場合、リスナーのエンド・ポイントはローカルホスト・インタフェースでのみリスニングできます。この値が`NULL`またはホスト名の場合、リスナーのエンド・ポイントは、ローカルホスト・インタフェースと非ローカルホスト・インタフェースの両方でリスニングできます。
`port`	リスナーのエンド・ポイントがリスニングするポート。
`protocol`	リスナーのエンド・ポイントが受け入れる転送プロトコル。この値は、`XDB_PROTOCOL_TCP`または`XDB_PROTOCOL_TCPS`に指定できます。

SETLISTENERLOCALACCESSプロシージャ

このプロシージャは、XML DB HTTPサーバーのすべてのリスナーのエンド・ポイントを、ローカルホスト・インタフェースでのみリスニングするか(l_accessの設定がTRUEの場合)、またはローカルホスト・インタフェースと非ローカルホスト・インタフェースの両方でリスニングするか(l_accessの設定がFALSEの場合)のどちらかに制限します。

構文

DBMS_XDB_CONFIG.SETLISTENERLOCALACCESS (
   l_access   BOOLEAN);

パラメータ

表183-24 SETLISTENERLOCALACCESSプロシージャのパラメータ

パラメータ	説明
`l_access`	`TRUE`または`FALSE`。

USEDPORTプロシージャ

このプロシージャは、同じ統合データベース内の他のプラガブル・データベースで使用されるポート番号を取得します。

構文

DBMS_XDB_CONFIG.USEDPORT;