164 DBMS_XDB

DBMS_XDBパッケージは次の機能をサポートしています。

• リソース・ビューを補完するリソース管理サブプログラム

• アクセス制御リスト(ACL)ベースのセキュリティ・メカニズム

• 構成セッション管理

• XDBユーザー名の作成

  
  

  関連項目: 『Oracle XML DB開発者ガイド』 『Oracle Database新機能ガイド』

  
  

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

• DBMS_XDBの使用方法

  • 概要

  • 推奨されないサブプログラム

  • セキュリティ・モデル

  • 定数

• DBMS_XDBサブプログラムの要約

---

DBMS_XDBの使用方法

この項では、DBMS_XDBパッケージの使用に関連する項目について説明します。

• 概要

• 推奨されないサブプログラム

• セキュリティ・モデル

• 定数

---

概要

DBMS_XDBパッケージは次の機能をサポートしています。

• リソース管理機能は、LINKプロシージャ、EXISTSRESOURCEファンクション、LOCKRESOURCEファンクション、GETLOCKTOKENプロシージャ、UNLOCKRESOURCEファンクション、CREATERESOURCEファンクション、RENAMERESOURCEプロシージャ、DELETERESOURCEプロシージャ、GETRESOIDファンクション、CREATEOIDPATHファンクション、REBUILDHIERARCHICALINDEXプロシージャおよびCREATEFOLDERファンクションのサブプログラムを提供し、リソース・ビューを補完します。

• アクセス制御リスト(ACL)ベースのセキュリティ・メカニズムは、データベースによって保存された階層内ACLまたはデータベース外から保存されたメモリー内ACLで使用できます。これらのメソッドの一部は、Oracleリソースおよび任意のデータベース・オブジェクトの両方に使用できます。Oracleリソースには、CHECKPRIVILEGESファンクション、GETACLDOCUMENTファンクション、CHANGEPRIVILEGESファンクションおよびGETCHILDRESPATHSファンクションを使用します。ACLCHECKPRIVILEGESファンクションは、階層内にオブジェクトを格納せずに、OracleのACLベースのセキュリティ・メカニズムへのアクセスを提供します。

• 構成セッション管理は、CFG_REFRESHプロシージャ、CFG_GETファンクションおよびCFG_UPDATEプロシージャのメソッドでサポートされています。

• XDBユーザー名はXDBインストール時に作成されます。このユーザーは一連のデフォルトの表およびパッケージを所有します。GETXDB_TABLESPACEファンクションおよびMOVEXDB_TABLESPACEプロシージャは、指定した表領域にスキーマを移動でき、デフォルトのSYSAUX表領域の導入をサポートしています。

---

推奨されないサブプログラム

注意: 新しいアプリケーションでは、推奨されないプロシージャは使用しないことをお薦めします。推奨されない機能は、下位互換性を維持する目的のみでサポートされており、今後のバージョンでは終了する場合があります。

Oracle Database 11gでは、次のサブプログラムの使用は推奨されていません。

• MOVEXDB_TABLESPACEプロシージャ

• REBUILDHIERARCHICALINDEXプロシージャ

この機能のかわりに、DBMS_XDB_ADMINパッケージの同じ名前のサブプログラムを使用してください。

• MOVEXDB_TABLESPACEプロシージャ

• REBUILDHIERARCHICALINDEXプロシージャ

---

セキュリティ・モデル

DBMS_XDBパッケージは、XDBが所有しているため、SYSまたはXDBによって作成される必要があります。EXECUTE権限は、PUBLICに付与されます。このパッケージ内のサブプログラムは、現行のユーザーの権限を使用して実行されます。XDB構成で動作するサブプログラムは、現行のユーザーがSYSまたはXDBである場合、または現行のユーザーがXDBADMINロールまたはDBAロールを持つ場合にのみ成功します。

---

定数

表164-1 DBMS_XDBの事前定義定数

定数	タイプ	値	説明
DELETE_RESOURCE	NUMBER	1	リソースを削除します。リソースに子がある場合失敗します。
DELETE_RECURSIVE	NUMBER	2	リソースと子がある場合それを削除します。
DELETE_FORCE	NUMBER	3	含まれるオブジェクトが無効な場合でも、リソースを削除します。
DELETE_RECURSIVE_FORCE	NUMBER	4	含まれるオブジェクトが無効な場合でも、リソースと子がある場合それを削除します。

---

DBMS_XDBサブプログラムの要約

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

