日本語PDF

205 DBMS_XEVENT

DBMS_XEVENTパッケージは、イベント関連のタイプおよびサポートするサブプログラムを提供します。

この章のトピックは、次のとおりです:

参照:

Oracle XML DBリポジトリ・イベントの詳細は、『Oracle XML DB開発者ガイド』を参照してください。

205.1 DBMS_XEVENTのセキュリティ・モデル

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

205.2 DBMS_XEVENTの定数

DBMS_XEVENTパッケージは、パラメータ値の指定に使用できるいくつかの定数を定義します。

次の表に、定数の定義を示します。

表205-1 DBMS_XEVENTの定数

名前 タイプ 説明

RENDER_EVENT

PLS_INTEGER

1

PRE_CREATE_EVENT

PLS_INTEGER

2

POST_CREATE_EVENT

PLS_INTEGER

3

PRE_DELETE_EVENT

PLS_INTEGER

4

POST_DELETE_EVENT

PLS_INTEGER

5

PRE_UPDATE_EVENT

PLS_INTEGER

6

POST_UPDATE_EVENT

PLS_INTEGER

7

PRE_LOCK_EVENT

PLS_INTEGER

8

POST_LOCK_EVENT

PLS_INTEGER

9

PRE_UNLOCK_EVENT

PLS_INTEGER

10

POST_UNLOCK_EVENT

PLS_INTEGER

11

PRE_LINKIN_EVENT

PLS_INTEGER

12

POST_LINKIN_EVENT

PLS_INTEGER

13

PRE_LINKTO_EVENT

PLS_INTEGER

14

POST_LINKTO_EVENT

PLS_INTEGER

15

PRE_UNLINKIN_EVENT

PLS_INTEGER

16

POST_UNLINKIN_EVENT

PLS_INTEGER

17

PRE_UNLINKFROM_EVENT

PLS_INTEGER

18

POST_UNLINKFROM_EVENT

PLS_INTEGER

19

PRE_CHECKIN_EVENT

PLS_INTEGER

20

POST_CHECKIN_EVENT

PLS_INTEGER

21

PRE_CHECKOUT_EVENT

PLS_INTEGER

22

POST_CHECKOUT_EVENT

PLS_INTEGER

23

PRE_UNCHECKOUT_EVENT

PLS_INTEGER

24

POST_UNCHECKOUT_EVENT

PLS_INTEGER

25

PRE_VERSIONCONTROL_EVENT

PLS_INTEGER

26

POST_VERSIONCONTROL_EVENT

PLS_INTEGER

27

PRE_OPEN_EVENT

PLS_INTEGER

28

POST_OPEN_EVENT

PLS_INTEGER

29

PRE_INCONSISTENT_UPDATE_EVENT

PLS_INTEGER

30

POST_INCONSISTENT_UPDATE_EVENT

PLS_INTEGER

21

POST_CHECKIN_EVENT

PLS_INTEGER

21

205.3 サブプログラム・グループ

DBMS_XEVENTパッケージのサブプログラムはグループに分けることができます。

205.3.1 DBMS_XEVENT XDBEventタイプのサブプログラム

このサブプログラム・グループでは、XDBEventタイプで使用するインタフェースを提供しています。

表205-2 XDBEventのサブプログラム

サブプログラム 説明

GETCURRENTUSERファンクション

イベントをトリガーする操作を実行するユーザーの名前を戻します。

GETEVENTファンクション

トリガーするイベントを識別する値を戻します。

ISNULLファンクション

入力した引数がNULLの場合にTRUEを戻します。

このパッケージ内のすべてのサブプログラムのリストは、「DBMS_XEVENTサブプログラムの要約」を参照してください。

205.3.2 DBMS_XEVENT XDBRepositoryEventタイプのサブプログラム

このサブプログラム・グループでは、XDBRepositoryEventタイプと一緒に使用するインタフェースが提供されています。

表205-3 XDBRepositoryEventのサブプログラム

サブプログラム 説明

