108 DBMS_MGWADM
DBMS_MGWADM
は、メッセージ・ゲートウェイの管理インタフェースを定義します。パッケージとオブジェクト・タイプの所有者はSYS
です。
ノート:
catmgw.sql
スクリプトを実行して、メッセージ・ゲートウェイのパッケージおよびタイプをデータベースにロードする必要があります。
参照:
データベース・オブジェクトのロード方法およびDBMS_MGWADM
の使用方法は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』を参照してください。
この章のトピックは、次のとおりです:
108.2 DBMS_MGWADMの推奨されないサブプログラム
新しいアプリケーションでは、推奨されないプロシージャは使用しないことをお薦めします。推奨されない機能は、下位互換性を維持する目的のみでサポートされています。
次のサブプログラムは、Oracle Database 11g リリース1では改良されたテクノロジで置き換えられているため、推奨されていません。
-
ADD_SUBSCRIBERプロシージャ: かわりにCREATE_JOBプロシージャを使用します。
-
ALTER_PROPAGATION_SCHEDULEプロシージャ: かわりにALTER_JOBプロシージャを使用します。
-
ALTER_SUBSCRIBERプロシージャ: かわりにALTER_JOBプロシージャを使用します。
-
DB_CONNECT_INFOプロシージャ: かわりにALTER_AGENTプロシージャを使用します。
-
DISABLE_PROPAGATION_SCHEDULEプロシージャ: かわりにDISABLE_JOBプロシージャを使用します。
-
ENABLE_PROPAGATION_SCHEDULEプロシージャ: かわりにENABLE_JOBプロシージャを使用します。
-
REMOVE_SUBSCRIBERプロシージャ: かわりにREMOVE_JOBプロシージャを使用します。
-
RESET_SUBSCRIBERプロシージャ: かわりにRESET_JOBプロシージャを使用します。
-
SCHEDULE_PROPAGATIONプロシージャ: かわりにCREATE_JOBプロシージャを使用します。
-
UNSCHEDULE_PROPAGATIONプロシージャ: かわりにREMOVE_JOBプロシージャを使用します。
108.3 DBMS_MGWADMの定数
DBMS_MGWADM
パッケージは、パラメータ値の指定に使用する様々な定数を定義します。
表108-1 DBMS_MGWADM定数: クリーンアップ処理
名前 | タイプ | 説明 |
---|---|---|
|
|
メッセージ・ゲートウェイ・エージェントを既知の状態に設定して、起動できるようにします。 |
|
|
構成されたすべてのメッセージ・システム・リンクのログ・キューをメッセージ・ゲートウェイ・エージェントによってクリアします。 |
|
|
ログ・レコードが存在しないためにエラーになったメッセージ・ゲートウェイ・サブスクライバをメッセージ・ゲートウェイ・エージェントによって復元します。 |
|
|
永続ソース・メッセージが存在しないためにエラーになったメッセージ・ゲートウェイ・サブスクライバをメッセージ・ゲートウェイ・エージェントによって復元します。 |
表108-2 DBMS_MGWADM定数: 強制値
名前 | タイプ | 説明 |
---|---|---|
|
|
強制処理を表します。 |
|
|
通常の非強制処理を表します。 |
表108-3 DBMS_MGWADM定数: ロギング・レベル
名前 | タイプ | 説明 |
---|---|---|
|
|
ログ・ファイルに書き込まれる標準(最小限の)情報 |
|
|
ログ・ファイルに書き込まれる最大限の情報 |
|
|
ログ・ファイルに書き込まれるログ情報の第3レベルの詳細 |
|
|
ログ・ファイルに書き込まれるログ情報の第2レベルの詳細 |
表108-4 DBMS_MGWADM定数: 名前付きのプロパティの定数
名前 | タイプ | 説明 |
---|---|---|
|
|
予約済のプロパティ名接頭辞の定数( |
|
|
既存のプロパティを削除するために使用される予約済のプロパティ名の定数( |
|
|
すべてのプロパティを削除するために使用される予約済のプロパティ名の定数( |
表108-5 DBMS_MGWADM定数: その他の定数
名前 | タイプ | 説明 |
---|---|---|
|
|
JMSコネクションを使用して、ドメインに依存しない方法(統一されたメッセージ・モデルがサポートされている方法)で、JMS宛先にアクセスすることを示します。 |
|
|
JMSキュー・コネクションを使用してJMS宛先にアクセスすることを示します。 |
|
|
JMSトピック・コネクションを使用してJMS宛先にアクセスすることを示します。 |
|
|
既存の値を保持する(変更しない)ことを示します。これは、1つ以上のパラメータを変更し、その他のパラメータは変更しない場合に、特定のAPIに使用されます。 |
|
|
デフォルトのメッセージ・ゲートウェイ・エージェントの名前。 |
表108-6 DBMS_MGWADM定数: 伝播タイプ
名前 | タイプ | 説明 |
---|---|---|
|
|
Oracle以外からOracle Databaseアドバンスト・キューイングへの伝播用の伝播タイプを表します。伝播ソースは外部(Oracle以外の)メッセージ・システムのキューで、宛先はローカルOracle Databaseアドバンスト・キューイング・キューです。 |
|
|
Oracle Databaseアドバンスト・キューイングからOracle以外への伝播用の伝播タイプを表します。伝播ソースはローカルOracle Databaseアドバンスト・キューイング・キューで、宛先は外部(Oracle以外の)メッセージ・システムのキューです。 |
表108-7 DBMS_MGWADM定数: キュー・ドメイン・タイプ
名前 | タイプ | 説明 |
---|---|---|
|
|
キューの宛先を表します。JMSキュー(Point-to-Pointモデル)はキューとして分類されます。 |
|
|
トピックの宛先を表します。JMSトピック(パブリッシュ・サブスクライブ・モデル)はトピックとして分類されます。 |
表108-8 DBMS_MGWADM定数: 停止モード
名前 | タイプ | 説明 |
---|---|---|
|
|
即時停止モードを表します。 |
|
|
通常の停止モードを表します。 |
表108-9 DBMS_MGWADMの定数 - WebSphere MQインタフェース・タイプ
名前 | タイプ | 説明 |
---|---|---|
|
|
WebSphere MQメッセージ・システム用のBase Javaインタフェースを表します。 |
表108-10 DBMS_MGWADM定数: SET_OPTIONおよびREMOVE_OPTIONプロシージャのtarget_type引数
名前 | タイプ | 説明 |
---|---|---|
|
|
Java Systemプロパティを設定する場合に使用されるエージェント・オプション用。 |
|
|
メッセージ・システム・リンク・オプション用。 |
|
|
伝播ジョブ・オプション用。 |
表108-11 DBMS_MGWADM定数: CREATE_AGENTおよびALTER_AGENTプロシージャのconntype引数
名前 | タイプ | 説明 |
---|---|---|
|
|
JDBC OCIドライバの指定用 |
|
|
JDBC Thinドライバの指定用 |
108.4 DBMS_MGWADMのデータ構造
DBMS_MGWADM
パッケージは、複数のOBJECT
タイプを定義します。
108.4.1 DBMS_MGWADM SYS.MGW_MQSERIES_PROPERTIESオブジェクト・タイプ
このタイプは、WebSphere MQメッセージ・システム・リンクの基本プロパティを指定します。
構文
TYPE SYS.MGW_MQSERIES_PROPERTIES IS OBJECT ( queue_manager VARCHAR2(64), hostname VARCHAR2(64), port INTEGER, channel VARCHAR2(64), interface_type INTEGER, username VARCHAR2(64), password VARCHAR2(64), inbound_log_queue VARCHAR2(64), outbound_log_queue VARCHAR2(64), -- Methods STATIC FUNCTION construct RETURN SYS.MGW_MQSERIES_PROPERTIES, STATIC FUNCTION alter_construct RETURN SYS.MGW_MQSERIES_PROPERTIES );
属性
表108-12 SYS.MGW_MQSERIES_PROPERTIESの属性
属性 | 説明 |
---|---|
|
WebSphere MQキュー・マネージャの名前。 |
|
WebSphere MQメッセージ・システムが常駐しているホスト。ホスト名が |
|
ポート番号。クライアント接続の場合のみ、つまり |
|
キュー・マネージャへの接続の確立時に使用されるチャネル。クライアント接続の場合のみ、つまり |
|
使用するメッセージ・インタフェースのタイプ。値:
|
|
WebSphere MQメッセージ・システムに対する認証に使用されるユーザー名。 |
|
WebSphere MQメッセージ・システムに対する認証に使用されるパスワード。 |
|
このメッセージ・リンクがインバウンド伝播に使用される場合、つまり、このリンクと関連付けられたキューが伝播ソースとして機能する場合に、伝播リカバリの目的で使用されるWebSphere MQキューの名前。
|
|
このメッセージ・リンクがアウトバウンド伝播に使用される場合、つまり、このリンクと関連付けられたキューが伝播宛先として機能する場合に、伝播リカバリの目的で使用されるWebSphere MQキューの名前。
|
メソッド
表108-13 SYS.MGW_MQSERIES_PROPERTIESメソッド
メソッド | 説明 |
---|---|
|
新規 |
|
既存のメッセージ・リンクのプロパティを変更するために、新規 |
108.4.2 DBMS_MGWADM SYS.MGW_PROPERTIESオブジェクト・タイプ
このタイプは、プロパティの配列を指定します。
構文
TYPE SYS.MGW_PROPERTIES AS VARRAY (2000) OF SYS.MGW_PROPERTY;
属性
表108-14 SYS.MGW_PROPERTIESの属性
属性 | 説明 |
---|---|
|
プロパティ名 |
|
プロパティ値 |
使用上のノート
特に注記がないかぎり、メッセージ・ゲートウェイは、名前付きのプロパティを次のように使用します。
-
MGWPROP$_
接頭辞が付いた名前は予約されています。これらは、特別な目的で使用されており、通常のプロパティ名として使用された場合は無効です。 -
プロパティ名は、プロパティ・リストに1回のみ記述できるため、リストには特定の名前に対して1つの値のみ指定できます。名前は大/小文字の区別があります。
-
通常、プロパティ・リストは順序に依存せず、プロパティ名は任意の順序で表示される場合があります。変更プロパティ・リストは例外です。
-
新しいプロパティ・リストを使用して、既存のプロパティ・リストを変更できます。新規プロパティを使用して既存のプロパティ・リストを変更するには、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除という4通りの方法があります。
変更リストは、最初の要素から最後の要素まで順に処理されます。したがって、変更リストの要素の順序は重要です(特に既存のリストからプロパティを削除するために使用する場合)。
その要素が元のリストにどのように作用するかを判別するために、プロパティ名と値が使用されます。以下のルールが適用されます。
-
プロパティの追加または変更
MGW_PROPERTY.NAME = property_name MGW_PROPERTY.VALUE = property_value
指定した名前のプロパティがすでに存在している場合、現行の値は新しい値で置き換えられます。プロパティが存在していない場合は、新規プロパティがリストの最後に追加されます。
-
プロパティの削除
MGW_PROPERTY.NAME = 'MGWPROP$_REMOVE' MGW_PROPERTY.VALUE = name_of_property_to_remove
プロパティ名が元のリストに存在しない場合、処理は何も行われません。
-
すべてのプロパティの削除
MGW_PROPERTY.NAME = 'MGWPROP$_REMOVE_ALL' MGW_PROPERTY.VALUE = not used
参照:
DBMS_MGWADM
パッケージは、表108-4に示されている予約済のプロパティ名を表す定数を定義しています。
108.4.3 DBMS_MGWADM SYS.MGW_PROPERTYオブジェクト・タイプ
このタイプは、メッセージ・リンク、外部キューおよびサブスクライバのオプションのプロパティを指定するために使用される名前付きのプロパティを指定します。
構文
TYPE SYS.MGW_PROPERTY IS OBJECT( name VARCHAR2(500), value VARCHAR2(4000), -- Methods STATIC FUNCTION construct --- (1) RETURN SYS.MGW_PROPERTY, STATIC FUNCTION construct( --- (2) p_name IN VARCHAR2, p_value IN VARCHAR2) RETURN SYS.MGW_PROPERTY );
属性
表108-15 SYS.MGW_PROPERTYの属性
属性 | 説明 |
---|---|
|
プロパティ名 |
|
プロパティ値 |
メソッド
表108-16 SYS.MGW_PROPERTYメソッド
メソッド | 説明 |
---|---|
|
新規 |
|
特定のパラメータを使用して初期化される新規 |
参照:
DBMS_MGWADM
パッケージは、表108-4に示されている予約済のプロパティ名を表す定数を定義しています。
108.4.4 SYS.MGW_TIBRV_PROPERTIESオブジェクト・タイプ
このタイプは、TIB/Rendezvousメッセージ・システム・リンクの基本プロパティを指定します。メッセージ・ゲートウェイ・エージェントは、個々のメッセージ・ゲートウェイ・リンクに対して、TibrvRvdTransport
タイプのTIB/Rendezvousトランスポートを作成します。
構文
TYPE SYS.MGW_TIBRV_PROPERTIES IS OBJECT( service VARCHAR2(128), daemon VARCHAR2(128), network VARCHAR2(256), cm_name VARCHAR2(256), cm_ledger VARCHAR2(256), -- Methods STATIC FUNCTION construct RETURN SYS.MGW_TIBRV_PROPERTIES, STATIC FUNCTION alter_construct RETURN SYS.MGW_TIBRV_PROPERTIES );
属性
表108-17 SYS.MGW_TIBRV_PROPERTIES属性
属性 | 説明 |
---|---|
|
rvdトランスポート用のサービス・パラメータ |
|
rvdトランスポート用のデーモン・パラメータ |
|
rvdトランスポート用のネットワーク・パラメータ |
|
CM correspondentの名前。将来の使用のために予約されています。 |
|
CM ledgerのファイル名。将来の使用のために予約されています。 |
メソッド
表108-18 SYS.MGW_TIBRV_PROPERTIESメソッド
メソッド | 説明 |
---|---|
|
新規 |
|
新規 |
108.5 DBMS_MGWADMサブプログラムの要約
この表は、DBMS_MGWADM
サブプログラムを示し、簡単に説明しています。
表108-19 DBMS_MGWADMパッケージのサブプログラム
サブプログラム | 説明 |
---|---|
伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを追加します。 |
|
メッセージ・ゲートウェイ・エージェントのパラメータを変更します。 |
|
伝播ジョブのプロパティを変更します。 |
|
TIB/Rendezvousメッセージ・システム・リンクのプロパティを変更します。 |
|
WebSphere MQメッセージ・システム・リンクのプロパティを変更します。 |
|
伝播スケジュールを変更します。 |
|
伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバのパラメータを変更します。 |
|
メッセージ・ゲートウェイをクリーンアップします。 |
|
伝播ジョブの処理に使用されるメッセージ・ゲートウェイ・エージェントを作成します。 |
|
ソースから宛先にメッセージを伝播するために使用されるジョブを作成します。 |
|
TIB/Rendezvousメッセージ・システムへのメッセージ・システム・リンクを作成します。 |
|
WebSphere MQメッセージ・システムへのメッセージ・システム・リンクを作成します。 |
|
Oracle Databaseに接続するためにメッセージ・ゲートウェイ・エージェントが使用する接続情報を構成します。 |
|
伝播ジョブを使用禁止にします。 |
|
伝播スケジュールを使用禁止にします。 |
|
伝播ジョブを使用可能にします。 |
|
伝播スケジュールを使用可能にします。 |
|
Oracle以外のキュー・エンティティをメッセージ・ゲートウェイに登録します。 |
|
メッセージ・ゲートウェイ・エージェントを削除します。 |
|
伝播ジョブを削除します。 |
|
Oracle以外のメッセージ・システムに対するメッセージ・システム・リンクを削除します。 |
|
メッセージ・ゲートウェイ構成オプションを削除します。 |
|
伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを削除します。 |
|
伝播ジョブの伝播エラー状態をリセットします。 |
|
サブスクライバの伝播エラー状態をリセットします。 |
|
ソースから宛先へのメッセージ伝播をスケジュールします。 |
|
メッセージ・ゲートウェイ・エージェントのロギング・レベルを動的に変更します。 |
|
メッセージ・ゲートウェイ構成オプションを設定します。 |
|
メッセージ・ゲートウェイ・エージェントを停止します。 |
|
メッセージ・ゲートウェイ・エージェントを起動します。 |
|
Oracle以外のキュー・エンティティをメッセージ・ゲートウェイから削除します。 |
|
伝播スケジュールを削除します。 |
108.5.1 ADD_SUBSCRIBERプロシージャ
このプロシージャは、伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを追加します。
ノート:
テクノロジが改良されたため(「CREATE_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.ADD_SUBSCRIBER( subscriber_id IN VARCHAR2, propagation_type IN BINARY_INTEGER, queue_name IN VARCHAR2, destination IN VARCHAR2, rule IN VARCHAR2 DEFAULT NULL, transformation IN VARCHAR2 DEFAULT NULL, exception_queue IN VARCHAR2 DEFAULT NULL options IN SYS.MGW_PROPERTIES DEFAULT NULL);
パラメータ
表108-20 ADD_SUBSCRIBERプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
このサブスクライバを識別するユーザー定義名を指定します。 |
|
メッセージ伝播のタイプを指定します。 |
|
このサブスクライバが追加されるソース・キューを指定します。このパラメータの構文および解釈は、 |
|
このサブスクライバによってコンシュームされるメッセージの伝播先の宛先キューを指定します。このパラメータの構文および解釈は、 |
|
ソース・キューからメッセージをデキューするために、サブスクライバが使用するオプションのサブスクリプション・ルールを指定します。ルールが必要ない場合は |
|
メッセージ・ゲートウェイによって定義されるADTとOracle Databaseアドバンスト・キューイング・ペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、
|
|
例外メッセージ・ロギングの目的で使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。 ソース・キューと例外キューを同じキューにはできません。 |
|
オプションのサブスクライバ・プロパティ。オプションのプロパティがない場合は、 |
使用上のノート
参照:
メッセージ変換の詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のメッセージの変換を使用した任意のペイロード・タイプの処理に関する項を参照してください。
サブスクライバがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Databaseアドバンスト・キューイング・キューにアクセスします。または、Oracle Databaseアドバンスト・キューイングのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。
Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。その場合は、変換パラメータをNULL
に設定してください。
参照:
サブスクライバ・オプションの詳細は、次の項目を参照してください。
-
『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項
-
『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項
OUTBOUND_PROPAGATIONサブスクライバ
サブスクライバがアウトバウンド伝播に使用するパラメータは次のように解釈されます。
-
queue_name
- 伝播ソースであるローカルOracle Databaseアドバンスト・キューイング・キューを指定します。このキューは、schema.queue
の構文で指定する必要があります。 -
destination
- メッセージの伝播先の外部キューを指定します。このキューは、registered_queue@message_link
の構文で指定する必要があります。 -
rule
- Oracle Databaseアドバンスト・キューイングのネイティブ・インタフェースが使用されている場合は、Oracle Databaseアドバンスト・キューイングのオプションのサブスクライバ・ルールを指定し、Oracle JMSインタフェースが使用されている場合は、JMSセレクタを指定します。NULL
の場合、ルールまたはセレクタは使用されません。 -
transformation
- Oracle Databaseアドバンスト・キューイング・ペイロードをメッセージ・ゲートウェイによって定義されるADTに変換するために使用される変換機能を指定します。メッセージ・ゲートウェイ伝播では、Oracle Databaseアドバンスト・キューイング・ペイロードをメッセージ・ゲートウェイによって定義されるADTに変換するための変換機能を使用して、Oracle Databaseアドバンスト・キューイング・キューからメッセージをデキューします。その後、メッセージは、メッセージ・ゲートウェイのADTに基づいて外部メッセージ・システムにエンキューされます。
-
exception_queue
- 例外が発生した場合にメッセージを移動するOracle Databaseアドバンスト・キューイングのローカル・キューの名前を指定します。このキューは、schema.queue
の構文で指定する必要があります。
Oracle Databaseアドバンスト・キューイングのネイティブ・インタフェースが使用されている場合は、メッセージ・ゲートウェイが実行されているかどうかに関係なく、このプロシージャをコールしたときに、サブスクライバがOracle Databaseアドバンスト・キューイング・キューに追加されます。ローカル・サブスクライバの形式は、sys.aq$_agent('MGW_
subscriber_id
'
, NULL,
NULL)
になります。
Oracle JMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントは、MGW_
subscriber_id
という名前のJMS永続サブスクライバを作成します。エージェントが実行されていないときにこのプロシージャをコールすると、次にエージェントが起動された時点で、永続サブスクライバが作成されます。
例外キューについては、次の点に注意してください。
-
例外キューとして使用されるOracle Databaseアドバンスト・キューイング・キューは、ユーザーが作成する必要があります。
-
ソース・キューと例外キューのペイロード・タイプは一致している必要があります。
-
例外キューは、キュー・タイプ
DBMS_AQADM.EXCEPTION_QUEUE
ではなく、DBMS_AQADM.NORMAL_QUEUE
で作成する必要があります。エンキューの制限事項によって、メッセージ・ゲートウェイ伝播は、メッセージ・ゲートウェイ例外キューとしてタイプEXCEPTION_QUEUE
のOracle Databaseアドバンスト・キューイング・キューを使用できません。
INBOUND_PROPAGATIONサブスクライバ
サブスクライバがインバウンド伝播に使用するパラメータは次のように解釈されます。
-
queue_name
- 伝播ソースである外部キューを指定します。このキューは、registered_queue@message_link
の構文で指定する必要があります。 -
destination
- メッセージの伝播先のOracle Databaseアドバンスト・キューイング・ローカル・キューを指定します。このキューは、schema.queue
の構文で指定する必要があります。 -
rule
- 外部メッセージ・システムに対して有効であるオプションのサブスクライバ・ルールを指定します。ルールが必要ない場合はNULL
を設定します。 -
transformation
- メッセージ・ゲートウェイによって定義されるADTをOracle Databaseアドバンスト・キューイング・ペイロード・タイプに変換するために使用する変換機能を指定します。メッセージ・ゲートウェイ伝播は、外部メッセージ・システムのキューからメッセージをデキューし、メッセージ本体をメッセージ・ゲートウェイによって定義される既知のADTに変換します。変換機能は、メッセージがOracle Databaseアドバンスト・キューイング・キューにエンキューされるときに、メッセージ・ゲートウェイのADTをOracle Databaseアドバンスト・キューイング・ペイロード・タイプに変換するために使用されます。
-
exception_queue
- 例外が発生した場合にメッセージを移動する外部キューの名前を指定します。このキューは、registered_queue@message_link
の構文で指定する必要があります。
サブスクライバが必要かどうかは、Oracle以外のメッセージ・システムの要件によって決まります。永続サブスクライバが必要である場合は、メッセージ・ゲートウェイ・エージェントによって永続サブスクライバが作成されます。このプロシージャをコールした時点でエージェントが実行されていない場合は、次にエージェントが起動されたときに、Oracle以外のメッセージ・システム上で永続サブスクライバが作成されます。
例外キューについては、次の点に注意してください。
-
例外キューは、登録済のOracle以外のキューであることが必要です。
-
ソース・キューと例外キューは、同じメッセージ・システム・リンクを使用する必要があります。
108.5.2 ALTER_AGENTプロシージャ
このプロシージャは、メッセージ・ゲートウェイ・エージェントのパラメータを構成します。
構文
DBMS_MGWADM.ALTER_AGENT ( max_memory IN BINARY_INTEGER DEFAULT NULL, max_threads IN BINARY_INTEGER DEFAULT NULL, service IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE );
DBMS_MGWADM.ALTER_AGENT ( agent_name IN VARCHAR2, username IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, password IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, database IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, conntype IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, max_memory IN PLS_INTEGER DEFAULT NULL, max_threads IN PLS_INTEGER DEFAULT NULL, service IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, initfile IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, comment IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE );
パラメータ
表108-21 ALTER_AGENTプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・ゲートウェイ・エージェントが使用する最大ヒープ・サイズ(MB)。 |
|
メッセージ・ゲートウェイ・エージェントが作成するメッセージ・スレッドの最大数。 |
|
このエージェントが使用するOracle Schedulerジョブ・クラスが親和性を持つデータベース・サービスを指定します。つまり、Oracle RAC環境では、メッセージ・ゲートウェイ・エージェントはこのサービスに割り当てられたデータベース・インスタンスでのみ実行されます。 |
|
メッセージ・ゲートウェイ・エージェントを識別します。 |
|
Oracle Databaseへの接続に使用するユーザー名を指定します。 |
|
Oracle Databaseへの接続に使用するパスワードを指定します。 |
|
Oracle Databaseへの接続に使用するデータベース接続文字列を指定します。 |
|
Oracle Databaseとの接続タイプ( |
|
エージェントが使用するメッセージ・ゲートウェイの初期化ファイルを指定します。 |
|
このエージェントのオプションのコメント。コメントが必要ない場合は |
使用上のノート
-
これらの構成パラメータのデフォルト値は、メッセージ・ゲートウェイ・エージェントのインストール時に設定されます。
-
max_memory
とmax_threads
パラメータに対する変更は、次回メッセージ・ゲートウェイ・エージェントがアクティブになったときに有効になります。メッセージ・ゲートウェイ・エージェントが現在アクティブの場合、変更を有効にするには、エージェントを停止し、再起動する必要があります。 -
service
パラメータは、Oracle Schedulerのジョブ・クラスの属性を設定する場合に使用します。ジョブ・クラスは、メッセージ・ゲートウェイ・エージェントを起動するSchedulerジョブを作成する場合に使用されます。Oracleの管理者は、データベース・サービスを作成する必要があります。値がNULLの場合、ジョブ・クラスはすべてのインスタンスにマッピングされる内部サービスに属します。 -
username
,password
およびdatabase
パラメータは、メッセージ・ゲートウェイ・エージェントがOracle Databaseへの接続に使用する接続情報を指定します。Oracleの管理者はユーザーを作成し、ロールMGW_AGENT_ROLE
を付与する必要があります。
108.5.3 ALTER_JOBプロシージャ
このプロシージャは、伝播ジョブのプロパティを変更します。
構文
DBMS_MGWADM.ALTER_JOB ( job_name IN VARCHAR2, rule IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, transformation IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, exception_queue IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, poll_interval IN PLS_INTEGER DEFAULT 0, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comments IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE );
パラメータ
表108-22 ALTER_JOBプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
伝播ジョブを識別します。 |
|
伝播ソースからメッセージをデキューするために使用するオプションのサブスクリプション・ルールを指定します。このパラメータの構文および解釈は、伝播タイプによって決まります。 |
|
メッセージ・ゲートウェイによって定義されるADTとOracle Streams AQペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、
|
|
例外メッセージ・ロギングの目的で使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。ジョブと関連付けられた例外キューがない場合、問題発生時に伝播は停止します。このパラメータの構文および解釈は、伝播タイプによって決まります。
|
|
ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値は
|
|
オプションのジョブ・プロパティ。 |
|
このエージェントのオプションのコメント、または、コメントが不要である場合は |
使用上のノート
-
伝播ジョブがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Streams AQキューにアクセスします。それ以外の場合は、Oracle Streams AQのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。
-
JMSソースから伝播を行う場合、サブスクライバ・ルールは変更できません。かわりに、伝播ジョブを削除し、新規ルールを使用して再作成する必要があります。JMSにおいて永続サブスクリプション上のメッセージ・セレクタを変更することは、サブスクリプションを削除してから再作成することと同じです。
-
Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。したがって、変換パラメータを
DBMS_MGWADM
.NO_CHANGE
(デフォルト値)に設定する必要があります。 -
optionsパラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。
ノート:
-
オプションのパラメータの詳細は、「SYS.MGW_PROPERTYオブジェクト・タイプ」を参照してください。
-
アウトバウンド伝播パラメータの解釈については、「OUTBOUND_PROPAGATIONジョブ」を参照してください。
-
インバウンド伝播パラメータの解釈については、「INBOUND_PROPAGATIONジョブ」を参照してください。
108.5.4 TIB/Rendezvous用のALTER_MSGSYSTEM_LINKプロシージャ
このプロシージャは、TIB/Rendezvousメッセージ・システム・リンクのプロパティを変更します。
構文
DBMS_MGWADM.ALTER_MSGSYSTEM_LINK ( linkname IN VARCHAR2, properties IN SYS.MGW_TIBRV_PROPERTIES, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comment IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE );
パラメータ
表108-23 TIB/Rendezvous用のALTER_MSGSYSTEM_LINKプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・システム・リンク名。 |
|
TIB/Rendezvousメッセージ・システム・リンクの基本プロパティ。 |
|
オプションのリンク・プロパティ。 |
|
ユーザーが指定するコメント、または、コメントが不要である場合は |
使用上のノート
VARCHAR2
データ・タイプのメッセージ・リンク・プロパティの既存値を保持するには、その特定のプロパティにDBMS_MGWADM.NO_CHANGE
を指定します。別のデータ・タイプのプロパティの既存値を保持するには、そのプロパティにNULL
を指定します。
options
パラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。
一部のプロパティは変更できませんが、このようなプロパティの変更を試みると、このプロシージャは失敗します。変更可能なプロパティとオプションの中には、動的に変更できるものが少数あり、メッセージ・ゲートウェイでは、そのような新しい値がすぐに使用されます。その他のプロパティやオプションに対する変更を有効にするには、メッセージ・ゲートウェイ・エージェントを停止し、再起動する必要があります。
参照:
メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項を参照してください。
108.5.5 WebSphere MQ用のALTER_MSGSYSTEM_LINKプロシージャ
このプロシージャは、WebSphere MQメッセージ・システム・リンクのプロパティを変更します。
構文
DBMS_MGWADM.ALTER_MSGSYSTEM_LINK ( linkname IN VARCHAR2, properties IN SYS.MGW_MQSERIES_PROPERTIES, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comment IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE);
パラメータ
表108-24 WebSphere MQ用のALTER_MSGSYSTEM_LINKプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・システム・リンク名。 |
|
WebSphere MQメッセージ・システム・リンクの基本プロパティ。 |
|
オプションのリンク・プロパティ。どのオプションも変更しない場合は |
|
オプションの説明、必要ない場合は |
使用上のノート
VARCHAR2
データ・タイプのメッセージ・リンク・プロパティの既存値を保持するには、その特定のプロパティにDBMS_MGWADM.NO_CHANGE
を指定します。別のデータ・タイプのプロパティの既存値を保持するには、そのプロパティにNULL
を指定します。
options
パラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。
一部のプロパティは変更できませんが、このようなプロパティの変更を試みると、このプロシージャは失敗します。変更可能なプロパティとオプションの中には、動的に変更できるものが少数あり、メッセージ・ゲートウェイでは、そのような新しい値がすぐに使用されます。その他のプロパティやオプションに対する変更を有効にするには、メッセージ・ゲートウェイ・エージェントを停止し、再起動する必要があります。
参照:
メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項を参照してください。
108.5.6 ALTER_PROPAGATION_SCHEDULEプロシージャ
このプロシージャは、伝播スケジュールを変更します。
ノート:
テクノロジが改良されたため(「ALTER_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.ALTER_PROPAGATION_SCHEDULE ( schedule_id IN VARCHAR2, duration IN NUMBER DEFAULT NULL, next_time IN VARCHAR2 DEFAULT NULL, latency IN NUMBER DEFAULT NULL);
パラメータ
表108-25 ALTER_PROPAGATION_SCHEDULEプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
変更する伝播スケジュールを識別します。 |
|
将来の使用のために予約済 |
|
将来の使用のために予約済 |
|
ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。ソース・キュー内に利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値は |
使用上のノート
このプロシージャは、各パラメータの既存値を常に上書きします。特定のパラメータが指定されない場合、既存値はデフォルト値で上書きされます。
108.5.7 ALTER_SUBSCRIBERプロシージャ
このプロシージャは、伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバのパラメータを変更します。
ノート:
テクノロジが改良されたため(「ALTER_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.ALTER_SUBSCRIBER ( subscriber_id IN VARCHAR2, rule IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, transformation IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, exception_queue IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE, options IN SYS.MGW_PROPERTIES DEFAULT NULL );
パラメータ
表108-26 ALTER_SUBSCRIBERプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
変更するサブスクライバを識別します。 |
|
ソース・キューからメッセージをデキューするために、サブスクライバが使用するオプションのサブスクリプション・ルールを指定します。このパラメータの構文および解釈は、サブスクライバの伝播タイプによって決まります。
|
|
メッセージ・ゲートウェイによって定義されるADTとOracle Databaseアドバンスト・キューイング・ペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、サブスクライバの伝播タイプによって決まります。
|
|
例外メッセージ・ロギングに使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。サブスクライバと関連付けられた例外キューがない場合、問題発生時に伝播は停止します。このパラメータの構文および解釈は、サブスクライバの伝播タイプによって決まります。
ソース・キューと例外キューを同じキューにはできません。 |
|
オプションのサブスクライバ・プロパティ。 |
使用上のノート
サブスクライバがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Databaseアドバンスト・キューイング・キューにアクセスします。または、Oracle Databaseアドバンスト・キューイングのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。
JMSソースから伝播を行う場合、サブスクライバ・ルールは変更できません。そのため、既存のサブスクライバを削除して、新しいルールとともにサブスクライバを追加する必要があります。JMSにおいて永続サブスクリプション上のメッセージ・セレクタを変更することは、サブスクリプションを削除してから再作成することと同じです。
Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。したがって、変換パラメータをDBMS_MGWADM.NO_CHANGE
(デフォルト値)に設定する必要があります。
options
パラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。
参照:
-
オプションのパラメータの詳細は、「SYS.MGW_PROPERTIESオブジェクト・タイプ」を参照してください。
-
WebSphere MQサブスクライバ・オプションの詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項を参照してください。
-
TIB/Rendezvousサブスクライバ・オプションの詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項を参照してください。
-
"アウトバウンド伝播パラメータの解釈については、「OUTBOUND_PROPAGATIONサブスクライバ」を参照してください。
-
"インバウンド伝播パラメータの解釈については、「INBOUND_PROPAGATIONサブスクライバ」を参照してください。
108.5.8 CLEANUP_GATEWAYプロシージャ
このプロシージャは、メッセージ・ゲートウェイをクリーンアップします。メッセージ・ゲートウェイになんらかの異常がある状態または予期しない状態のままのときに、必要なクリーンアップまたはリカバリ処理を実行します。MGW_GATEWAY
ビューには、クリーンアップ処理に関係するメッセージ・ゲートウェイ・ステータスおよび構成情報が表示されます。
構文
DBMS_MGWADM.CLEANUP_GATEWAY( action IN BINARY_INTEGER, sarg IN VARCHAR2 DEFAULT NULL);
DBMS_MGWADM.CLEANUP_GATEWAY( agent_name IN VARCHAR2, action IN BINARY_INTEGER, sarg IN VARCHAR2 DEFAULT NULL );
パラメータ
表108-27 CLEANUP_GATEWAYプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
実行するクリーンアップ処理。値:
|
|
|
|
メッセージ・ゲートウェイ・エージェントを識別します。 |
使用上のノート
CLEAN_STARTUP_STATE
sarg
パラメータは使用されないため、NULL
に設定してください。
CLEAN_STARTUP_STATE
処理では、メッセージ・ゲートウェイ・エージェントがクラッシュしたか、他のなんらかの異常な状態が発生して、メッセージ・ゲートウェイが再起動不可能になった場合に、メッセージ・ゲートウェイを既知の状態に復元します。このクリーンアップ処理は、メッセージ・ゲートウェイ・エージェントが起動された後で、クラッシュしたと思われるか、長時間応答がない場合にのみ実行してください。
MGW_GATEWAY
ビューに表示されるAGENT_STATUS
の値がNOT_STARTED
またはSTART_SCHEDULED
以外であり、AGENT_PING
の値が長時間UNREACHABLE
である場合には、CLEAN_STARTUP_STATE
処理が必要になります。
AGENT_STATUS
の値がBROKEN
である場合、問題が解決されてCLEAN_STARTUP_STATE
処理を通じてエージェントの状態がリセットされるまでは、エージェントを起動できません。BROKEN
ステータスは、メッセージ・ゲートウェイ・エージェントがすでに実行されている状況がメッセージ・ゲートウェイの起動ジョブによって検出されたことを示します。正常な使用環境では、このような状況は決して発生しません。
クリーンアップ処理では次のタスクが実行されます。
-
外部メッセージ・ゲートウェイ・エージェント・プロセスの起動に使用されるSchedulerジョブを削除します。
-
特定の構成情報を既知の状態に設定します。たとえば、エージェント・ステータスを
NOT_STARTED
に設定します。
次のような場合はコマンドの処理に失敗します。
-
エージェントのステータスが
NOT_STARTED
またはSTART_SCHEDULED
である場合。 -
エージェントのステータスが
STARTING
の場合を除いて、このプロシージャのコール前に停止が試みられなかった場合。 -
メッセージ・ゲートウェイ・エージェントに正常に接続できた場合。
エージェントがすでにアクティブである場合、このプロシージャは失敗したと考えられます。数回試行してもエージェントが応答しない場合は、クリーンアップ処理が実行されます。クリーンアップ処理には、少なくとも数秒(最長で1分程度)の時間がかかります。これは、この特定のクリーンアップ処理が適切で必要な状態での予想される動作です。
ノート:
CLEAN_STARTUP_STATE
処理が正常に実行された後も実行されているメッセージ・ゲートウェイは終了してください。これは、DBMS_MGWADM
.STARTUP
をコールしてメッセージ・ゲートウェイを起動する前に行う必要があります。プロセス名は、通常extprocmgwextproc
です。
CLEAN_LOG_QUEUES
sarg
パラメータは使用されないため、NULL
に設定してください。
構成されたすべてのメッセージ・システム・リンクのログ・キューをメッセージ・ゲートウェイ・エージェントによってクリアします。このエージェントは、すべての伝播アクティビティを一時的に停止した後、各リンクのログ・キューから不要または不正なログ・レコードをすべて削除します。メッセージ・ゲートウェイ・エージェントが実行されていない場合は、処理に失敗します。
このクリーンアップ処理は、メッセージ・ゲートウェイ・エージェントを起動するたびに自動的に実行されます。
ノート:
CLEAN_LOG_QUEUES
処理は、エージェントの起動時にのみ実行されます。メッセージ・ゲートウェイ・エージェントの実行中にこのプロシージャをコールしても、そのコールは無視されます。
RESET_SUB_MISSING_LOG_REC
sarg
には、リセットするメッセージ・ゲートウェイのジョブ名(またはサブスクライバID)を指定します。NULL
以外の値を指定してください。
ログ・レコードが存在しないためにエラーになったメッセージ・ゲートウェイ伝播ジョブをメッセージ・ゲートウェイ・エージェントによって復元します。ソースと宛先のログ・レコードが、エージェントによってリセットされます。メッセージ・ゲートウェイ・エージェントが実行されていない場合は、処理に失敗します。
ノート:
ソース・キュー内のメッセージがすでに宛先キューに伝播されていた場合は、この処理によって重複したメッセージが作成される可能性があります。
RESET_SUB_MISSING_MESSAGE
sarg
には、リセットするメッセージ・ゲートウェイのジョブ名(またはサブスクライバID)を指定します。NULL
以外の値を指定してください。
永続ソース・メッセージが存在しないためにエラーになったメッセージ・ゲートウェイ伝播ジョブをメッセージ・ゲートウェイ・エージェントによって復元します。エージェントはメッセージを非永続メッセージとして取り扱い、伝播ジョブの処理を続けます。メッセージ・ゲートウェイ・エージェントが実行されていない場合は、処理に失敗します。
108.5.9 CREATE_AGENTプロシージャ
このプロシージャは、伝播ジョブの処理に使用されるメッセージ・ゲートウェイ・エージェントを作成します。
構文
DBMS_MGWADM.CREATE_AGENT ( agent_name IN VARCHAR2, username IN VARCHAR2 DEFAULT NULL, password IN VARCHAR2 DEFAULT NULL, database IN VARCHAR2 DEFAULT NULL, conntype IN VARCHAR2 DEFAULT DBMS_MGWADM.JDBC_OCI, max_memory IN PLS_INTEGER DEFAULT 64, max_threads IN PLS_INTEGER DEFAULT 1, service IN VARCHAR2 DEFAULT NULL, initfile IN VARCHAR2 DEFAULT NULL, comment IN VARCHAR2 DEFAULT NULL );
パラメータ
表108-28 CREATE_AGENTプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
エージェントの識別に使用される名前。 |
|
Oracle Databaseへの接続に使用するユーザー名を指定します。 |
|
Oracle Databaseへの接続に使用するパスワードを指定します。ユーザー名を指定した場合は、パスワードも指定する必要があります。 |
|
Oracle Databaseへの接続に使用するデータベース接続文字列を指定します。 |
|
Oracle Databaseとの接続タイプ( |
|
メッセージ・ゲートウェイ・エージェントが使用する最大ヒープ・サイズ(MB)を指定します。 |
|
メッセージ・ゲートウェイ・エージェントが作成するメッセージ・スレッドの数を指定します。これにより、エージェントが同時に処理できる伝播ジョブの数が決定されます。 |
|
このエージェントが使用するOracle Schedulerジョブ・クラスが親和性を持つデータベース・サービスを指定します。つまり、Oracle RAC環境では、メッセージ・ゲートウェイ・エージェントはこのサービスに割り当てられたデータベース・インスタンスで実行のみが行われます。NULLの場合、ジョブ・クラスは、各インスタンスにマッピングされるデフォルト・サービスに属します。 |
|
エージェントが使用するメッセージ・ゲートウェイの初期化ファイルを指定します。NULLは、デフォルトの初期化ファイルが使用されることを示します。指定する値はファイルのフルパス名である必要があります。 |
|
このエージェントのオプションのコメント。必要ない場合は |
使用上のノート
-
メッセージ・ゲートウェイをインストールすると、デフォルト・エージェントが自動的に構成されます。デフォルト・エージェントの名前は
DEFAULT_AGENT
です。このプロシージャは追加エージェントを作成する場合に使用できます。 -
username
,password
およびdatabase
パラメータは、メッセージ・ゲートウェイ・エージェントがOracle Databaseへの接続に使用する接続情報を指定します。Oracle管理者はデータベース・ユーザーを作成し、ロールMGW_AGENT_ROLE
を付与する必要があります。接続情報は、このプロシージャをコールするときに指定する必要はありませんが、エージェントを起動する前に指定する必要があります。 -
service
パラメータは、Oracle Schedulerのジョブ・クラスを作成する場合に使用します。ジョブ・クラスは、メッセージ・ゲートウェイ・エージェントを起動するSchedulerジョブを作成する場合に使用されます。Oracleの管理者は、データベース・サービスを作成する必要があります。値がNULL
の場合、ジョブ・クラスはすべてのインスタンスがマッピングされる内部サービスに属します。
108.5.10 CREATE_JOBプロシージャ
このプロシージャは、ソースから宛先にメッセージを伝播するために使用するジョブを作成します。
構文
DBMS_MGWADM.CREATE_JOB ( job_name IN VARCHAR2, propagation_type IN PLS_INTEGER, source IN VARCHAR2, destination IN VARCHAR2, rule IN VARCHAR2 DEFAULT NULL, transformation IN VARCHAR2 DEFAULT NULL, exception_queue IN VARCHAR2 DEFAULT NULL, poll_interval IN PLS_INTEGER DEFAULT NULL, options IN SYS.MGW_PROPERTIES DEFAULT NULL, enabled IN BOOLEAN DEFAULT TRUE, comments IN VARCHAR2 DEFAULT NULL);
パラメータ
表108-29 CREATE_JOBプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
伝播ジョブを識別するためのユーザー定義名。 |
|
メッセージ伝播のタイプを指定します。
|
|
メッセージの伝播元であるソース・キューを指定します。このパラメータの構文および解釈は、 |
|
メッセージの伝播先である宛先キューを指定します。このパラメータの構文および解釈は、 |
|
ソース・キューからメッセージをデキューするために使用するオプションのサブスクリプション・ルールを指定します。ルールが必要ない場合は |
|
メッセージ・ゲートウェイによって定義されるADTとOracle Streams AQペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、 変換を指定しない場合、Oracle Streams AQペイロード・タイプはメッセージ・ゲートウェイによってサポートされる必要があります。 |
|
例外メッセージ・ロギングの目的で使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。 ソース・キューと例外キューを同じキューにはできません。 |
|
ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値は |
|
オプションのジョブ・プロパティ、オプションのジョブ・プロパティがない場合は、 |
|
この伝播ジョブが作成後も有効かどうかを指定します。使用できる値は
|
|
このジョブのオプションのコメントです。必要ない場合は |
使用上のノート
-
ジョブが使用可能で、メッセージが伝播されるようにメッセージ・ゲートウェイ・エージェントが適切に起動されている必要があります。
-
伝播ジョブがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Streams AQキューにアクセスします。それ以外の場合は、Oracle Streams AQのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。
-
Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。その場合は、変換パラメータを
NULL
に設定してください。
OUTBOUND_PROPAGATIONジョブ
アウトバウンド伝播ジョブの場合、パラメータは次のように解釈されます。
-
source
- 伝播ソースであるOracle Streams AQローカル・キューを指定します。このキューはschema.queueの構文で指定する必要があります。マルチ・コンシューマ・キューまたはシングル・コンシューマ・キューを指定できます。 -
destination
- メッセージの伝播先であるOracle以外のキューを指定します。このキューは、registered_queue
@message_link
の構文で指定する必要があります。 -
rule
- Oracle Streams AQのネイティブ・インタフェースが使用されている場合は、Oracle Streams AQのオプションのサブスクライバ・ルールを指定し、Oracle JMSインタフェースが使用されている場合は、JMSセレクタを指定します。NULL
の場合、ルールまたはセレクタは使用されません。ネイティブのOracle Streams AQインタフェースを使用し、伝播ソースがシングル・コンシューマ・キューである場合、このパラメータにはNULL
を指定する必要があります。 -
transformation
- Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるADTに変換するために使用される変換機能を指定します。完全な変換名(schema
.name
)が指定されている場合は、この名前を使用する必要があります。メッセージ・ゲートウェイ伝播では、Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるADTに変換するための変換機能を使用して、Oracle Streams AQキューからメッセージをデキューします。その後、メッセージは、メッセージ・ゲートウェイのADTに基づいてOracle以外のメッセージ・システムにエンキューされます。
-
exception_queue
- 例外が発生した場合にメッセージを移動するOracle Streams AQローカル・キューの名前を指定します。構文は、schema
.queue
である必要があります。Oracle Streams AQのネイティブ・インタフェースが使用されていて、ソースが複数のコンシューマ・キューである場合は、メッセージ・ゲートウェイ・エージェントが実行されているかどうかに関係なく、このプロシージャをコールしたときに、サブスクライバがOracle Streams AQキューに追加されます。ローカル・サブスクライバの形式は、
sys
.aq$_agent
('MGW_job_name
',NULL
,NULL
)になります。Oracle JMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントは、
MGW_job_name
という名前のJMS永続サブスクライバを作成します。エージェントが実行されていないときにこのプロシージャをコールすると、次にエージェントが起動された時点で、永続サブスクライバが作成されます。例外キューには、次の条件があります。
-
例外キューとして使用されるOracle Streams AQキューは、ユーザーが作成する必要があります。
-
ソース・キューと例外キューのペイロード・タイプは一致している必要があります。
-
例外キューは、キュー・タイプ
DBMS_AQADM
.NORMAL_QUEUE
で作成する必要があります。エンキューの制限事項によって、メッセージ・ゲートウェイは、メッセージ・ゲートウェイ例外キューとしてタイプDBMS_AQADM
.EXCEPTION_QUEUE
のOracle Streams AQキューを使用できません。
-
INBOUND_PROPAGATIONジョブ
インバウンド伝播ジョブに使用するパラメータは、次のように解釈されます。
-
source
- 伝播ソースであるOracle以外のキューを指定します。構文は、registered_queue
@message_link
である必要があります。 -
destination
- メッセージの伝播先のOracle Streams AQローカル・キューを指定します。構文は、schema
.queue
である必要があります。 -
rule
- Oracle以外のメッセージ・システムに対して有効であるオプションのサブスクライバ・ルールを指定します。ルールが必要ない場合はNULL
を設定します。 -
transformation
- メッセージ・ゲートウェイによって定義されるADTをOracle Streams AQペイロード・タイプに変換するために使用する変換機能を指定します。完全な変換名(schema
.name
)が指定されている場合は、この名前を使用する必要があります。メッセージ・ゲートウェイ伝播は、Oracle以外のメッセージ・システムのキューからメッセージをデキューし、メッセージ本体をメッセージ・ゲートウェイによって定義される既知のADTに変換します。変換機能は、メッセージがOracle Streams AQキューにエンキューされるときに、メッセージ・ゲートウェイのADTをOracle Streams AQペイロード・タイプに変換するために使用されます。
-
exception_queue
- 例外が発生した場合にメッセージを移動する登録済のOracle以外のキューの名前を指定します。構文は、registered_queue@message_link
である必要があります。ソース・キューにサブスクライバが必要かどうかは、Oracle以外のメッセージ・システムの要件によって決まります。永続サブスクライバが必要である場合は、メッセージ・ゲートウェイ・エージェントによって永続サブスクライバが作成されます。エージェントが実行されていないときにこのプロシージャをコールすると、次にエージェントが起動された時点で、Oracle以外のメッセージング・システムにサブスクライバが作成されます。
例外キューには、次の条件があります。
-
例外キューは、登録済のOracle以外のキューであることが必要です。
-
ソース・キューと例外キューは、同じメッセージ・システム・リンクを使用する必要があります。
-
108.5.11 TIB/Rendezvous用のCREATE_MSGSYSTEM_LINKプロシージャ
このプロシージャは、TIB/Rendezvousメッセージ・システムへのリンクを作成します。
構文
DBMS_MGWADM.CREATE_MSGSYSTEM_LINK ( linkname IN VARCHAR2, properties IN SYS.MGW_TIBRV_PROPERTIES, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comment IN VARCHAR2 DEFAULT NULL );
DBMS_MGWADM.CREATE_MSGSYSTEM_LINK ( linkname IN VARCHAR2, agent_name IN VARCHAR2, properties IN SYS.MGW_TIBRV_PROPERTIES, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comment IN VARCHAR2 DEFAULT NULL );
パラメータ
表108-30 TIB/Rendezvous用のCREATE_MSGSYSTEM_LINKプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
このメッセージ・システム・リンクを識別するためのユーザー定義名。 |
|
TIB/Rendezvousメッセージ・システム・リンクの基本プロパティ。 |
|
オプションのリンク・プロパティ。オプションのプロパティがない場合は、 |
|
ユーザーが指定した説明。必要ない場合は |
|
このリンクに関連付けられたすべての伝播ジョブの処理に使用されるメッセージ・ゲートウェイ・エージェントを指定します。 |
使用上のノート
エージェント名が指定されていない場合、メッセージ・ゲートウェイのデフォルトのエージェントが、このリンクに関連付けられた伝播ジョブを処理します。
参照:
メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項を参照してください。
108.5.12 WebSphere MQ用のCREATE_MSGSYSTEM_LINKプロシージャ
このプロシージャは、WebSphere MQメッセージ・システムへのメッセージ・システム・リンクを作成します。
構文
DBMS_MGWADM.CREATE_MSGSYSTEM_LINK( linkname IN VARCHAR2, properties IN SYS.MGW_MQSERIES_PROPERTIES, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comment IN VARCHAR2 DEFAULT NULL);
DBMS_MGWADM.CREATE_MSGSYSTEM_LINK( linkname IN VARCHAR2, agent_name IN VARCHAR2, properties IN SYS.MGW_MQSERIES_PROPERTIES, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comment IN VARCHAR2 DEFAULT NULL);
パラメータ
表108-31 WebSphere MQ用のCREATE_MSGSYSTEM_LINKプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・システム・リンクを識別するためのユーザー定義名。 |
|
WebSphere MQメッセージ・システム・リンクの基本プロパティ。 |
|
オプションのリンク・プロパティ。オプションのプロパティがない場合は、 |
|
ユーザーが指定した説明。必要ない場合は |
|
このリンクに関連付けられたすべての伝播ジョブの処理に使用されるメッセージ・ゲートウェイ・エージェントを指定します。 |
使用上のノート
エージェント名が指定されていない場合、メッセージ・ゲートウェイのデフォルトのエージェントが、このリンクに関連付けられた伝播ジョブを処理します。
参照:
メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項を参照してください。
108.5.13 DB_CONNECT_INFOプロシージャ
この推奨されないプロシージャは、Oracle Databaseに接続するためにメッセージ・ゲートウェイのデフォルト・エージェントが使用する接続情報を構成します。
ノート:
テクノロジが改良されたため(「ALTER_AGENTプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.DB_CONNECT_INFO ( username IN VARCHAR2, password IN VARCHAR2, database IN VARCHAR2 DEFAULT NULL);
パラメータ
表108-32 DB_CONNECT_INFOプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
Oracle Databaseへの接続に使用するユーザー名。 |
|
Oracle Databaseへの接続に使用するパスワード。 |
|
メッセージ・ゲートウェイ・エージェントが使用するデータベース接続文字列。
|
使用上のノート
メッセージ・ゲートウェイ・エージェントは、このプロシージャで構成されたユーザーとしてOracle Databaseに接続します。Oracleの管理者は、ユーザーを作成し、そのユーザーにロールMGW_AGENT_ROLE
を付与した後、このプロシージャをコールしてメッセージ・ゲートウェイを構成する必要があります。MGW_AGENT_ROLE
ロールは、データベース内に格納されているメッセージ・ゲートウェイ構成情報をアクセスするために必要な特別な権限をこのユーザーに付与したり、Oracle Databaseアドバンスト・キューイング・キューでメッセージをエンキューまたはデキューしたり、特定のOracle Databaseアドバンスト・キューイング管理タスクを実行するために使用されます。
108.5.14 DISABLE_JOBプロシージャ
このプロシージャは、伝播ジョブを無効にします。
構文
DBMS_MGWADM.DISABLE_JOB ( job_name IN VARCHAR2);
パラメータ
表108-33 DISABLE_JOBプロシージャのパラメータ
パラメータ | 説明 |
---|---|
job_name |
伝播ジョブを識別します。 |
108.5.15 DISABLE_PROPAGATION_SCHEDULEプロシージャ
この推奨されないプロシージャは、伝播スケジュールを無効にします。
ノート:
テクノロジが改良されたため(「DISABLE_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.DISABLE_PROPAGATION_SCHEDULE ( schedule_id IN VARCHAR2);
パラメータ
表108-34 DISABLE_PROPAGATION_SCHEDULEプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
使用禁止にする伝播スケジュールを識別します。 |
108.5.16 ENABLE_JOBプロシージャ
このプロシージャは、伝播ジョブを使用可能にします。
構文
DBMS_MGWADM.ENABLE_JOB ( job_name IN VARCHAR2 );
パラメータ
表108-35 ENABLE_JOBプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
伝播ジョブを識別します。 |
108.5.17 ENABLE_PROPAGATION_SCHEDULEプロシージャ
この推奨されないプロシージャは、伝播スケジュールを使用可能にします。
ノート:
テクノロジが改良されたため(「ENABLE_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.ENABLE_PROPAGATION_SCHEDULE ( schedule_id IN VARCHAR2 );
パラメータ
表108-36 ENABLE_PROPAGATION_SCHEDULEプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
使用可能にする伝播スケジュールを識別します。 |
108.5.18 REGISTER_FOREIGN_QUEUEプロシージャ
このプロシージャは、Oracle以外のキュー・エンティティをメッセージ・ゲートウェイに登録します。
構文
DBMS_MGWADM.REGISTER_FOREIGN_QUEUE( name IN VARCHAR2, linkname IN VARCHAR2, provider_queue IN VARCHAR2 DEFAULT NULL, domain IN INTEGER DEFAULT NULL, options IN SYS.MGW_PROPERTIES DEFAULT NULL, comment IN VARCHAR2 DEFAULT NULL);
パラメータ
表108-37 REGISTER_FOREIGN_QUEUEプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
登録されるキュー名。この名前は、メッセージ・ゲートウェイ内で外部キューを識別し、外部メッセージ・システムのキュー名と一致する必要はありません。 |
|
このキューが存在するメッセージ・システムに対するリンク名。 |
|
メッセージ・プロバイダ(ネイティブ)のキュー名。 |
|
キューのドメイン・タイプ。 |
|
オプションのキュー・プロパティ。 |
|
ユーザーが指定した説明。 |
使用上のノート
このプロシージャは、Oracle以外のメッセージ・システムに物理的なキューを作成しません。Oracle以外のキューは、そのメッセージ・システムの管理ツールを使用して作成する必要があります。
参照:
WebSphere MQメッセージ・システムまたはTIB/Rendezvousメッセージ・システムのキューを登録する場合の詳細は、『Oracle Databaseアドバンスト・キューイング・ユーザーズ・ガイド』のオプションの外部キュー構成プロパティに関する項を参照してください。
108.5.19 REMOVE_AGENTプロシージャ
このプロシージャは、メッセージ・ゲートウェイ・エージェントを削除します。
構文
DBMS_MGWADM.REMOVE_AGENT( agent_name IN VARCHAR2 );
パラメータ
表108-38 REMOVE_AGENTプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・ゲートウェイ・エージェントを識別します。 |
使用上のノート
このメッセージ・ゲートウェイ・エージェントを削除する前に、このエージェントに関連付けられたすべてのメッセージ・システム・リンクを削除し、このエージェントを停止する必要があります。メッセージ・ゲートウェイのデフォルト・エージェントを削除することはできません。
108.5.20 REMOVE_JOBプロシージャ
このプロシージャは、伝播ジョブを削除します。
構文
DBMS_MGWADM.REMOVE_JOB( job_name IN VARCHAR2, force IN PLS_INTEGER DEFAULT DBMS_MGWADM.NO_FORCE);
パラメータ
表108-39 REMOVE_JOBプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
伝播ジョブを識別します。 |
force |
メッセージ・ゲートウェイがこの伝播ジョブに関連するすべてのクリーンアップ処理を実行できない場合でも、このプロシージャを正常終了させるかどうかを指定します。 値:
|
使用上のノート
-
メッセージ・ゲートウェイ・エージェントは、Oracle DatabaseおよびOracle以外のメッセージ・システムの様々なリソースを使用して伝播アクティビティを実行します。ジョブを削除する場合は、これらのリソースを解放する必要があります。たとえば、ジョブを削除するときに削除する必要があるソース・キューに、メッセージ・ゲートウェイが永続サブスクライバを作成することがあります。したがって、通常このプロシージャは、メッセージ・ゲートウェイ・エージェントが実行中で、このジョブに関連付けられたOracle以外のメッセージ・システムにアクセスできるときにコールしてください。
-
アウトバウンド伝播の場合、伝播ソースが複数のコンシューマ・キューであるときは、ローカル・サブスクライバがOracle Streams AQキューから削除されます。
108.5.21 REMOVE_MSGSYSTEM_LINKプロシージャ
このプロシージャは、Oracle以外のメッセージ・システムに対するメッセージ・システム・リンクを削除します。
構文
DBMS_MGWADM.REMOVE_MSGSYSTEM_LINK( linkname IN VARCHAR2);
パラメータ
表108-40 REMOVE_MSGSYSTEM_LINKプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・システム・リンク名。 |
使用上のノート
メッセージ・システム・リンクを削除するには、このリンクと関連付けられた登録済のすべてのキューを削除する必要があります。削除対象のリンクを参照する登録済の外部キュー(Oracle以外の)がある場合、このプロシージャは失敗します。
108.5.22 REMOVE_OPTIONプロシージャ
このプロシージャは、メッセージ・ゲートウェイ構成オプションを削除します。エージェント・オプション、メッセージ・リンク・オプションまたは伝播ジョブ・オプションを削除する場合に使用できます。
構文
DBMS_MGWADM.REMOVE_OPTION ( target_type IN PLS_INTEGER, target_name IN VARCHAR2, option_name IN VARCHAR2);
パラメータ
表108-41 REMOVE_OPTIONプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・ゲートウェイ・エンティティのターゲット・タイプを指定します。
|
|
ターゲットの名前または識別子。このパラメータの値は、 |
option_name |
オプション名。 |
参照:
option_type
パラメータのオプションは、表108-10を参照してください。
使用上のノート
DBMS_MGWADM.AGENT_JAVA_PROPターゲット
このプロシージャは、メッセージ・ゲートウェイ・エージェントの起動時に、Java Systemプロパティを設定するために使用されるエージェント・オプションを削除します。変更を有効にするには、エージェントを再起動する必要があります。
パラメータは、次のように解釈されます。
-
target_name
は、メッセージ・ゲートウェイ・エージェントの名前を指定します。デフォルトのエージェントには、DBMS_MGWADM
.DEFAULT_AGENT
を使用できます。 -
option_name
は、Java Systemプロパティを指定します。 -
encrypted
は、TRUE
またはFALSE
に設定できます。
DBMS_MGWADM.MSGLINK_OPTIONターゲット
このプロシージャは、メッセージ・ゲートウェイのメッセージ・システム・リンクの単一オプションを削除します。このプロシージャは、DBMS_MGWADM
.ALTER_MSGSYSTEM_LINK
をコールし、optionsパラメータを使用してオプションを削除する処理と同等です。
パラメータは、次のように解釈されます。
-
target_name
は、メッセージ・システム・リンクの名前を指定します。 -
option_name
は、設定するオプションを指定します。 -
encrypted
はFALSE
に設定する必要があります。
DBMS_MGWADM.JOB_OPTIONターゲット
このプロシージャは、メッセージ・ゲートウェイ伝播ジョブの単一オプションを削除します。このプロシージャは、DBMS_MGWADM
.ALTER_JOB
をコールし、optionsパラメータを使用してオプションを削除する処理と同等です。
パラメータは、次のように解釈されます。
-
target_name
は、伝播ジョブの名前を指定します。 -
option_name
は、設定するオプションを指定します。 -
encrypted
はFALSE
に設定する必要があります。
108.5.23 REMOVE_SUBSCRIBERプロシージャ
このプロシージャは、伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを削除します。
ノート:
テクノロジが改良されたため(「REMOVE_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.REMOVE_SUBSCRIBER ( subscriber_id IN VARCHAR2, force IN BINARY_INTEGER DEFAULT DBMS_MGWADM.NO_FORCE );
パラメータ
表108-42 REMOVE_SUBSCRIBERプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
削除するサブスクライバを識別します。 |
|
メッセージ・ゲートウェイがこのサブスクライバに関連するすべてのクリーンアップ処理を実行できない場合でも、このプロシージャを正常終了させるかどうかを指定します。 値:
|
使用上のノート
-
メッセージ・ゲートウェイ・エージェントは、Oracle DatabaseおよびOracle以外のメッセージ・システムの様々なリソースを使用して伝播アクティビティを実行します。これらのリソースは通常、各サブスクライバと関連付けられ、サブスクライバが不要になったときに解放される必要があります。したがって、このプロシージャは、メッセージ・ゲートウェイ・エージェントが実行中で、このサブスクライバに関連付けられたOracle以外のメッセージ・システムにアクセスできるときにのみコールしてください。
-
アウトバウンド伝播の場合、ローカル・サブスクライバがOracle Databaseアドバンスト・キューイング・キューから削除されます。
108.5.24 RESET_JOBプロシージャ
このプロシージャは、伝播ジョブの伝播エラー状態をリセットします。
構文
DBMS_MGWADM.RESET_JOB ( job_name IN VARCHAR2);
パラメータ
表108-43 RESET_JOBプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
伝播ジョブを識別します。 |
使用上のノート
このプロシージャを使用すると、障害状態に設定され、伝播アクティビティが停止された伝播ジョブをリセットすることができます。管理者は問題を解決してから、このプロシージャをコールして、エージェントが伝播ジョブを再試行できるようにする必要があります。MGW_JOBS
ビューのSTATUS
フィールドは、ジョブ・ステータスを示します。
108.5.25 RESET_SUBSCRIBERプロシージャ
このプロシージャは、サブスクライバの伝播エラー状態をリセットします。
ノート:
テクノロジが改良されたため(「RESET_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.RESET_SUBSCRIBER ( subscriber_id IN VARCHAR2 );
パラメータ
表108-44 RESET_SUBSCRIBERプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
サブスクライバを識別します。 |
108.5.26 SCHEDULE_PROPAGATIONプロシージャ
このプロシージャは、ソースから宛先へのメッセージ伝播をスケジュールします。
スケジュールが使用可能で、メッセージが伝播されるようにメッセージ・ゲートウェイが適切に起動されている必要があります。
ノート:
テクノロジが改良されたため(「CREATE_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.SCHEDULE_PROPAGATION ( schedule_id IN VARCHAR2, propagation_type IN BINARY_INTEGER, source IN VARCHAR2, destination IN VARCHAR2, start_time IN DATE DEFAULT SYSDATE, duration IN NUMBER DEFAULT NULL, next_time IN VARCHAR2 DEFAULT NULL, latency IN NUMBER DEFAULT NULL);
パラメータ
表108-45 SCHEDULE_PROPAGATIONプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
スケジュールを識別するユーザー定義名を指定します。 |
|
メッセージ伝播のタイプを指定します。 |
|
メッセージの伝播元であるソース・キューを指定します。このパラメータの構文および解釈は、 |
|
メッセージの伝播先である宛先キューを指定します。このパラメータの構文および解釈は、 |
|
将来の使用のために予約済 |
|
将来の使用のために予約済 |
|
将来の使用のために予約済 |
|
ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。ソース・キュー内に利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値は |
使用上のノート
アウトバウンド伝播の場合、パラメータは次のように解釈されます。
-
source
- メッセージの伝播元のOracle Databaseアドバンスト・キューイング・ローカル・キューを指定します。このキューは、schema.queue
の構文で指定する必要があります。 -
destination
- メッセージの伝播先の外部キューを指定します。このキューは、registered_queue@message_link
の構文で指定する必要があります。
インバウンド伝播の場合、パラメータは次のように解釈されます。
-
source
- メッセージの伝播元である外部キューを指定します。このキューは、registered_queue@message_link
の構文で指定する必要があります。 -
destination
- メッセージの伝播先のOracle Databaseアドバンスト・キューイング・ローカル・キューを指定します。このキューは、schema.queue
の構文で指定する必要があります。
スケジュールは、作成時に使用可能な状態に設定されます。
108.5.27 SET_LOG_LEVELプロシージャ
このプロシージャは、メッセージ・ゲートウェイ・エージェントのロギング・レベルを動的に変更します。メッセージ・ゲートウェイ・エージェントが実行されている必要があります。
構文
DBMS_MGWADM.SET_LOG_LEVEL ( log_level IN BINARY_INTEGER);
DBMS_MGWADM.SET_LOG_LEVEL ( agent_name IN VARCHAR2, log_level IN BINARY_INTEGER);
パラメータ
表108-46 SET_LOG_LEVELプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・ゲートウェイ・エージェントが情報をログに記録するときのレベル。 |
|
メッセージ・ゲートウェイ・エージェントを識別します。 |
参照:
log_level
パラメータの詳細は、表108-3を参照してください。
108.5.28 SET_OPTIONプロシージャ
このプロシージャは、メッセージ・ゲートウェイ構成オプションを設定します。エージェント・オプション、メッセージ・リンク・オプションまたは伝播ジョブ・オプションを設定する場合に使用できます。
構文
DBMS_MGWADM.SET_OPTION ( target_type IN PLS_INTEGER, target_name IN VARCHAR2, option_name IN VARCHAR2, option_value IN VARCHAR2, encrypted IN BOOLEAN DEFAULT FALSE );
パラメータ
表108-47 SET_OPTIONプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・ゲートウェイ・エンティティのターゲット・タイプを指定します。
|
|
ターゲットの名前または識別子。このパラメータの値は、 |
option_name |
オプション名。 |
|
オプション値。 |
|
値を暗号化して保存するかどうかを指定します。
|
参照:
option_type
パラメータのオプションは、表108-10を参照してください。
使用上のノート
DBMS_MGWADM.AGENT_JAVA_PROPターゲット
このプロシージャは、メッセージ・ゲートウェイ・エージェントの起動時にJava Systemプロパティを設定するために使用されるエージェント・オプションを格納します。変更を有効にするには、エージェントを再起動する必要があります。
パラメータは、次のように解釈されます。
-
target_name
は、メッセージ・ゲートウェイ・エージェントの名前を指定します。デフォルトのエージェントには、DBMS_MGWADM
.DEFAULT_AGENT
を使用できます。 -
option_name
は、Java Systemプロパティを指定します。 -
encrypted
は、TRUE
またはFALSE
に設定できます。
DBMS_MGWADM.MSGLINK_OPTIONターゲット
このプロシージャは、メッセージ・ゲートウェイのメッセージ・システム・リンクの単一オプションを設定または変更します。このプロシージャは、DBMS_MGWADM
.ALTER_MSGSYSTEM_LINK
をコールし、optionsパラメータを使用してオプションを設定する処理と同等です。
パラメータは、次のように解釈されます。
-
target_name
は、メッセージ・システム・リンクの名前を指定します。 -
option_name
は、設定するオプションを指定します。 -
encrypted
はFALSE
に設定する必要があります。
DBMS_MGWADM.JOB_OPTIONターゲット
このプロシージャは、メッセージ・ゲートウェイの伝播ジョブの単一オプションを設定または変更します。このプロシージャは、DBMS_MGWADM
.ALTER_JOB
をコールし、optionsパラメータを使用してオプションを設定する処理と同等です。
パラメータは、次のように解釈されます。
-
target_name
は、伝播ジョブの名前を指定します。 -
option_name
は、設定するオプションを指定します。 -
encrypted
はFALSE
に設定する必要があります。
108.5.29 SHUTDOWNプロシージャ
このプロシージャは、メッセージ・ゲートウェイ・エージェントを停止します。メッセージ・ゲートウェイが再起動されるまで、伝播アクティビティは実行されません。
構文
DBMS_MGWADM.SHUTDOWN ( sdmode IN BINARY_INTEGER DEFAULT DBMS_MGWADM.SHUTDOWN_NORMAL);
DBMS_MGWADM.SHUTDOWN ( agent_name IN VARCHAR2);
パラメータ
表108-48 SHUTDOWNプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
停止モード。現在指定できる値は、通常の停止を意味する |
|
メッセージ・ゲートウェイ・エージェントを識別します。 |
使用上のノート
エージェント名を指定しない場合、メッセージ・ゲートウェイのデフォルト・エージェントは停止します。
108.5.30 STARTUPプロシージャ
このプロシージャは、メッセージ・ゲートウェイ・エージェントを起動します。伝播アクティビティを行う前に、このプロシージャをコールする必要があります。
構文
DBMS_MGWADM.STARTUP( instance IN BINARY_INTEGER DEFAULT 0, force IN BINARY_INTEGER DEFAULT DBMS_MGWADM.NO_FORCE);
DBMS_MGWADM.STARTUP( agent_name IN VARCHAR2);
パラメータ
表108-49 STARTUPプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
メッセージ・ゲートウェイ・エージェントの起動に使用されるジョブ・キューのジョブを実行できるインスタンスを指定します。0(ゼロ)の場合は、どのインスタンスでもジョブを実行できます。 注意: このパラメータは非推奨となっています。 |
|
注意: このパラメータは非推奨となっています。 |
|
メッセージ・ゲートウェイ・エージェントを識別します。 |
使用上のノート
-
エージェント名を指定しない場合は、デフォルトのメッセージ・ゲートウェイ・エージェントが起動します。
-
force
およびinstance
パラメータは使用されないため、無視されます。instance
アフィニティ・パラメータを使用して、特定のインスタンス上でデフォルト・エージェントを起動した場合、管理者はデータベース・サービスを作成し、DBMS_MGWADM
.ALTER_AGENT
プロシージャを使用して、このサービスをデフォルト・エージェントに割り当てる必要があります。 -
DBMS_MGWADM
.CREATE_AGENT
またはDBMS_MGWADM
.ALTER_AGENT
サブプログラムによってエージェント・ユーザーが構成されるまで、メッセージ・ゲートウェイ・エージェントは起動できません。
108.5.31 UNREGISTER_FOREIGN_QUEUEプロシージャ
このプロシージャは、Oracle以外のキュー・エンティティをメッセージ・ゲートウェイから削除します。
構文
DBMS_MGWADM.UNREGISTER_FOREIGN_QUEUE( name IN VARCHAR2, linkname IN VARCHAR2);
パラメータ
表108-50 UNREGISTER_FOREIGN_QUEUEプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
キュー名 |
|
キューが存在するメッセージ・システムに対するリンク名 |
使用上のノート
-
このプロシージャは、Oracle以外のメッセージ・システムの物理的なキューを削除しません。
-
キューの登録を解除するには、このキューを参照しているすべての伝播ジョブ、サブスクライバおよびスケジュールの登録を解除する必要があります。伝播ジョブ、サブスクライバまたは伝播スケジュールがOracle以外のキューを参照している場合、このプロシージャは失敗します。
108.5.32 UNSCHEDULE_PROPAGATIONプロシージャ
この推奨されないプロシージャは、伝播スケジュールを削除します。
ノート:
テクノロジが改良されたため(「REMOVE_JOBプロシージャ」を参照)、このサブプログラムは非推奨となっています(このサブプログラムは、下位互換性を維持する目的でのみ保持されています)。
構文
DBMS_MGWADM.UNSCHEDULE_PROPAGATION ( schedule_id IN VARCHAR2 );
パラメータ
表108-51 UNSCHEDULE_PROPAGATIONプロシージャのパラメータ
パラメータ | 説明 |
---|---|
|
削除する伝播スケジュールを識別します。 |