サブプログラム	説明
ACLCHECKPRIVILEGESファンクション	指定のACLドキュメントで指定されている現行ユーザーに付与されたアクセス権限をチェックします。このアクセス権限は、所有者が'owner'パラメータで指定されているリソースに対するものです。
ADDHTTPEXPIREMAPPINGプロシージャ	有効期限に対するURLパターンのマッピングをxdb$configに追加します。これによって、パターンに一致するURLのExpireヘッダーを制御します。
ADDMIMEMAPPINGプロシージャ	XDB構成にMIMEマッピングを追加します。
ADDSCHEMALOCMAPPINGプロシージャ	XDB構成にスキーマ位置マッピングを追加します。
ADDSERVLETプロシージャ	XDB構成にサーブレットを追加します。
ADDSERVLETMAPPINGプロシージャ	XDB構成にサーブレット・マッピングを追加します。
ADDSERVLETSECROLEプロシージャ	XDB構成内の指定したサーブレットにセキュリティ・ロールREFを追加します。
ADDXMLEXTENSIONプロシージャ	XDB構成にXML拡張子を追加します。
APPENDPATHプロシージャ	親のパスに子のパスを追加します。
APPENDPATHプロシージャ	ユーザー定義のメタデータをXMLTYPEへのREFまたはXMLTYPEとして使用し、目的のリソースに追加します。
CFG_GETファンクション	セッションの構成情報を取得します。
CFG_REFRESHプロシージャ	セッションの最新の構成情報をデータベースに反映します。
CFG_UPDATEプロシージャ	構成情報を更新します。
CHANGEOWNERプロシージャ	リソースの所有者を指定した所有者に変更します。
CHANGEPRIVILEGESファンクション	指定したACEを、指定したリソースのACLに追加します。
CHECKPRIVILEGESファンクション	指定したリソースに対して現行ユーザーに付与されているアクセス権限をチェックします。
CREATEFOLDERファンクション	階層内に新規フォルダ・リソースを作成します。
CREATEOIDPATHファンクション	オブジェクトIDに基づいたリソースの仮想パスを作成します。
CREATERESOURCEファンクション	新規リソースを作成します。
DELETEHTTPEXPIREMAPPINGプロシージャ	有効期限に対するURLパターンのすべてのマッピングをxdb$configから削除します。
DELETEMIMEMAPPINGプロシージャ	XDB構成からMIMEマッピングを削除します。
DELETERESOURCEプロシージャ	階層からリソースを削除します。
DELETERESOURCEMETADATAプロシージャ	リソースからメタデータを削除します(スキーマ・ベースまたは非スキーマ・ベースのメタデータに使用できます)。
DELETESCHEMALOCMAPPINGプロシージャ	指定したスキーマURLのスキーマ位置マッピングをXDB構成から削除します。
DELETESERVLETプロシージャ	XDB構成からサーブレットを削除します。
DELETESERVLETMAPPINGプロシージャ	指定したサーブレット名のサーブレット・マッピングをXDB構成から削除します。
DELETESERVLETSECROLEプロシージャ	XDB構成内のサーブレットから指定したロールを削除します。
DELETEXMLEXTENSIONプロシージャ	指定したXML拡張子をXDB構成から削除します。
EXISTSRESOURCEファンクション	リソースの絶対パスに基づいて、リソースが階層であるかどうかを判別します。
GETACLDOCUMENTファンクション	パス名を指定して、リソースを保護するACLドキュメントを取得します。
GETCHILDRESPATHSファンクション	すべての子リソースの絶対パス上にカーソルを戻します。
GETCONTENTBLOBファンクション	BLOBとして戻されたリソースの内容を取り出します。
GETCONTENTCLOBファンクション	CLOBとして戻されたリソースの内容を取り出します。
GETCONTENTVARCHAR2ファンクション	文字列として戻されたリソースの内容を取り出します。
GETCONTENTXMLREFファンクション	XMLTYPEへのREFとして戻されたリソースの内容を取り出します。
GETCONTENTXMLTYPEファンクション	XMLTYPEとして戻されたリソースの内容を取り出します。
GETFTPPORTファンクション	現在のFTPポートの値を取得します。
GETHTTPPORTファンクション	現在のHTTPポートの値を取得します。
GETLOCKTOKENプロシージャ	リソースへのパスを指定して、現行ユーザーのリソースのロック・トークンを戻します。
GETLISTENERENDPOINTプロシージャ	XML DB HTTPサーバーに対応するリスナーのエンド・ポイントのパラメータを取得します。
GETRESOIDファンクション	リソースの絶対パスからオブジェクトIDを戻します。
GETXDB_TABLESPACEファンクション	XDB(ユーザー)の現行の表領域を戻します。
HASBLOBCONTENTファンクション	リソースにBLOBコンテンツがある場合はTRUEを戻します。
HASCHARCONTENTファンクション	リソースに文字コンテンツがある場合はTRUEを戻します。
HASXMLCONTENTファンクション	リソースにXMLコンテンツがある場合はTRUEを戻します。
HASXMLREFERENCEファンクション	リソースにXMLコンテンツへのREFがある場合は、TRUEを戻します。
ISFOLDERファンクション	リソースがフォルダまたはコンテナの場合は、TRUEを戻します。
LINKプロシージャ	既存のリソースへのリンクを作成します。
LOCKRESOURCEファンクション	リソースへのパスを指定して、リソースに対するWebDAVスタイルのロックを取得します。
MOVEXDB_TABLESPACEプロシージャ	(非推奨)XDB(ユーザー)を指定した表領域に移動します。
PROCESSLINKSプロシージャ	指定したリソース内のドキュメント・リンクを処理します。
PURGERESOURCEMETADATAプロシージャ	リソースからすべてのユーザー・メタデータを削除します。
REBUILDHIERARCHICALINDEXプロシージャ	(非推奨)インポートまたはエクスポート操作後に、階層の索引を再作成します。
RENAMERESOURCEプロシージャ	XDBリソースの名前を変更します。
SETACLプロシージャ	指定したリソースにACLを設定します。
SETCONTENTプロシージャ	指定したリソースの内容を指定したデータ・タイプに置き換えます。
SETFTPPORTプロシージャ	FTPポートを新しい値に設定します。
SETHTTPPORTプロシージャ	HTTPポートに新しい値を設定します。
SETLISTENERENDPOINTプロシージャ	XML DB HTTPサーバーに対応するリスナーのエンド・ポイントのパラメータを設定します。
SETLISTENERLOCALACCESSプロシージャ	XML DB HTTPサーバーのすべてのリスナーのエンド・ポイントを、ローカルホスト・インタフェースでのみリスニングするか、ローカルホスト・インタフェースと非ローカルホスト・インタフェースの両方でリスニングするかのどちらかに制限します。
SPLITPATHプロシージャ	パスを親のパスと子のパスに分割します。
TOUCHRESOURCEプロシージャ	リソースの変更時刻を現在の時刻に変更します。
UPDATERESOURCEMETADATAプロシージャ	リソースのメタデータを更新します。
UNLOCKRESOURCEファンクション	ロック・トークンおよびリソース・パスを指定して、リソースのロックを解除します。

---

ACLCHECKPRIVILEGESファンクション

このファンクションは、リソースのOWNERによる指定したACLドキュメントによって、現在のユーザーに付与されたアクセス権限をチェックします。すべての権限が付与されている場合は、正の整数を戻します。

構文