GETAPPLICATIONDATAファンクション

起動するハンドラを定義するリソース構成から抽出された<applicationData>要素を戻します。

GETHANDLERLISTファンクション

現在実行中のハンドラの後に実行されるハンドラのリストを含むXDBHandlerListオブジェクトを戻します。

GETINTERFACEファンクション

イベントをトリガーする操作を開始するときに使用するトップレベルのインタフェースを戻します。

GETLINKファンクション

ターゲット・リソースのXDBLinkオブジェクトを戻します。

GETLOCKファンクション

現在の操作に対応するロック・オブジェクトを戻します。

GETOLDRESOURCEファンクション

操作が実行される前の元のXDBResourceオブジェクトを戻します。

GETOPENACCESSMODEファンクション

オープン操作のアクセス・モードを戻します。

GETOPENDENYMODEファンクション

オープン操作の拒否モードを戻します。

GETOUTPUTSTREAMファンクション

表示されるデータをハンドラが書き込むことができる出力BLOBを戻します。

GETPARAMETERファンクション

要求固有またはセッション固有のパラメータの値を戻します。

GETPARENTファンクション

ターゲット・リソースの親フォルダに対応するリソース・オブジェクトを戻します。

GETPATHファンクション

イベントが起動されたリソースのパスを表すXDBPathオブジェクトを戻します。

GETRESOURCEファンクション

ターゲット・リソースの内容やメタデータにアクセスして変更するための手段を提供するXDBResourceオブジェクトを戻します。

GETUPDATEBYTECOUNTファンクション

現在の操作がバイト範囲書込みの場合、バイト数を戻します。

GETUPDATEBYTEOFFSETファンクション

現在の操作がバイト範囲書込みの場合、ファンクションは範囲の開始点となるバイト・オフセットを戻します。

GETXDBEVENTファンクション

XDBRepositoryEventオブジェクトをXDBEventタイプに変換します。

ISNULLファンクション

入力した引数がNULLの場合にTRUEを戻します。

SETRENDERPATHプロシージャ

表示された内容を含むリソースのパスを指定します。

SETRENDERSTREAMプロシージャ

表示される内容を読み取ることができるBLOBを設定します。

このパッケージ内のすべてのサブプログラムのリストは、「DBMS_XEVENTサブプログラムの要約」を参照してください。

205.3.3 DBMS_XEVENT XDBHandlerListタイプのサブプログラム

このサブプログラム・グループでは、XDBHandlerListタイプと一緒に使用するインタフェースが提供されています。

表205-4 XDBHandlerListのサブプログラム

サブプログラム 説明

CLEARプロシージャ

ハンドラ・リストをクリアします。

GETFIRSTファンクション

リスト内の最初のハンドラを戻します。

GETNAMEファンクション

リスト内の次のハンドラを戻します。

ISNULLファンクション

入力した引数がNULLの場合にTRUEを戻します。

REMOVEプロシージャ

指定のハンドラをハンドラ・リストから削除します。

このパッケージ内のすべてのサブプログラムのリストは、「DBMS_XEVENTサブプログラムの要約」を参照してください。

205.3.4 DBMS_XEVENT XDBHandlerタイプのサブプログラム

このサブプログラム・グループでは、XDBHandlerタイプと一緒に使用するインタフェースが提供されています。

表205-5 XDBHandlerタイプのサブプログラム

サブプログラム 説明

GETLANGUAGEファンクション

ハンドラの実装言語を戻します。

GETSCHEMAファンクション

ハンドラのソースのスキーマを戻します。

GETSOURCEファンクション

ハンドラを実装するJavaクラス、PL/SQLパッケージまたはオブジェクト・タイプの名前を戻します。

ISNULLファンクション

入力した引数がNULLの場合にTRUEを戻します。

このパッケージ内のすべてのサブプログラムのリストは、「DBMS_XEVENTサブプログラムの要約」を参照してください。

205.3.5 DBMS_XEVENT XDBPathタイプのサブプログラム