DBMS_XDB.ACLCHECKPRIVILEGES(
   acl_path  IN  VARCHAR2,
   owner     IN  VARCHAR2,
   privs     IN  xmltype)
 RETURN PLS_INTEGER;

パラメータ

表164-3 ACLCHECKPRIVILEGESファンクションのパラメータ

パラメータ	説明
acl_path	ACLドキュメントの階層内の絶対パス。
owner	リソースの所有者名。疑似ユーザー「DAV:owner」は、ACL権限の解決時にこのユーザーに置き換えられます。
privs	privilege要素のXMLTypeインスタンスで、要求された一連のアクセス権限を指定します。CHECKPRIVILEGESファンクションを参照してください。

---

ADDHTTPEXPIREMAPPINGプロシージャ

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

構文

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

パラメータ

表164-4 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.ADDHTTPEXPIREMAPPING ('/public/test1/*', 'now plus 4 weeks');
DBMS_XDB.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.ADDMIMEMAPPING(
     extension    IN   VARCHAR2,
     mimetype     IN   VARCHAR2);

パラメータ

表164-5 ADDMIMEMAPPINGプロシージャのパラメータ

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

---

ADDSCHEMALOCMAPPINGプロシージャ

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

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

構文

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

パラメータ

表164-6 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.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);

パラメータ

表164-7 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.ADDSERVLETMAPPING(
     pattern   IN   VARCHAR2,     name      IN   VARCHAR2);

パラメータ

表164-8 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.ADDSERVLETSECROLE(
     servname    IN   VARCHAR2,     rolename    IN   VARCHAR2,     rolelink    IN   VARCHAR2,     descript    IN   VARCHAR2 := NULL);

パラメータ

表164-9 ADDSERVLETSECROLEプロシージャのパラメータ

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

---

ADDXMLEXTENSIONプロシージャ

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

<extension>extension</extension>

構文

DBMS_XDB.ADDXMLEXTENSION(
     extension    IN   VARCHAR2);

パラメータ

表164-10 ADDXMLEXTENSIONプロシージャのパラメータ

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

---

APPENDPATHプロシージャ

このプロシージャは、親のパスに子のパスを追加します。

構文

DBMS_XDB.APPENDPATH (
     abspath       OUT   VARCHAR2,     parentpath    IN    VARCHAR2,    childpath      IN    VARCHAR2);

パラメータ

表164-11 APPENDPATHプロシージャ

パラメータ	説明
abspath	リソースの絶対パス。
parentpath	親のパス。
childpath	子のパス。

---

APPENDRESOURCEMETADATAプロシージャ

このプロシージャは、ユーザー定義のメタデータをXMLTYPEへのREFまたはXMLTYPEとして使用し、目的のリソースに追加します。

構文

DBMS_XDB.APPENDRESOURCEMETADATA (
 abspath   IN  VARCHAR2, 
 metadata  IN  XMLTYPE);

DBMS_XDB.APPENDRESOURCEMETADATA (
 abspath   IN  VARCHAR2, 
 metadata  IN  REF SYS.XMLTYPE);

パラメータ

表164-12 APPENDRESOURCEMETADATAプロシージャ

パラメータ	説明
abspath	リソースの絶対パス。
metadata	メタデータには、スキーマ・ベースまたは非スキーマ・ベースのメタデータを使用できます。スキーマ・ベースのメタデータは、独自の表に格納されます。

使用上の注意

• REFが渡された場合、プロシージャは、REFをリソースに、メタデータは別の表に格納します。この場合は、メタデータ表のRESID列に移入する必要があります。渡されるREFは一意である必要があることに注意してください。つまり、リソース・メタデータに同じ値を持つREFが存在していると、プロパティの一意性に違反するため、同じにしないでください。ユーザが、すでに存在するREFを追加しようとすると、エラーが発生します。

• XMLTYPEが渡された場合、データを解析してスキーマ・ベースかどうかを判断し、その結果に応じてデータを格納します。

---

CFG_GETファンクション

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

構文

DBMS_XDB.CFG_GET 
 RETURN SYS.XMLType;

---

CFG_REFRESHプロシージャ

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

構文

DBMS_XDB.CFG_REFRESH;

---

CFG_UPDATEプロシージャ

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

構文

DBMS_XDB.CFG_UPDATE(
   xdbconfig   IN  SYS.XMLTYPE);

パラメータ

表164-13 CFG_UPDATEプロシージャのパラメータ

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

---

CHANGEOWNERプロシージャ

このプロシージャは、リソースの所有者を指定した所有者に変更します。

構文

DBMS_XDB.CHANGEOWNER(
     abspath    IN   VARCHAR2,
     owner      IN   VARCHAR2,
     recurse    IN   BOOLEAN := FALSE);

パラメータ

表164-14 CHANGEOWNERプロシージャのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。
owner	リソースの新しい所有者。
recurse	TRUEの場合は、フォルダ・ツリー内のすべてのリソースの所有者を再帰的に変更します。

---

CHANGEPRIVILEGESファンクション

このファンクションは、指定したACEを指定したリソースのACLに追加します。

構文

DBMS_XDB.CHANGEPRIVILEGES(
   res_path   IN    VARCHAR2,
   ace        IN    xmltype)
 RETURN PLS_INTEGER;

パラメータ

表164-15 CHANGEPRIVILEGESファンクションのパラメータ

パラメータ	説明
res_path	権限を変更する必要があるリソースのパス名。
ace	<ace>要素のXMLTypeインスタンス。この要素は、<principal>、<grant>操作および権限リストを指定します。

戻り値

ACLが正常に変更された場合は、正の整数。

使用上の注意

同じprincipalおよび同じ操作(grant/deny)を持つACEがACLに存在しない場合、新規のACEがACLの最後に追加されます。

---

CHECKPRIVILEGESファンクション

このファンクションは、指定したリソースに対して現行ユーザーに付与されているアクセス権限をチェックします。

構文

DBMS_XDB.CHECKPRIVILEGES(
   res_path   IN  VARCHAR2,
   privs      IN  xmltype)
 RETURN PLS_INTEGER;