このサブプログラム・グループでは、XDBPathタイプと一緒に使用するインタフェースが提供されています。

表205-6 XDBPathタイプのサブプログラム

サブプログラム 説明

GETNAMEファンクション

パスの文字列表現を戻します。

GETPARENTPATHファンクション

親のパスを戻します。

ISNULLファンクション

入力した引数がNULLの場合にTRUEを戻します。

このパッケージ内のすべてのサブプログラムのリストは、「DBMS_XEVENTサブプログラムの要約」を参照してください。

205.3.6 DBMS_XEVENT XDBLinkタイプのサブプログラム

このサブプログラム・グループでは、XDBLinkタイプと一緒に使用するインタフェースが提供されています。

表205-7 XDBLinkタイプのサブプログラム

サブプログラム 説明

GETCHILDOIDファンクション

リンクが指しているリソースのOIDを戻します。

GETPARENTNAMEファンクション

リンクの親フォルダの名前を戻します。

GETPARENTOIDファンクション

リンクの親フォルダのOIDを戻します。

ISNULLファンクション

入力した引数がNULLの場合にTRUEを戻します。

このパッケージ内のすべてのサブプログラムのリストは、「DBMS_XEVENTサブプログラムの要約」を参照してください。

205.4 DBMS_XEVENTサブプログラムの要約

この表は、DBMS_XEVENTサブプログラムを示し、簡単に説明しています。

表205-8 DBMS_XEVENTパッケージのサブプログラム

サブプログラム 説明 グループ

CLEARプロシージャ

ハンドラ・リストをクリアします。

XDBHandlerListタイプのサブプログラム

GETAPPLICATIONDATAファンクション

起動するハンドラを定義するリソース構成から抽出された<applicationData>要素を戻します。

XDBRepositoryEventタイプのサブプログラム

GETCHILDOIDファンクション

リンクが指しているリソースのOIDを戻します。

XDBLinkタイプのサブプログラム

GETCURRENTUSERファンクション

イベントをトリガーする操作を実行するユーザーの名前を戻します。

XDBEventタイプのサブプログラム

GETEVENTファンクション

トリガーするイベントを識別する値を戻します。

XDBEventタイプのサブプログラム

GETFIRSTファンクション

リスト内の最初のハンドラを戻します。

XDBHandlerListタイプのサブプログラム

GETHANDLERLISTファンクション

現在実行中のハンドラの後に実行されるハンドラのリストを含むXDBHandlerListオブジェクトを戻します。

XDBRepositoryEventタイプのサブプログラム

GETINTERFACEファンクション

イベントをトリガーする操作を開始するときに使用するトップレベルのインタフェースを戻します。

XDBRepositoryEventタイプのサブプログラム

GETLANGUAGEファンクション

ハンドラの実装言語を戻します。

XDBHandlerタイプのサブプログラム

GETLINKファンクション

ターゲット・リソースのXDBLinkオブジェクトを戻します。

XDBRepositoryEventタイプのサブプログラム

GETLOCKファンクション

現在の操作に対応するロック・オブジェクトを戻します。

XDBRepositoryEventタイプのサブプログラム

GETNAMEファンクション

パスの文字列表現を戻します。

XDBPathタイプのサブプログラム

GETNAMEファンクション

リスト内の次のハンドラを戻します。

XDBHandlerListタイプのサブプログラム

GETOLDRESOURCEファンクション

操作が実行される前の元のXDBResourceオブジェクトを戻します。

XDBRepositoryEventタイプのサブプログラム

GETOPENACCESSMODEファンクション

オープン操作のアクセス・モードを戻します。

XDBRepositoryEventタイプのサブプログラム

GETOPENDENYMODEファンクション

オープン操作の拒否モードを戻します。

XDBRepositoryEventタイプのサブプログラム

GETOUTPUTSTREAMファンクション

表示されるデータをハンドラが書き込むことができる出力BLOBを戻します。

XDBRepositoryEventタイプのサブプログラム

GETPARAMETERファンクション

要求固有またはセッション固有のパラメータの値を戻します。

XDBRepositoryEventタイプのサブプログラム

GETPARENTファンクション

ターゲット・リソースの親フォルダに対応するリソース・オブジェクトを戻します。

XDBRepositoryEventタイプのサブプログラム

GETPARENTNAMEファンクション

リンクの親フォルダの名前を戻します。

XDBLinkタイプのサブプログラム

GETPARENTOIDファンクション

リンクの親フォルダのOIDを戻します。

XDBLinkタイプのサブプログラム

GETPARENTNAMEファンクション

親のパスを戻します。

XDBPathタイプのサブプログラム

GETPATHファンクション

イベントが起動されたリソースのパスを表すXDBPathオブジェクトを戻します。

XDBRepositoryEventタイプのサブプログラム

GETRESOURCEファンクション

ターゲット・リソースの内容やメタデータにアクセスして変更するための手段を提供するXDBResourceオブジェクトを戻します。

XDBRepositoryEventタイプのサブプログラム

GETSCHEMAファンクション

ハンドラのソースのスキーマを戻します。

XDBHandlerタイプのサブプログラム

GETSOURCEファンクション

ハンドラを実装するJavaクラス、PL/SQLパッケージまたはオブジェクト・タイプの名前を戻します。

XDBHandlerタイプのサブプログラム

GETUPDATEBYTECOUNTファンクション

現在の操作がバイト範囲書込みの場合、バイト数を戻します。

XDBRepositoryEventタイプのサブプログラム

GETUPDATEBYTEOFFSETファンクション

現在の操作がバイト範囲書込みの場合、ファンクションは範囲の開始点となるバイト・オフセットを戻します。

XDBRepositoryEventタイプのサブプログラム

GETXDBEVENTファンクション

XDBRepositoryEventオブジェクトをXDBEventタイプに変換します。

XDBRepositoryEventタイプのサブプログラム

ISNULLファンクション

入力した引数がNULLの場合にTRUEを戻します。

XDBEventタイプのサブプログラム

XDBRepositoryEventタイプのサブプログラム

XDBHandlerListタイプのサブプログラム

XDBHandlerタイプのサブプログラム

XDBPathタイプのサブプログラム

REMOVEプロシージャ

指定のハンドラをハンドラ・リストから削除します。

XDBHandlerListタイプのサブプログラム

SETRENDERPATHプロシージャ

表示された内容を含むリソースのパスを指定します。

XDBRepositoryEventタイプのサブプログラム

SETRENDERSTREAMプロシージャ

表示される内容を読み取ることができるBLOBを設定します。

XDBRepositoryEventタイプのサブプログラム

205.4.1 CLEARプロシージャ

このプロシージャは、ハンドラ・リストをクリアします。

参照:

このグループの他のサブプログラムについては、「XDBHandlerListタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.CLEAR (
    hl       IN OUT   XDBHandlerList);

パラメータ

表205-9 CLEARプロシージャのパラメータ

パラメータ 説明

hl

ハンドラのリスト。

205.4.2 GETAPPLICATIONDATAファンクション

このファンクションは、起動するハンドラを定義するリソース構成から抽出された<applicationData>要素を戻します。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETAPPLICATIONDATA (
    ev   IN   XDBRepositoryEvent) 
  RETURN XMLType;

パラメータ

表205-10 GETAPPLICATIONDATAファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.3 GETCHILDOIDファンクション

このファンクションは、リンクが指しているリソースのOIDを戻します。

参照:

このグループの他のサブプログラムについては、「XDBLinkタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETCHILDOID (
    link   IN   XDBLink) 
  RETURN RAW;

パラメータ

表205-11 GETCHILDOIDファンクションのパラメータ

パラメータ 説明

link

リンク。

205.4.4 GETCURRENTUSERファンクション

このファンクションは、イベントをトリガーする操作を実行するユーザーの名前を戻します。

参照:

このグループの他のサブプログラムについては、「XDBEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETCURRENTUSER (
    ev   IN   XDBEvent) 
  RETURN VARCHAR2;

パラメータ

表205-12 GETCURRENTUSERファンクションのパラメータ

パラメータ 説明

ev

XDBEventタイプのイベント。

205.4.5 GETEVENTファンクション

このファンクションは、イベントをトリガーする操作を実行するユーザーの名前を戻します。

参照:

このグループの他のサブプログラムについては、「XDBEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETEVENT (
    ev   IN   XDBEvent) 
  RETURN XDBEventID;

パラメータ

表205-13 GETEVENTファンクションのパラメータ

パラメータ 説明

ev

XDBEventタイプのイベント。

205.4.6 GETFIRSTファンクション

このファンクションは、リスト内の最初のハンドラを戻します。

参照:

このグループの他のサブプログラムについては、「XDBHandlerListタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETFIRST (
    hl   IN   XDBHandlerList) 
  RETURN XDBHandler;

パラメータ

表205-14 GETFIRSTファンクションのパラメータ

パラメータ 説明

hl

ハンドラのリスト。

205.4.7 GETHANDLERLISTファンクション

このファンクションは、現在実行中のハンドラの後に実行されるハンドラのリストが含まれているXDBHandlerListオブジェクトを戻します。