パラメータ

表164-16 CHECKPRIVILEGESファンクションのパラメータ

パラメータ	説明
res_path	リソースの階層内の絶対パス。
privs	privilege要素のXMLTypeインスタンス。要求された一連のアクセス権限を指定します。

戻り値

要求された権限がすべて付与されている場合は、正の整数。

---

CREATEFOLDERファンクション

このファンクションは階層内に新規フォルダ・リソースを作成します。

構文

DBMS_XDB.CREATEFOLDER(
   path   IN  VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-17 CREATEFOLDERファンクションのパラメータ

パラメータ	説明
path	新規フォルダのパス名。

戻り値

操作が成功した場合はTRUE。そうでない場合はFALSE。

使用上の注意

指定したパス名の親フォルダは、階層内にすでに存在している必要があります。たとえば、pathパラメータに'/folder1/folder2'を指定する場合は、'/folder1'がすでに存在している必要があります。

---

CREATEOIDPATHファンクション

このファンクションは、オブジェクトIDに基づいたリソースの仮想パスを作成します。

構文

DBMS_XDB.CREATEOIDPATH(
   oid    IN   RAW)
 RETURN VARCHAR2;

パラメータ

表164-18 CREATEOIDPATHファンクションのパラメータ

パラメータ	説明
oid	リソースのオブジェクトID。

---

CREATERESOURCEファンクション

このファンクションは新しいリソースを作成します。オーバーロード・オプションの記述は各バージョンの構文の前に配置します。

構文

指定した文字列を内容として使用し、新規リソースを作成します。

DBMS_XDB.CREATERESOURCE( 
     abspath        IN  VARCHAR2,
     data           IN  VARCHAR2,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN;

指定したXMLTypeデータを内容として使用し、新規リソースを作成します。

DBMS_XDB.CREATERESOURCE(
     abspath        IN  VARCHAR2,
     data           IN  SYS.XMLTYPE,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN;

既存のXMLType行にREFを指定し、その行を指す内容を持つリソースを作成します。この行は、別のリソース内に事前に存在させることはできません。

DBMS_XDB.CREATERESOURCE(
     abspath        IN  VARCHAR2,
     datarow        IN  REF SYS.XMLTYPE,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN;

内容として指定したBLOBを使用して、リソースを作成し、ソースBLOBのキャラクタ・セットを指定します。

DBMS_XDB.CREATERESOURCE(
     abspath        IN  VARCHAR2,
     data           IN  BLOB,
     csid           IN  NUMBER :=0,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN; 

内容として指定したBFILEを使用して、リソースを作成し、ソースBFILEのキャラクタ・セットを指定します。

DBMS_XDB.CREATERESOURCE ( 
     abspath        IN  VARCHAR2,
     data           IN  BFILE,
     csid           IN  NUMBER :=0,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN;

指定したCLOBを内容として使用し、リソースを作成します。

DBMS_XDB.CREATERESOURCE (
     abspath        IN  VARCHAR2,
     data           IN  CLOB,
     createfolders  IN  BOOLEAN := FALSE)
 RETURN BOOLEAN; 

文字列を指定すると、その文字列を内容として持つ新規リソースを階層に挿入します。

DBMS_XDB.CREATERESOURCE (
   abspath        IN  VARCHAR2, 
   data           IN  VARCHAR2,
   schemaurl      IN  VARCHAR2 := NULL,
   elem           IN  VARCHAR2 := NULL)
 RETURN BOOLEAN; 

XMLTYPEおよびスキーマURLを指定すると、XMLTYPEを内容として持つ新規リソースを階層に挿入します。

DBMS_XDB.CREATERESOURCE (
   abspath        IN  VARCHAR2, 
   data           IN  SYS.XMLTYPE,
   schemaurl      IN  VARCHAR2 := NULL,
   elem           IN  VARCHAR2 := NULL)
 RETURN BOOLEAN;

パラメータ

表164-19 CREATERESOURCEファンクションのパラメータ

パラメータ	説明
abspath	作成するリソースの絶対パス。パス名の親フォルダは、階層内にすでに存在している必要があります。たとえば、/foo/bar.txtと指定する場合は、フォルダ/fooがすでに存在している必要があります。
data	新規リソースの内容が含まれている文字列バッファ。データは解析され、スキーマに基づいたXML文書が含まれているかどうかがチェックされ、含まれている場合、内容はスキーマのデフォルト表にスキーマに基づいたものとして格納されます。含まれていない場合は、バイナリ・データとして保存されます。
datarow	内容として使用するXMLType行へのREF。
csid	ドキュメントのキャラクタ・セットID。有効なOracle IDである必要があり、無効な場合、エラーが戻されます。 CSIDを指定しない場合またはCSIDに0(ゼロ)を指定した場合、ドキュメントのキャラクタ・セットIDは次のように判断されます。 abspath拡張子から、リソースのMIMEタイプを判断します。 MIMEタイプが*/xmlの場合、エンコードはhttp://www.w3.org/TR/2000/REC-xml-20001006のW3C XML 1.0 ReferenceのAppendix Fに基づいて検出されます。 それ以外の場合、デフォルトでデータベースのキャラクタ・セットに設定されます。
createfolders	TRUEの場合、親フォルダが存在しないときには作成します。
schemaurl	XMLデータの場合、データが準拠するスキーマURL(デフォルトはNULL)。
elem	要素名(デフォルトはNULL)。

戻り値

操作が成功した場合はTRUE。そうでない場合はFALSE。

---

DELETEHTTPEXPIREMAPPINGプロシージャ

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

構文

DBMS_XDB.DELETEHTTPEXPIREMAPPING(
     pattern  IN   VARCHAR2);

パラメータ

表164-20 DELETEHTTPEXPIREMAPPINGプロシージャのパラメータ

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

---

DELETEMIMEMAPPINGプロシージャ

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

構文

DBMS_XDB.DELETEMIMEMAPPING(
     extension    IN   VARCHAR2);

パラメータ

表164-21 DELETEMIMEMAPPINGプロシージャのパラメータ

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

---

DELETERESOURCEプロシージャ

このプロシージャは、階層からリソースを削除します。

構文

DBMS_XDB.DELETERESOURCE(
   path          IN      VARCHAR2,
   delete_option IN      PLS_INTEGER);

パラメータ

表164-22 DELETERESOURCEプロシージャのパラメータ

パラメータ	説明
path	削除するリソースのパス名。
delete_option	表164-1で定義されたリソースの削除方法を制御するオプション: DELETE_RESOURCE DELETE_RECURSIVE DELETE_FORCE DELETE_RECURSIVE_FORCE

---

DELETERESOURCEMETADATAプロシージャ

このプロシージャは、絶対パスでリソースを使用し、REFで識別されるスキーマ・ベースのメタデータ、またはネームスペースと名前の組合せで識別されるメタデータ(スキーマ・ベースまたは非スキーマ・ベースのメタデータ)を削除します。また、メタデータの削除方法を指定する追加のパラメータ(オプション)も使用できます。このパラメータは、削除する必要のあるスキーマ・ベースのリソース・メタデータにのみ関連しています。非スキーマ・ベースのメタデータの場合、このパラメータは無視されます。

構文

次の構文は、スキーマ・ベースのメタデータにのみ使用できます。

DBMS_XDB.DELETERESOURCEMETADATA (
   abspath        IN  VARCHAR2, 
   metadata       IN  REF SYS.XMLTYPE,
   delete_option  IN  pls_integer := dbms_xdb.DELETE_RESOURCE_METADATA_CASCADE);
 

次の構文は、スキーマ・ベースまたは非スキーマ・ベースのメタデータに使用できます。

DBMS_XDB.DELETERESOURCEMETADATA (
   abspath        IN VARCHAR2,
   metadatans     IN VARCHAR2,
   metadataname   IN VARCHAR2,
   delete_option  IN pls_integer := dbms_xdb.DELETE_RESOURCE_METADATA_CASCADE);

パラメータ

表164-23 DELETERESOURCEMETADATAプロシージャのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。
metadata	削除する(スキーマ・ベースの)メタデータの一部へのREF。
mettadatans	削除するメタデータの断片のネームスペース。
mettadataname	削除するメタデータの断片のローカル名。
delete_option	スキーマ・ベースのメタデータにのみ適用できます。このパラメータは次のいずれかになります。 DELETE_RES_METADATA_CASCADE: メタデータ表内の対応する行を削除します。 DELETE_RES_METADATA_NOCASCADE: メタデータ表内の行を削除しません。

---

DELETESCHEMALOCMAPPINGプロシージャ

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

構文

DBMS_XDB.DELETESCHEMALOCMAPPING(
     schemaURL    IN   VARCHAR2);

パラメータ

表164-24 DELETESCHEMALOCMAPPINGプロシージャのパラメータ

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

---

DELETESERVLETプロシージャ

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

構文

DBMS_XDB.DELETESERVLET(
     name        IN   VARCHAR2);

パラメータ

表164-25 DELETESERVLETプロシージャのパラメータ

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

---

DELETESERVLETMAPPINGプロシージャ

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

構文

DBMS_XDB.DELETESERVLETMAPPING(
     name      IN   VARCHAR2);

パラメータ

表164-26 DELETESERVLETMAPPINGプロシージャのパラメータ

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

---

DELETESERVLETSECROLEプロシージャ

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

構文

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

パラメータ

表164-27 DELETESERVLETSECROLEプロシージャのパラメータ

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

---

DELETEXMLEXTENSIONプロシージャ

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

構文

DBMS_XDB.DELETEXMLEXTENSION(
     extension    IN   VARCHAR2);

パラメータ

表164-28 DELETEXMLEXTENSIONプロシージャのパラメータ

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

---

EXISTSRESOURCEファンクション

このファンクションは、リソースが階層内にあるかどうかを示します。絶対パスを表す文字列によってリソースを照合します。

構文

DBMS_XDB.EXISTSRESOURCE(
   abspath    IN    VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-29 EXISTSRESOURCEファンクションのパラメータ

パラメータ	説明
abspath	ACLドキュメントが必要なリソースのパス名。

戻り値

リソースが見つかった場合はTRUE。

---

GETACLDOCUMENTファンクション

このファンクションは、パス名を指定して、リソースを保護するACLドキュメントを取得します。

構文

DBMS_XDB.GETACLDOCUMENT(
   abspath  IN  VARCHAR2)
  RETURN sys.xmltype;

パラメータ

表164-30 GETACLDOCUMENTファンクションのパラメータ

パラメータ	説明
abspath	ACLドキュメントが必要なリソースのパス名。

戻り値

ACLドキュメントのXMLType。

---

GETCHILDRESPATHSファンクション

このファンクションは、すべての子リソースの絶対パス上にカーソルを戻します。

構文

DBMS_XDB.GETCHILDRESPATHS(
     abspath    IN     VARCHAR2);
  RETURN SYS_REFCURSOR;

パラメータ

表164-31 GETCHILDRESPATHSファンクションのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。

戻り値

すべての子リソースの絶対パス上のカーソル。

---

GETCONTENTBLOBファンクション

このファンクションは、BLOBとして戻されたリソースの内容を取り出します。

構文

DBMS_XDB.GETCONTENTBLOB(
     abspath    IN     VARCHAR2, 
     csid       OUT    PLS_INTEGER,
     locksrc    IN     BOOLEAN := FALSE) 
  RETURN BLOB;

パラメータ

表164-32 GETCONTENTBLOBファンクションのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。
csid	TRUEの場合、ソースLOBをロックして戻します。FALSEの場合、一時LOBコピーを戻します。
locksrc	BLOBとしてのリソースの内容。

戻り値

BLOBとしてのリソースの内容。

---

GETCONTENTCLOBファンクション

このファンクションは、CLOBとして戻されたリソースの内容を取得します。

構文

DBMS_XDB.GETCONTENTCLOB(
     abspath    IN     VARCHAR2,
  RETURN CLOB;

パラメータ

表164-33 GETCONTENTCLOBファンクションのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。

戻り値

CLOBとしてのリソースの内容。

---

GETCONTENTVARCHAR2ファンクション

このファンクションは、文字列として戻されたリソースの内容を取得します。

構文

DBMS_XDB.GETCONTENTVARCHAR2(
     abspath    IN     VARCHAR2,
  RETURN BLOB;

パラメータ

表164-34 GETCONTENTVARCHAR2ファンクションのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。

戻り値

文字列としてのリソースの内容。

---

GETCONTENTXMLREFファンクション

このファンクションは、XMLTYPEへのREFとして戻されたリソースの内容を取り出します。

構文

DBMS_XDB.GETCONTENTXMLREF(
     abspath    IN     VARCHAR2,
  RETURN SYS.XMLTYPE;

パラメータ

表164-35 GETCONTENTXMLREFファンクションのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。

戻り値

XMLTYPEへのREFとしてのリソースの内容。

---

GETCONTENTXMLTYPEファンクション

このファンクションは、XMLTYPEとして戻されたリソースの内容を取り出します。

構文

DBMS_XDB.GETCONTENTXMLTYPE(
     abspath    IN     VARCHAR2,
  RETURN SYS.XMLTYPE;

パラメータ

表164-36 GETCONTENTXMLTYPEファンクションのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。

戻り値

XMLTYPEとしてのリソースの内容。

---

GETFTPPORTファンクション

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

構文

DBMS_XDB.GETFTPPORT
 RETURN NUMBER;

---

GETHTTPPORTファンクション

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

構文

DBMS_XDB.GETHTTPPORT
 RETURN NUMBER;

---

GETLISTENERENDPOINTプロシージャ

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

構文

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

パラメータ

表164-37 GETLISTENERENDPOINTプロシージャのパラメータ

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

---

GETLOCKTOKENプロシージャ

リソースへのパスを指定して、現行ユーザーのリソースのロック・トークンを戻します。

構文

DBMS_XDB.GETLOCKTOKEN(
   path         IN      VARCHAR2,
   locktoken    OUT     VARCHAR2);

パラメータ

表164-38 GETLOCKTOKENプロシージャのパラメータ

パラメータ	説明
path	リソースへのパス名。
locktoken	ログインしたユーザーのリソースに対するロック・トークン。

使用上の注意

ユーザーには、リソースに対するREADPROPERTIES権限が必要です。

---

GETPRIVILEGESファンクション

このファンクションは、指定したリソースに対して現行ユーザーに付与されている権限をすべて取得します。

構文

DBMS_XDB.GETPRIVILEGES(
   res_path    IN     VARCHAR2)
 RETURN sys.xmltype;

パラメータ

表164-39 GETPRIVILEGESファンクションのパラメータ

パラメータ	説明
res_path	リソースの階層内の絶対パス。

戻り値

<privilege>要素のXMLTypeインスタンス。これには、このリソースに対して現行のユーザーに付与されたすべてのリーフ権限のリストが含まれています。

---

GETRESOIDファンクション

リソースの絶対パスからオブジェクトIDを戻します。

構文

DBMS_XDB.GETRESOID(
   abspath IN VARCHAR2)
RETURN RAW;

パラメータ

表164-40 GETRESOIDファンクションのパラメータ

パラメータ	説明
abspath_path	リソースの絶対パス。

戻り値

リソースが存在しない場合はNULL。

---

GETXDB_TABLESPACEファンクション

このファンクションは、XDB(ユーザー)の現行の表領域を戻します。

構文

DBMS_XDB.GETXDB_TABLESPACE
 RETURN VARCHAR2;

---

HASBLOBCONTENTファンクション

このファンクションは、リソースにBLOBコンテンツがある場合はTRUEを戻します。

構文

DBMS_XDB.DBMS_XDB.HASBLOBCONTENT 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-41 HASBLOBCONTENTファンクションのパラメータ

パラメータ	説明
abspath_path	リソースの絶対パス。

戻り値

リソースにBOBコンテンツがある場合はTRUE。

---

HASCHARCONTENTファンクション

このファンクションは、リソースに文字コンテンツがある場合はTRUEを戻します。

構文

DBMS_XDB.DBMS_XDB.HASCHARCONTENT 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-42 HASCHARCONTENTファンクションのパラメータ

パラメータ	説明
abspath_path	リソースの絶対パス。

戻り値

リソースに文字コンテンツがある場合はTRUE。

---

HASXMLCONTENTファンクション

このファンクションは、リソースにXMLコンテンツがある場合はTRUEを戻します。

構文

DBMS_XDB.DBMS_XDB.HASXMLCONTENT 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-43 HASXMLCONTENTファンクションのパラメータ

パラメータ	説明
abspath_path	リソースの絶対パス。

戻り値

リソースにXMLコンテンツがある場合はTRUE。

---

HASXMLREFERENCEファンクション

このファンクションは、リソースにXMLコンテンツへのREFがある場合はTRUEを戻します。

構文

DBMS_XDB.DBMS_XDB.HASXMLREFERENCE 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-44 HASXMLREFERENCEファンクションのパラメータ

パラメータ	説明
abspath_path	リソースの絶対パス。

戻り値

リソースにXMLコンテンツへのREFがある場合はTRUE。

---

ISFOLDERファンクション

このファンクションは、リソースがフォルダまたはコンテナの場合はTRUEを戻します。

構文

DBMS_XDB.DBMS_XDB.ISFOLDER 
     abspath    IN     VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-45 DBMS_XDB.ISFOLDERファンクションのパラメータ

パラメータ	説明
abspath_path	リソースの絶対パス。

戻り値

リソースがフォルダまたはコンテナの場合はTRUE。

---

LINKプロシージャ

このプロシージャは、指定したフォルダから指定したリソースに作成します。

構文

DBMS_XDB.LINK(
   srcpath      IN   VARCHAR2,
   linkfolder   IN   VARCHAR2,
   linkname     IN   VARCHAR2);

DBMS_XDB.LINK(
   srcpath      IN   VARCHAR2,
   linkfolder   IN   VARCHAR2,
   linkname     IN   VARCHAR2,
   linktype     IN   PLS_INTEGER := DBMS_XDB.LINK_TYPE_HARD);

パラメータ

表164-46 LINKプロシージャのパラメータ

パラメータ	説明
srcpath	リンクを作成するリソースのパス名。
linkfolder	新規リンクを格納するフォルダ。
linkname	新規リンクの名前。
linktype	作成するリンクのタイプ。 DBMS_XDB.LINK_TYPE_HARD(デフォルト) DBMS_XDB.LINK_TYPE_WEAK DBMS_XDB.LINK_TYPE_SYMBOLIC

---

LOCKRESOURCEファンクション

リソースへのパスを指定して、リソースに対するWebDAVスタイルのロックを取得します。

構文

DBMS_XDB.LOCKRESOURCE(
   path      IN  VARCHAR2,
   depthzero IN  BOOLEAN,
   shared    IN  boolean)
RETURN BOOLEAN;

パラメータ

表164-47 LOCKRESOURCEファンクションのパラメータ

パラメータ	説明
path	ロックするリソースのパス名。
depthzero	現在サポートされていません。
shared	TRUEを設定すると、共有書込みロックを取得します。

戻り値

成功した場合はTRUE。

使用上の注意

ユーザーには、リソースに対するUPDATE権限が必要です。

---

MOVEXDB_TABLESPACEプロシージャ

注意: 11gでは、このプロシージャの使用は推奨されていません。この機能のかわりに、DBMS_XDB_ADMINパッケージの同じ名前のサブプログラム(MOVEXDB_TABLESPACEプロシージャ)を使用してください。

このプロシージャは、指定した表領域にXDB(ユーザー)を移動します。

構文

DBMS_XDB.MOVEXDB_TABLESPACE(
   new_tablespace   IN  VARCHAR2);

パラメータ

表164-48 MOVEXDB_TABLESPACEプロシージャのパラメータ

パラメータ	説明
new_tablespace	XDBを移動する表領域の名前。

使用上の注意

• この処理は、すべての同時XDBセッションの終了を待機します。

• MOVEXDB_TABLESPACEが失敗した場合は、さらにコマンドを発行する前に、データベースを再起動する必要があります。そうしないと、不確実な結果となります。

---

PROCESSLINKSプロシージャ

このプロシージャは、指定したリソース内のドキュメント・リンクを処理します。

構文

DBMS_XDB.PURGERESOURCEMETADATA( 
 abspath  IN  VARCHAR2,
 recurse  IN  BOOLEAN := FALSE);

パラメータ

表164-49 PROCESSLINKSプロシージャのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。パスがフォルダの場合は、recurseフラグを使用します。
recurse	abspathがフォルダを指定する場合にのみ使用します。TRUEの場合、指定したリソースをルートとするフォルダ階層内のすべてのリソースのリンクを処理します。FALSEの場合、このフォルダ内のみのすべてのドキュメントのリンクを処理します。

---

PURGERESOURCEMETADATAプロシージャ

このプロシージャは、リソースからすべてのユーザー・メタデータを削除します。スキーマ・ベースのメタデータはカスケード・モードで削除され、対応するメタデータ表から行が削除されます。

構文

DBMS_XDB.PURGERESOURCEMETADATA(  
 abspath  IN  VARCHAR2);

パラメータ

表164-50 PURGERESOURCEMETADATAプロシージャのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。

---

REBUILDHIERARCHICALINDEXプロシージャ

注意: 11gでは、このプロシージャの使用は推奨されていません。この機能のかわりに、DBMS_XDB_ADMINパッケージの同じ名前のサブプログラム(REBUILDHIERARCHICALINDEXプロシージャ)を使用してください。

このプロシージャは、インポートまたはエクスポート操作後に、階層の索引を再作成します。これは、データを索引表からエクスポートできないため必要です。

構文

DBMS_XDB.REBUILDHIERARCHICALINDEX;

---

RENAMERESOURCEプロシージャ

このプロシージャは、XDBリソースの名前を変更します。

構文

DBMS_XDB.RENAMERESOURCE(
   srcpath    IN  VARCHAR2,
   destfolder IN  CARCHAR2,
   newname    IN  VARCHAR2);

パラメータ

表164-51 RENAMERESOURCEプロシージャのパラメータ

パラメータ	説明
srcpath	ソース・リソース宛先フォルダの階層内の絶対パス。
destfolder	宛先フォルダの階層内の絶対パス。
newname	宛先フォルダ内の子の名前。

---

SETACLプロシージャ

このプロシージャは、指定のリソースに対するACLを、パスで指定したACLに設定します。

構文

DBMS_XDB.SETACL(
   res_path   IN  VARCHAR2,
   acl_path   IN  VARCHAR2);

パラメータ

表164-52 SETACLプロシージャのパラメータ

パラメータ	説明
res_path	リソースの階層内の絶対パス。
acl_path	ACLの階層内の絶対パス。

使用上の注意

ユーザーには、リソースに対する<write-acl>権限が必要です。

---

SETCONTENTプロシージャ

このプロシージャは、リソースの内容を指定したデータ・タイプに置き換えます。

構文

リソースの内容を指定したCLOBに置き換えます。

DBMS_XDB.SETCONTENT(
     abspath    IN   VARCHAR2,
     data       IN   CLOB);

リソースの内容を指定したBLOBに置き換えます。

DBMS_XDB.SETCONTENT(
     abspath    IN   VARCHAR2,
     data       IN   BLOB,
     csid    IN PLS_INTEGER);

リソースの内容を指定したXMLTYPEに置き換えます。

DBMS_XDB.SETCONTENT(
     abspath    IN   VARCHAR2,
     data       IN   SYS.XMLTYPE);

リソースの内容を指定した文字列に置き換えます。

DBMS_XDB.SETCONTENT(
     abspath    IN   VARCHAR2,
     data       IN   VARCHAR2);

リソースの内容を指定したXMLTYPEへのREFに置き換えます。

DBMS_XDB.SETCONTENT(
     abspath    IN   VARCHAR2,
     data       IN   CLOB,
     sticky     IN   BOOLEAN := TRUE);

リソースの内容を指定したBFILEに置き換えます。

DBMS_XDB.SETCONTENT(
     abspath    IN   VARCHAR2,
     data       IN   CLOB,
     csid       IN   PLS_INTEGER);

パラメータ

表164-53 SETCONTENTプロシージャのパラメータ

パラメータ	説明
abspath	リソースの階層内の絶対パス。
data	オーバーロードによって異なる次の入力。 CLOBデータ BLOBデータ XMLTYPEデータ 文字列データ XMLTYPEへのREFデータ BFILE
csid	BLOBまたはBFILEのキャラクタ・セットID。
sticky	REFがスティッキーであるかどうか。

---

SETFTPPORTプロシージャ

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

構文

DBMS_XDB.SETFTPPORT(
   new_port  IN  NUMBER);

パラメータ

表164-54 SETFTPPORTプロシージャのパラメータ

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

---

SETHTTPPORTプロシージャ

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

構文

DBMS_XDB.SETHTTPPORT(
   new_port  IN  NUMBER);

パラメータ

表164-55 SETHTTPPORTプロシージャのパラメータ

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

---

SETLISTENERENDPOINTプロシージャ

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

構文

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

パラメータ

表164-56 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.SETLISTENERLOCALACCESS (
   l_access   BOOLEAN);

パラメータ

表164-57 SETLISTENERLOCALACCESSプロシージャのパラメータ

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

---

SPLITPATHプロシージャ

このプロシージャは、パスを親のパスと子のパスに分割します。

構文

DBMS_XDB.SPLITPATH(
      abspath     IN  VARCHAR2,
      parentpath  OUT VARCHAR2,
     childpath    OUT VARCHAR2);

パラメータ

表164-58 SPLITPATHプロシージャのパラメータ

パラメータ	説明
abspath	分割する絶対パス。
parentpath	親のパス。
childpath	子のパス。

---

TOUCHRESOURCEプロシージャ

このプロシージャは、リソースの変更時間を現在の時間に変更します。

構文

DBMS_XDB.DBMS_XDB.TOUCHRESOURCE 
     abspath    IN     VARCHAR2);

パラメータ

表164-59 DBMS_XDB.TOUCHRESOURCEプロシージャのパラメータ

パラメータ	説明
abspath_path	リソースの絶対パス。

---

UPDATERESOURCEMETADATAプロシージャ

このプロシージャは、リソースのメタデータを更新します。このプロシージャは、絶対パスで識別されるリソースおよび、そのREFで識別されて置き換えられる、そのリソース内のメタデータを使用します。メタデータの一部をユーザー定義のメタデータ(XMLTYPEへのREFまたはXMLTYPEのいずれかの形式)に置き換えます。

構文

次の構文は、スキーマ・ベースのメタデータの更新にのみ使用できます。新しいメタデータは、スキーマ・ベースである必要があります。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath  IN VARCHAR2,
   oldmetadata    IN   REF SYS.XMLTYPE,
   newmetadata    IN   REF SYS.XMLTYPE)
 

次の構文は、スキーマ・ベースのメタデータの更新にのみ使用できます。新しいメタデータは、スキーマ・ベースまたは非スキーマ・ベースである必要があります。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath        IN   VARCHAR2,
   oldmetadata    IN   REF SYS.XMLTYPE,
   newmetadata    IN   XMLTYPE);
 

次の構文は、スキーマ・ベースおよび非スキーマ・ベースの両方のメタデータに使用できます。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath        IN   VARCHAR2,
   oldns          IN   VARCHAR2,
   oldname IN VARCHAR,
   newmetadata IN XMLTYPE);
 

次の構文は、スキーマ・ベースおよび非スキーマ・ベースの両方のメタデータに使用できます。新しいメタデータは、スキーマ・ベースである必要があります。

DBMS_XDB.UPDATERESOURCEMETADATA(
   abspath       IN   VARCHAR2,
   oldns         IN   VARCHAR2,
   oldname       IN   VARCHAR,
   newmetadata   IN   REF SYS.XMLTYPE);

パラメータ

表164-60 UPDATERESOURCEMETADATAプロシージャのパラメータ

パラメータ	説明
abspath	リソースの絶対パス。
oldmetadata	古いメタデータへのREF。
newmetadata	新しい置換メタデータへのREF(オーバーロードに応じてスキーマ・ベースまたは非スキーマ・ベースのメタデータを使用できます)。
oldns	古いメタデータを識別するネームスペース。
oldname	古いメタデータを識別するローカル名。

使用上の注意

REFの場合、このプロシージャは、REFをリソースに、メタデータは別の表に格納します。REFの一意性が維持されます。XMLTYPEが渡された場合、データを解析してスキーマ・ベースかどうかを判断し、その結果に応じてデータを格納します。

---

UNLOCKRESOURCEファンクション

このファンクションは、ロック・トークンとリソースへのパスを指定して、リソースのロックを解除します。

構文

DBMS_XDB.UNLOCKRESOURCE(
   path     IN  VARCHAR2,
   deltoken IN  VARCHAR2)
 RETURN BOOLEAN;

パラメータ

表164-61 UNLOCKRESOURCEファンクションのパラメータ

パラメータ	説明
path	リソースへのパス名。
deltoken	削除するロック・トークン。

戻り値

操作が成功した場合はTRUE。

使用上の注意

ユーザーには、リソースに対するUPDATE権限が必要です。