その後、現在のハンドラはセキュリティ・チェックに従い、必要に応じて後続の一部のハンドラを除外できます。リスト内のハンドラに関連するリソース構成のいずれかに対して必要なアクセス権限が実行ユーザーにない場合、不十分な権限例外が発生します。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETHANDLERLIST (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBHandlerList;

パラメータ

表205-15 GETHANDLERLISTファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.8 GETINTERFACEファンクション

このファンクションは、イベントをトリガーする操作を開始するときに使用するトップレベルのインタフェースを戻します。これは、HTTP、FTPまたはSQLです。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETINTERFACE (
    ev   IN   XDBRepositoryEvent) 
  RETURN VARCHAR2;

パラメータ

表205-16 GETINTERFACEファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.9 GETLANGUAGEファンクション

このファンクションは、ハンドラの実装言語を戻します。

参照:

このグループの他のサブプログラムについては、「XDBHandlerタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETLANGUAGE (
    handler   IN   XDBHandler) 
  RETURN VARCHAR2;

パラメータ

表205-17 GETLANGUAGEファンクションのパラメータ

パラメータ 説明

handler

ハンドラ。

205.4.10 GETLINKファンクション

このファンクションは、ターゲット・リソースのXDBLinkオブジェクトを戻します。

リンク*またはリンク解除*イベントの場合、これは操作に関連するリンクとなります。その他のイベントの場合は、エラーが戻されます。このオブジェクトを使用して、ハンドラは、ParentNameParentOIDChildOIDLinkNameなどのリンク・プロパティにアクセスできます。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETLINK (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBLink;

パラメータ

表205-18 GETLINKファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.11 GETLINKNAMEファンクション

このファンクションは、リンクの名前を戻します。

参照:

このグループの他のサブプログラムについては、「XDBLinkタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETLINKNAME (
    link   IN   XDBLink) 
  RETURN VARCHAR2;

パラメータ

表205-19 GETLINKNAMEファンクションのパラメータ

パラメータ 説明

link

リンク。

205.4.12 GETLOCKファンクション

このファンクションは、現在の操作に対応するロック・オブジェクトを戻し、ロック・イベントおよびロック解除イベントに対してのみ有効となります。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETLOCK  (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBLock;

パラメータ

表205-20 GETLOCKファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.13 GETLANGUAGEファンクション

このファンクションは、ハンドラの実装言語を戻します。

参照:

このグループの他のサブプログラムについては、「XDBHandlerタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETLANGUAGE (
    handler   IN   XDBHandler) 
  RETURN VARCHAR2;

パラメータ

表205-21 GETLANGUAGEファンクションのパラメータ

パラメータ 説明

handler

ハンドラ。

205.4.14 GETNAMEファンクション

このファンクションは、パスの文字列表現を戻します。

参照:

このグループの他のサブプログラムについては、「XDBPathタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETNAME (
    path   IN   XDBPath) 
  RETURN VARCHAR2;

パラメータ

表205-22 GETNAMEファンクションのパラメータ

パラメータ 説明

path

パス。

205.4.15 GETNEXTファンクション

このファンクションは、リスト内の次のハンドラを戻します。

参照:

このグループの他のサブプログラムについては、「XDBHandlerListタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETNEXT (
    hl   IN   XDBHandlerList) 
  RETURN XDBHandler;

パラメータ

表205-23 GETNEXTファンクションのパラメータ

パラメータ 説明

hl

ハンドラのリスト。

205.4.16 GETOLDRESOURCEファンクション

このファンクションは、操作が実行される前の元のXDBResourceオブジェクトを戻します。

このメソッドは、更新イベントのみに適用されます。その他のイベントの場合は、エラーが戻されます。これは読取り専用オブジェクトであるため、このオブジェクトに対してはいずれの修飾子メソッドも機能しません。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETOLDRESOURCE (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBResource;

パラメータ

表205-24 GETOLDRESOURCEファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.17 GETOPENACCESSMODEファンクション

このファンクションは、オープン操作のアクセス・モードを戻します。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETOPENACCESSMODE (
    ev   IN   XDBRepositoryEvent) 
  RETURN PLS_INTEGER;

パラメータ

表205-25 GETOPENACCESSMODEファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

戻り値

  • XDBRepositoryEvent.OPEN_ACCESS_READ(値1)

  • XDBRepositoryEvent.OPEN_ACCESS_WRITE(値2)

  • XDBRepositoryEvent.OPEN_ACCESS_READ_WRITE(値3)

205.4.18 GETOPENDENYMODEファンクション

このファンクションは、オープン操作の拒否モードを戻します。このファンクションは、オープン・イベントに対してのみ有効です。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETOPENDENYMODE (
    ev   IN   XDBRepositoryEvent) 
  RETURN PLS_INTEGER;

パラメータ

表205-26 GETOPENDENYMODEファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

戻り値

  • XDBRepositoryEvent.OPEN_DENY_NONE(値0)

  • XDBRepositoryEvent.OPEN_DENY_READ(値1)

  • XDBRepositoryEvent.OPEN_DENY_READ_WRITE(値2)

205.4.19 GETOUTPUTSTREAMファンクション

このファンクションは、表示されるデータをハンドラが書き込むことができる出力BLOBを戻します。このファンクションは、表示イベントに対してのみ有効です。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETOUTPUTSTREAM (
    ev   IN   XDBRepositoryEvent) 
  RETURN BLOB;

パラメータ

表205-27 GETOUTPUTSTREAMファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.20 GETPARAMETERファンクション

このファンクションは、要求固有またはセッション固有のパラメータの値を戻します。keyパラメータの定義は、RFC 2616(HTTP/1.1)にあります。この定義は、同等のSQLセッションのパラメータ(ある場合)にマップされます。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETPARAMETER (
    ev   IN   XDBRepositoryEvent,
    key  IN   VARCHAR2) 
  RETURN VARCHAR2;

パラメータ

表205-28 GETPARAMETERファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

key

次のパラメータがサポートされています。

  • ACCEPT

  • ACCEPT-LANGUAGE

  • ACCEPT-CHARSET

  • ACCEPT_ENCODING

205.4.21 GETPARENTファンクション

このファンクションは、ターゲット・リソースの親フォルダに対応するリソース・オブジェクトを戻します。このリソース・オブジェクトは、ターゲット・リソースへのリンクが含まれている任意のフォルダである可能性があることに注意してください。これは読取り専用オブジェクトであるため、このオブジェクトに対してはいずれの修飾子メソッドも機能しません。リンク*またはリンク解除*イベントでは、このメソッドはリンクの親フォルダを戻します。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETPARENT (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBResource;

パラメータ

表205-29 GETPARENTファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.22 GETPARENTNAMEファンクション

このファンクションは、リンクの親フォルダの名前を戻します。

参照:

このグループの他のサブプログラムについては、「XDBLinkタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETPARENTNAME (
    link   IN   XDBLink) 
  RETURN VARCHAR2;

パラメータ

表205-30 GETPARENTNAMEファンクションのパラメータ

パラメータ 説明

link

リンク。

205.4.23 GETPARENTOIDファンクション

このファンクションは、リンクの親フォルダのOIDを戻します。

参照:

このグループの他のサブプログラムについては、「XDBLinkタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETPARENTOID (
    link   IN   XDBLink) 
  RETURN RAW;

パラメータ

表205-31 GETPARENTOIDファンクションのパラメータ

パラメータ 説明

link

リンク。

205.4.24 GETPARENTPATHファンクション

このファンクションは、親のパスを戻します。レベルは、階層までのレベルの数を示します。この値は0(ゼロ)より大きい必要があります。レベル1は直接の親を示します。レベルがツリーの高さを超える場合、NULLが戻されます。

参照:

このグループの他のサブプログラムについては、「XDBPathタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETPARENTPATH (
    path   IN   XDBPath,
   level   IN   INTEGER) 
  RETURN XDBPath;

パラメータ

表205-32 GETPARENTPATHファンクションのパラメータ

パラメータ 説明

path

パス。

level

階層までのレベルの数。

205.4.25 GETPATHファンクション

このファンクションは、イベントが起動されたリソースのパスを表すXDBPathオブジェクトを戻します。このオブジェクトから、異なるパス・セグメントの取得にファンクションが使用されます。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETPATH (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBPath;

パラメータ

表205-33 GETPATHファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.26 GETRESOURCEファンクション

このファンクションは、ターゲット・リソースの内容やメタデータにアクセスして変更するための手段を提供するXDBResourceオブジェクトを戻します。このオブジェクトは、以前のハンドラがリソースに対して行ったすべての変更を反映します。

修飾子メソッドは、事前作成イベント・ハンドラおよび事前更新イベント・ハンドラでのみ機能します。リンク*またはリンク解除*イベントでは、このメソッドはリンクが指すリソースを戻します。作成イベントでは、このメソッドは作成するリソースを戻します。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETRESOURCE (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBResource;

パラメータ

表205-34 GETRESOURCEファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.27 GETSCHEMAファンクション

このファンクションは、ハンドラのソースのスキーマを戻します。

参照:

このグループの他のサブプログラムについては、「XDBHandlerタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETSCHEMA (
    handler   IN   XDBHandler) 
  RETURN VARCHAR2;

パラメータ

表205-35 GETSCHEMAファンクションのパラメータ

パラメータ 説明

handler

ハンドラ。

205.4.28 GETSOURCEファンクション

このファンクションは、ハンドラを実装するJavaクラス、PL/SQLパッケージまたはオブジェクト・タイプの名前を戻します。

参照:

このグループの他のサブプログラムについては、「XDBHandlerタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETSOURCE (
    handler   IN   XDBHandler) 
  RETURN VARCHAR2;

パラメータ

表205-36 GETSOURCEファンクションのパラメータ

パラメータ 説明

handler

ハンドラ。

205.4.29 GETUPDATEBYTECOUNTファンクション

現在の操作がバイト範囲書込みの場合、GETUPDATEBYTECOUNTファンクションはバイト数を戻します。これは整合性がない更新イベントに対してのみ有効です。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETUPDATEBYTECOUNT (
    ev   IN   XDBRepositoryEvent) 
  RETURN NUMBER;

パラメータ

表205-37 GETUPDATEBYTECOUNTファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.30 GETUPDATEBYTEOFFSETファンクション

現在の操作がバイト範囲書込みの場合、GETUPDATEBYTEOFFSETファンクションは範囲の開始点となるバイト・オフセットを戻します。これは整合性がない更新イベントに対してのみ有効です。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETUPDATEBYTEOFFSET (
    ev   IN   XDBRepositoryEvent) 
  RETURN NUMBER;

パラメータ

表205-38 GETUPDATEBYTEOFFSETファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.31 GETXDBEVENTファンクション

このファンクションは、XDBRepositoryEventオブジェクトをXDBEventタイプに変換します。

参照:

このグループの他のサブプログラムについては、「XDBRepositoryEventタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.GETXDBETEVENT (
    ev   IN   XDBRepositoryEvent) 
  RETURN XDBEvent;

パラメータ

表205-39 GETXDBEVENTファンクションのパラメータ

パラメータ 説明

ev

XDBRepositoryEventタイプのイベント。

205.4.32 ISNULLファンクション

このファンクションは、入力した引数がNULLの場合、TRUEを戻します。

参照:

構文

DBMS_XEVENT.ISNULL (
    ev         IN   XDBEvent) 
  RETURN BOOLEAN;

DBMS_XEVENT.ISNULL (
    ev         IN   XDBRepositoryEvent) 
  RETURN BOOLEAN;

DBMS_XEVENT.ISNULL (
    hl         IN   XDBHandlerList) 
  RETURN BOOLEAN;

DBMS_XEVENT.ISNULL (
    handler    IN   XDBHandler) 
  RETURN BOOLEAN;
  RETURN BOOLEAN;

DBMS_XEVENT.ISNULL (
    path       IN   XDBPath) 
  RETURN BOOLEAN;

DBMS_XEVENT.ISNULL (
    link       IN   XDBLink) 
  RETURN BOOLEAN;

パラメータ

表205-40 ISNULLファンクションのパラメータ

パラメータ 説明

ev

指定したタイプのイベント。

hl

ハンドラのリスト。

handler

ハンドラ。

path

パス。

205.4.33 REMOVEプロシージャ

このプロシージャは、指定のハンドラをハンドラ・リストから削除します。

参照:

このグループの他のサブプログラムについては、「XDBHandlerListタイプのサブプログラム」を参照してください。

構文

DBMS_XEVENT.REMOVE (
    hl       IN OUT   XDBHandlerList, 
    handler  IN       XDBHandler);

パラメータ

表205-41 REMOVEプロシージャのパラメータ

パラメータ 説明

hl

ハンドラのリスト。

handler

ハンドラ。

205.4.34 SETRENDERPATHプロシージャ

このプロシージャは、表示された内容を含むリソースのパスを指定します。

GETOUTPUTSTREAMファンクションによって戻されたストリームが書き込まれた後、またはSETRENDERSTREAMプロシージャがコールされた後に、このプロシージャをコールするとエラーが発生するので、これは行わないでください。これは表示イベントに対してのみ有効です。

構文

DBMS_XEVENT.SETRENDERPATH (
    ev     IN   XDBRepositoryEvent, 
    path   IN   VARCHAR2);

パラメータ

表205-42 SETRENDERPATHプロシージャのパラメータ

パラメータ 説明

ev

XDBリポジトリ・イベントのオブジェクト。

path

表示された内容を含むリソースのパス。

205.4.35 SETRENDERSTREAMプロシージャ

このプロシージャは、表示される内容を読み取ることができるBLOBを設定します。

GETOUTPUTSTREAMによって戻されたストリームが書き込まれた後、またはSETRENDERPATHがコールされた後に、このプロシージャをコールするとエラーが発生するので、これは行わないでください。これは表示イベントに対してのみ有効です。

構文

DBMS_XEVENT.SETRENDERSTREAM (
    ev    IN   XDBRepositoryEvent, 
    istr  IN   BLOB);

パラメータ

表205-43 SETRENDERSTREAMプロシージャのパラメータ

パラメータ 説明

ev

XDBRepositoryEventのオブジェクト。

istr

表示された内容を取得する入力ストリーム。