76 DBMS_MGWADM

DBMS_MGWADMは、メッセージ・ゲートウェイの管理インタフェースを定義します。パッケージとオブジェクト・タイプの所有者はSYSです。

注意: catmgw.sqlスクリプトを実行して、メッセージ・ゲートウェイのパッケージおよびタイプをデータベースにロードする必要があります。

関連項目: データベース・オブジェクトのロード方法およびDBMS_MGWADMの使用方法の詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』を参照してください。

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

• DBMS_MGWADMの使用方法

  • 定数

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

• データ構造

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

---

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プロシージャを使用します。

---

定数

• DBMS_MGWADM定数: クリーンアップ処理

• DBMS_MGWADM定数: 強制値

• DBMS_MGWADM定数: ロギング・レベル

• DBMS_MGWADM定数: 名前付きのプロパティの定数

• DBMS_MGWADM定数: その他の定数

• DBMS_MGWADM定数: 伝播タイプ

• DBMS_MGWADM定数: キュー・ドメイン・タイプ

• DBMS_MGWADM定数: 停止モード

• DBMS_MGWADM定数: WebSphere MQインタフェース・タイプ

• DBMS_MGWADM定数: SET_OPTIONおよびREMOVE_OPTIONプロシージャのtarget_type引数

• DBMS_MGWADM定数: CREATE_AGENTおよびALTER_AGENTプロシージャのconntype引数

表76-1 DBMS_MGWADM定数: クリーンアップ処理

名前	タイプ	説明
CLEAN_STARTUP_STATE	CONSTANT BINARY_INTEGER	メッセージ・ゲートウェイ・エージェントを既知の状態に設定して、起動できるようにします。
CLEAN_LOG_QUEUES	CONSTANT BINARY_INTEGER	構成されたすべてのメッセージ・システム・リンクのログ・キューをメッセージ・ゲートウェイ・エージェントによってクリアします。
RESET_SUB_MISSING_LOG_REC	CONSTANT BINARY_INTEGER	ログ・レコードが存在しないためにエラーになったメッセージ・ゲートウェイ・サブスクライバをメッセージ・ゲートウェイ・エージェントによって復元します。
RESET_SUB_MISSING_MESSAGE	CONSTANT BINARY_INTEGER	永続ソース・メッセージが存在しないためにエラーになったメッセージ・ゲートウェイ・サブスクライバをメッセージ・ゲートウェイ・エージェントによって復元します。

表76-2 DBMS_MGWADM定数: 強制値

名前	タイプ	説明
FORCE	CONSTANT BINARY_INTEGER	強制処理を表します。
NO_FORCE	CONSTANT BINARY_INTEGER	通常の非強制処理を表します。

表76-3 DBMS_MGWADM定数: ロギング・レベル

名前	タイプ	説明
BASIC_LOGGING	CONSTANT BINARY_INTEGER	ログ・ファイルに書き込まれる標準（最小限の）情報
TRACE_DEBUG_LOGGING	CONSTANT BINARY_INTEGER	ログ・ファイルに書き込まれる最大限の情報
TRACE_HIGH_LOGGING	CONSTANT BINARY_INTEGER	ログ・ファイルに書き込まれるログ情報の第3レベルの詳細
TRACE_LITE_LOGGING	CONSTANT BINARY_INTEGER	ログ・ファイルに書き込まれるログ情報の第2レベルの詳細

表76-4 DBMS_MGWADM定数: 名前付きのプロパティの定数

名前	タイプ	説明
MGWPROP_PREFIX	CONSTANT VARCHAR2	予約済のプロパティ名接頭辞の定数（MGWPROP$_）
MGWPROP_REMOVE	CONSTANT VARCHAR2	既存のプロパティを削除するために使用される予約済のプロパティ名の定数（MGWPROP$_REMOVE）。
MGWPROP_REMOVE_ALL	CONSTANT VARCHAR2	すべてのプロパティを削除するために使用される予約済のプロパティ名の定数（MGWPROP$_REMOVE_ALL）。

表76-5 DBMS_MGWADM定数: その他の定数

名前	タイプ	説明
JMS_CONNECTION	CONSTANT BINARY_INTEGER	JMSコネクションを使用して、ドメインに依存しない方法（統一されたメッセージ・モデルがサポートされている方法）で、JMS宛先にアクセスすることを示します。
JMS_QUEUE_CONNECTION	CONSTANT BINARY_INTEGER	JMSキュー・コネクションを使用してJMS宛先にアクセスすることを示します。
JMS_TOPIC_CONNECTION	CONSTANT BINARY_INTEGER	JMSトピック・コネクションを使用してJMS宛先にアクセスすることを示します。
NO_CHANGE	CONSTANT VARCHAR2	既存の値を保持する（変更しない）ことを示します。これは、1つ以上のパラメータを変更し、その他のパラメータは変更しない場合に、特定のAPIに使用されます。
DEFAULT_AGENT	CONSTANT VARCHAR2	デフォルトのメッセージ・ゲートウェイ・エージェントの名前。

表76-6 DBMS_MGWADM定数: 伝播タイプ

名前	タイプ	説明
INBOUND_PROPAGATION	CONSTANT BINARY_INTEGER	Oracle以外からOracle Streams AQへの伝播用の伝播タイプを表します。伝播ソースは外部（Oracle以外の）メッセージ・システムのキューで、宛先はローカルOracle Streams AQキューです。
OUTBOUND_PROPAGATION	CONSTANT BINARY_INTEGER	Oracle Streams AQからOracle以外への伝播用の伝播タイプを表します。伝播ソースはローカルOracle Streams AQキューで、宛先は外部（Oracle以外の）メッセージ・システムのキューです。

表76-7 DBMS_MGWADM定数: キュー・ドメイン・タイプ

名前	タイプ	説明
DOMAIN_QUEUE	CONSTANT BINARY_INTEGER	キューの宛先を表します。JMSキュー（Point-to-Pointモデル）はキューとして分類されます。
DOMAIN_TOPIC	CONSTANT BINARY_INTEGER	トピックの宛先を表します。JMSトピック（パブリッシュ・サブスクライブ・モデル）はトピックとして分類されます。

表76-8 DBMS_MGWADM定数: 停止モード

名前	タイプ	説明
SHUTDOWN_IMMEDIATE	CONSTANT BINARY_INTEGER	即時停止モードを表します。
SHUTDOWN_NORMAL	CONSTANT BINARY_INTEGER	通常の停止モードを表します。

表76-9 DBMS_MGWADM定数: WebSphere MQインタフェース・タイプ

名前	タイプ	説明
MQSERIES_BASE_JAVA_INTERFACE	CONSTANT BINARY_INTEGER	WebSphere MQメッセージ・システム用のBase Javaインタフェースを表します。

表76-10 DBMS_MGWADM定数: SET_OPTIONおよびREMOVE_OPTIONプロシージャのtarget_type引数

名前	タイプ	説明
AGENT_JAVA_PROP	CONSTANT PLS_INTEGER	Java Systemプロパティを設定する場合に使用されるエージェント・オプション用。
MSGLINK_OPTION	CONSTANT PLS_INTEGER	メッセージ・システム・リンク・オプション用。
JOB_OPTION	CONSTANT PLS_INTEGER	伝播ジョブ・オプション用。

表76-11 DBMS_MGWADM定数: CREATE_AGENTおよびALTER_AGENTプロシージャのconntype引数

名前	タイプ	説明
JDBC_OCI	CONSTANT VARCHAR2	JDBC OCIドライバの指定用
JDBC_THIN	CONSTANT VARCHAR2	JDBC Thinドライバの指定用

---

データ構造

DBMS_MGWADMパッケージは、次のOBJECTタイプを定義します。

オブジェクト・タイプ

• SYS.MGW_MQSERIES_PROPERTIESオブジェクト・タイプ

• SYS.MGW_PROPERTIESオブジェクト・タイプ

• SYS.MGW_PROPERTYオブジェクト・タイプ

• SYS.MGW_TIBRV_PROPERTIESオブジェクト・タイプ

---

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,
   max_connections     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 );

属性

表76-12 SYS.MGW_MQSERIES_PROPERTIESの属性

属性	説明
queue_manager	WebSphere MQキュー・マネージャの名前。
hostname	WebSphere MQメッセージ・システムが常駐しているホスト。ホスト名がNULLの場合は、WebSphere MQバインド接続が使用されます。ホスト名がNULL以外の場合は、クライアント接続が使用され、ポートとチャネルを指定する必要があります。
port	ポート番号。クライアント接続の場合のみ、つまりhostnameがNULL以外の場合に使用されます。
channel	キュー・マネージャへの接続の確立時に使用されるチャネル。クライアント接続の場合のみ、つまりhostnameがNULL以外の場合に使用されます。
interface_type	使用するメッセージ・インタフェースのタイプ。値は次のとおりです。 DBMS_MGWADM.MQSERIES_BASE_JAVA_INTERFACE（WebSphere MQ Base Javaインタフェースを使用する場合） DBMS_MGWADM.JMS_CONNECTION（リンクを使用し、統一されたドメインに依存しない方法でJMS宛先にアクセスする場合） DBMS_MGWADM.JMS_QUEUE_CONNECTION（リンクを使用してJMSキューにアクセスする場合） DBMS_MGWADM.JMS_TOPIC_CONNECTION（リンクを使用してJMSトピックにアクセスする場合）
max_connections	WebSphere MQメッセージ・システムへのメッセージ接続の最大数。
username	WebSphere MQメッセージ・システムに対する認証に使用されるユーザー名。
password	WebSphere MQメッセージ・システムに対する認証に使用されるパスワード。
inbound_log_queue	このメッセージ・リンクがインバウンド伝播に使用される場合、つまり、このリンクと関連付けられたキューが伝播ソースとして機能する場合に、伝播リカバリの目的で使用されるWebSphere MQキューの名前。 MQSERIES_BASE_JAVA_INTERFACEの場合は、WebSphere MQ管理ツールを使用して作成される物理WebSphere MQキューの名前。 JMS_CONNECTIONインタフェースおよびJMS_QUEUE_CONNECTIONインタフェースの場合は、WebSphere MQ管理ツールを使用して作成される物理WebSphere MQキューの名前。 JMS_TOPIC_CONNECTIONインタフェースの場合は、WebSphere MQ JMSトピックの名前。このトピックのサブスクライバが使用するWebSphere MQ物理キューは、WebSphere MQ管理ツールを使用して作成する必要があります。デフォルトで使用される物理キューは、SYSTEM.JMS.D.SUBSCRIBER.QUEUEです。
outbound_log_queue	このメッセージ・リンクがアウトバウンド伝播に使用される場合、つまり、このリンクと関連付けられたキューが伝播宛先として機能する場合に、伝播リカバリの目的で使用されるWebSphere MQキューの名前。 MQSERIES_BASE_JAVA_INTERFACEの場合は、WebSphere MQ管理ツールを使用して作成される物理WebSphere MQキューの名前。 JMS_CONNECTIONインタフェースおよびJMS_QUEUE_CONNECTIONインタフェースの場合は、WebSphere MQ管理ツールを使用して作成される物理WebSphere MQキューの名前。 JMS_TOPIC_CONNECTIONインタフェースの場合は、WebSphere MQ JMSトピックの名前。このトピックのサブスクライバが使用するWebSphere MQ物理キューは、WebSphere MQ管理ツールを使用して作成する必要があります。デフォルトで使用される物理キューは、SYSTEM.JMS.D.SUBSCRIBER.QUEUEです。

メソッド

表76-13 SYS.MGW_MQSERIES_PROPERTIESメソッド

メソッド	説明
construct	新規SYS.MGW_MQSERIES_PROPERTIESインスタンスを構成します。すべての属性にNULLが割り当てられます。
alter_construct	既存のメッセージ・リンクのプロパティを変更するために、新規SYS.MGW_MQSERIES_PROPERTIESインスタンスを作成します。 VARCHAR2データ型のすべての属性に、DBMS_MGWADM.NO_CHANGE値が割り当てられます。他のデータ型の属性には、NULL値が割り当てられます。

---

SYS.MGW_PROPERTIESオブジェクト・タイプ

このタイプは、プロパティの配列を指定します。

構文

TYPE SYS.MGW_PROPERTIES AS VARRAY (2000) OF SYS.MGW_PROPERTY;

属性

表76-14 SYS.MGW_PROPERTIESの属性

属性	説明
name	プロパティ名
value	プロパティ値

使用上の注意

特に注記がないかぎり、メッセージ・ゲートウェイは、名前付きのプロパティを次のように使用します。

• 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パッケージは、表76-4「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 );

属性

表76-15 SYS.MGW_PROPERTYの属性

属性	説明
name	プロパティ名
value	プロパティ値

メソッド

表76-16 SYS.MGW_PROPERTYメソッド

メソッド	説明
construct --- (1)	新規MGW_PROPERTYインスタンスを作成します。すべての属性にNULLが割り当てられます。
construct --- (2)	特定のパラメータを使用して初期化される新規MGW_PROPERTYインスタンスを構成します。

---

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 );

属性

表76-17 SYS.MGW_TIBRV_PROPERTIES属性

属性	説明
service	rvdトランスポート用のサービス・パラメータ
daemon	rvdトランスポート用のデーモン・パラメータ
network	rvdトランスポート用のネットワーク・パラメータ
cm_name	CM correspondentの名前。将来使用するために予約されています。
cm_ledger	CM ledgerのファイル名。将来使用するために予約されています。

メソッド

表76-18 SYS.MGW_TIBRV_PROPERTIESメソッド

メソッド	説明
construct	新規SYS.MGW_TIBRV_PROPERTIESインスタンスを構成します。すべての属性にNULL値が割り当てられます。
alter_construct	新規SYS.MGW_TIBRV_PROPERTIESインスタンスを構成します。このファンクションは、既存のメッセージ・リンクのプロパティ変更に使用できます。 VARCHAR2データ型のすべての属性に、DBMS_MGWADM.NO_CHANGE値が割り当てられます。他のデータ型の属性には、NULL値が割り当てられます。

---

DBMS_MGWADMサブプログラムの要約

表76-19 DBMS_MGWADMパッケージのサブプログラム

サブプログラム	説明
ADD_SUBSCRIBERプロシージャ	伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを追加します。
ALTER_AGENTプロシージャ	メッセージ・ゲートウェイ・エージェントのパラメータを変更します。
ALTER_JOBプロシージャ	伝播ジョブのプロパティを変更します。
TIB/Rendezvous用のALTER_MSGSYSTEM_LINKプロシージャ	TIB/Rendezvousメッセージ・システム・リンクのプロパティを変更します。
WebSphere MQ用のALTER_MSGSYSTEM_LINKプロシージャ	WebSphere MQメッセージ・システム・リンクのプロパティを変更します。
ALTER_PROPAGATION_SCHEDULEプロシージャ	伝播スケジュールを変更します。
ALTER_SUBSCRIBERプロシージャ	伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバのパラメータを変更します。
CLEANUP_GATEWAYプロシージャ	メッセージ・ゲートウェイをクリーンアップします。
CREATE_AGENTプロシージャ	伝播ジョブの処理に使用されるメッセージ・ゲートウェイ・エージェントを作成します。
CREATE_JOBプロシージャ	ソースから宛先にメッセージを伝播するために使用されるジョブを作成します。
TIB/Rendezvous用のCREATE_MSGSYSTEM_LINKプロシージャ	TIB/Rendezvousメッセージ・システムへのメッセージ・システム・リンクを作成します。
WebSphere MQ用のCREATE_MSGSYSTEM_LINKプロシージャ	WebSphere MQメッセージ・システムへのメッセージ・システム・リンクを作成します。
DB_CONNECT_INFOプロシージャ	Oracle Databaseに接続するためにメッセージ・ゲートウェイ・エージェントが使用する接続情報を構成します。
DISABLE_JOBプロシージャ	伝播ジョブを使用禁止にします。
DISABLE_PROPAGATION_SCHEDULEプロシージャ	伝播スケジュールを使用禁止にします。
ENABLE_JOBプロシージャ	伝播ジョブを使用可能にします。
ENABLE_PROPAGATION_SCHEDULEプロシージャ	伝播スケジュールを使用可能にします。
REGISTER_FOREIGN_QUEUEプロシージャ	Oracle以外のキュー・エンティティをメッセージ・ゲートウェイに登録します。
REMOVE_AGENTプロシージャ	メッセージ・ゲートウェイ・エージェントを削除します。
REMOVE_JOBプロシージャ	伝播ジョブを削除します。
REMOVE_MSGSYSTEM_LINKプロシージャ	Oracle以外のメッセージ・システムに対するメッセージ・システム・リンクを削除します。
REMOVE_OPTIONプロシージャ	メッセージ・ゲートウェイ構成オプションを削除します。
REMOVE_SUBSCRIBERプロシージャ	伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを削除します。
RESET_JOBプロシージャ	伝播ジョブの伝播エラー状態をリセットします。
RESET_SUBSCRIBERプロシージャ	サブスクライバの伝播エラー状態をリセットします。
SCHEDULE_PROPAGATIONプロシージャ	ソースから宛先へのメッセージ伝播をスケジュールします。
SET_LOG_LEVELプロシージャ	メッセージ・ゲートウェイ・エージェントのロギング・レベルを動的に変更します。
SET_OPTIONプロシージャ	メッセージ・ゲートウェイ構成オプションを設定します。
SHUTDOWNプロシージャ	メッセージ・ゲートウェイ・エージェントを停止します。
STARTUPプロシージャ	メッセージ・ゲートウェイ・エージェントを起動します。
UNREGISTER_FOREIGN_QUEUEプロシージャ	Oracle以外のキュー・エンティティをメッセージ・ゲートウェイから削除します。
UNSCHEDULE_PROPAGATIONプロシージャ	伝播スケジュールを削除します。

---

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);

パラメータ

表76-20 ADD_SUBSCRIBERプロシージャのパラメータ

パラメータ	説明
subscriber_id	このサブスクライバを識別するユーザー定義名を指定します。
propagation_type	メッセージ伝播のタイプを指定します。Oracle Streams AQからOracle以外への伝播の場合は、DBMS_MGWADM.OUTBOUND_PROPAGATIONです。 Oracle以外からOracle Streams AQへの伝播の場合は、DBMS_MGWADM.INBOUND_PROPAGATIONです。
queue_name	このサブスクライバが追加されるソース・キューを指定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
destination	このサブスクライバによってコンシュームされるメッセージの伝播先の宛先キューを指定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
rule	ソース・キューからメッセージをデキューするために、サブスクライバが使用するオプションのサブスクリプション・ルールを指定します。ルールが必要ない場合はNULLを設定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
transformation	メッセージ・ゲートウェイによって定義されるユーザー定義型とOracle Streams AQペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、propagation_typeに指定された値によって決まります。 NULLの場合、Oracle Streams AQペイロード・タイプはメッセージ・ゲートウェイによってサポートされる必要があります。
exception_queue	例外メッセージ・ロギングの目的で使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。NULLの場合、問題発生時に例外キューは使用されず、伝播は停止します。 このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。 ソース・キューと例外キューを同じキューにはできません。
options	オプションのサブスクライバ・プロパティ。オプションのプロパティがない場合は、NULLを設定します。これらは、メッセージ・システムでサポートされている、通常あまり使用されない構成プロパティです。

使用上の注意

関連項目: メッセージ変換の詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のメッセージの変換を使用した任意のペイロード・タイプの処理に関する項を参照してください。

サブスクライバがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Streams AQキューにアクセスします。それ以外の場合は、Oracle Streams AQのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。

Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。その場合は、変換パラメータをNULLに設定してください。

関連項目: サブスクライバ・オプションの詳細は、次の項目を参照してください。 『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項。 『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項。

OUTBOUND_PROPAGATIONサブスクライバ

サブスクライバがアウトバウンド伝播に使用するパラメータは次のように解釈されます。

• queue_name - 伝播ソースであるOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

• destination - メッセージの伝播先の外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

• rule - Oracle Streams AQのネイティブ・インタフェースが使用されている場合は、Oracle Streams AQのオプションのサブスクライバ・ルールを指定します。また、Oracle JMSインタフェースが使用されている場合は、JMSセレクタを指定します。NULLの場合、ルールまたはセレクタは使用されません。

• transformation - Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるユーザー定義型に変換するために使用される変換機能を指定します。

  メッセージ・ゲートウェイ伝播では、Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるユーザー定義型に変換するための変換機能を使用して、Oracle Streams AQキューからメッセージをデキューします。その後、メッセージは、メッセージ・ゲートウェイのユーザー定義型に基づいて外部メッセージ・システムにエンキューされます。

• exception_queue - 例外が発生した場合にメッセージを移動するOracle Streams AQローカル・キューの名前を指定します。このキューは、schema.queueの構文で指定する必要があります。

Oracle Streams AQのネイティブ・インタフェースが使用されている場合は、メッセージ・ゲートウェイが実行されているかどうかに関係なく、ADD_SUBSCRIBERプロシージャをコールしたときに、サブスクライバがOracle Streams AQキューに追加されます。 ローカル・サブスクライバの形式は、sys.aq$_agent('MGW_subscriber_id', NULL, NULL)になります。

Oracle JMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントは、MGW_subscriber_idという名前のJMS永続サブスクライバを作成します。エージェントが実行されていないときにADD_SUBSCRIBERプロシージャをコールすると、次にエージェントが起動された時点で、永続サブスクライバが作成されます。

例外キューについては、次の点に注意してください。

• 例外キューとして使用されるOracle Streams AQキューは、ユーザーが作成する必要があります。

• ソース・キューと例外キューのペイロード・タイプは一致している必要があります。

• 例外キューは、キュー・タイプDBMS_AQADM.EXCEPTION_QUEUEではなく、DBMS_AQADM.NORMAL_QUEUEで作成する必要があります。 エンキューの制限事項によって、メッセージ・ゲートウェイ伝播は、メッセージ・ゲートウェイ例外キューとしてタイプEXCEPTION_QUEUEのOracle Streams AQキューを使用できません。

INBOUND_PROPAGATIONサブスクライバ

サブスクライバがインバウンド伝播に使用するパラメータは次のように解釈されます。

• queue_name - 伝播ソースである外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

• destination - メッセージの伝播先のOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

• rule − 外部メッセージ・システムに対して有効であるオプションのサブスクライバ・ルールを指定します。ルールが必要ない場合はNULLを設定します。

• transformation − メッセージ・ゲートウェイによって定義されるユーザー定義型をOracle Streams AQペイロード・タイプに変換するために使用する変換機能を指定します。

  メッセージ・ゲートウェイ伝播は、外部メッセージ・システムのキューからメッセージをデキューし、メッセージ本体をメッセージ・ゲートウェイによって定義される既知のユーザー定義型に変換します。変換機能は、メッセージがOracle Streams AQキューにエンキューされるときに、メッセージ・ゲートウェイ・ユーザー定義型をOracle Streams AQペイロード・タイプに変換するために使用されます。

• exception_queue - 例外が発生した場合にメッセージを移動する外部キューの名前を指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

サブスクライバが必要かどうかは、Oracle以外のメッセージ・システムの要件によって決まります。永続サブスクライバが必要である場合は、メッセージ・ゲートウェイ・エージェントによって永続サブスクライバが作成されます。ADD_SUBSCRIBERプロシージャをコールした時点でエージェントが実行されていない場合は、次にエージェントが起動されたときに、Oracle以外のメッセージ・システム上で永続サブスクライバが作成されます。

例外キューについては、次の点に注意してください。

• 例外キューは、登録済のOracle以外のキューであることが必要です。

• ソース・キューと例外キューは、同じメッセージ・システム・リンクを使用する必要があります。

---

ALTER_AGENTプロシージャ

このプロシージャは、メッセージ・ゲートウェイ・エージェントのパラメータを構成します。

構文

DBMS_MGWADM.ALTER_AGENT (
   max_connections  IN  BINARY_INTEGER DEFAULT NULL,
   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 );

パラメータ

表76-21 ALTER_AGENTプロシージャのパラメータ

パラメータ	説明
max_connections	Oracle Databaseに対するメッセージ接続のうち、メッセージ・ゲートウェイ・エージェントが使用するメッセージ接続の最大数。NULLの場合、現行の値は変更されません。 注意: このパラメータは使用しないことをお薦めします。
max_memory	メッセージ・ゲートウェイ・エージェントが使用する最大ヒープ・サイズ（MB）。NULLの場合、現行の値は変更されません。
max_threads	メッセージ・ゲートウェイ・エージェントが作成するメッセージ・スレッドの最大数。NULLの場合、現行の値は変更されません。
service	このエージェントが使用するOracle Schedulerジョブ・クラスが親和性を持つデータベース・サービスを指定します。つまり、RAC環境では、メッセージ・ゲートウェイ・エージェントはこのサービスに割り当てられたデータベース・インスタンスでのみ実行されます。NULLの場合、このエージェントで使用されるジョブ・クラスは、各インスタンスにマッピングされたデフォルト・サービスに属するように変更されます。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
agent_name	メッセージ・ゲートウェイ・エージェントを識別します。DBMS_MGWADM.DEFAULT_AGENTはデフォルトのエージェントを指定します。
username	Oracle Databaseへの接続に使用するユーザー名を指定します。NULLは設定できません。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。ユーザー名を指定した場合は、パスワードも指定する必要があります。
password	Oracle Databaseへの接続に使用するパスワードを指定します。NULLは設定できません。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。ユーザー名を指定した場合は、パスワードも指定する必要があります。
データベース	Oracle Databaseへの接続に使用するデータベース接続文字列を指定します。NULLは、ローカル接続を使用することを示します。 DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。NULLではなく接続文字列を指定することをお薦めします。通常は、tnsnames.ora内のネットワーク・サービス名を指定します。
conntype	Oracle Databaseとの接続タイプ（DBMS_MGWADM.JDBC_OCIまたはDBMS_MGWADM.JDBC_THIN）を指定します。 DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
initfile	エージェントが使用するメッセージ・ゲートウェイの初期化ファイルを指定します。NULLは、デフォルトの初期化ファイルが使用されることを示します。指定する値はファイルのフルパス名である必要があります。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
comment	このエージェントのオプションのコメント。コメントが必要ない場合はNULLを設定します。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。

注意: このサブプログラムの以前のバージョンに含まれていたmax_connectionsパラメータは非推奨になり、実行できません。

使用上の注意

• これらの構成パラメータのデフォルト値は、メッセージ・ゲートウェイ・エージェントのインストール時に設定されます。

• max_memoryとmax_threadsパラメータに対する変更は、次回メッセージ・ゲートウェイ・エージェントがアクティブになったときに有効になります。メッセージ・ゲートウェイ・エージェントが現在アクティブの場合、変更を有効にするには、エージェントを停止し、再起動する必要があります。

• serviceパラメータは、Oracle Schedulerのジョブ・クラスの属性を設定する場合に使用します。ジョブ・クラスは、メッセージ・ゲートウェイ・エージェントを起動するスケジューラ・ジョブを作成する場合に使用されます。Oracleの管理者は、データベース・サービスを作成する必要があります。値がNULLの場合、ジョブ・クラスはすべてのインスタンスにマッピングされる内部サービスに属します。

• Oracle RDBMS 11gでは、max_connectionsパラメータの使用は推奨されていません。 メッセージ・ゲートウェイ・エージェントで使用されるメッセージ接続数は、max_threadsパラメータの値に基づいています。

• username, passwordおよびdatabaseパラメータは、メッセージ・ゲートウェイ・エージェントがOracle Databaseへの接続に使用する接続情報を指定します。 Oracleの管理者はユーザーを作成し、ロールMGW_AGENT_ROLEを付与する必要があります。

---

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 );

パラメータ

表76-22 ALTER_JOBプロシージャのパラメータ

パラメータ	説明
job_name	伝播ジョブを識別します。
rule	伝播ソースからメッセージをデキューするために使用するオプションのサブスクリプション・ルールを指定します。このパラメータの構文および解釈は、伝播タイプによって決まります。NULL値は、サブスクリプション・ルールが必要ないことを示します。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
transformation	メッセージ・ゲートウェイによって定義されるユーザー定義型とOracle Streams AQペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、propagation_typeに指定された値によって決まります。 NULL値は、変換機能が必要ないことを示します。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
exception_queue	例外メッセージ・ロギングの目的で使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。ジョブと関連付けられた例外キューがない場合、問題発生時に伝播は停止します。このパラメータの構文および解釈は、伝播タイプによって決まります。 NULL値は、例外キューが使用されないことを示します。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
poll_interval	ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値はNULL、0または0より大きい値です。 0（デフォルト）を指定した場合、現行の値は変更されません。 NULLの場合、現行の値はリセットされ、メッセージ・ゲートウェイのデフォルトのポーリング間隔が使用されます。デフォルトのポーリング間隔は5秒間ですが、このデフォルト値はメッセージ・ゲートウェイの初期化ファイルによって上書きできます。
options	オプションのジョブ・プロパティ。NULLの場合、どのオプションも変更されません。NULL以外の場合、このリストで指定されたプロパティは、現行のオプションのプロパティと組み合され、新しいジョブ・オプションのセットが形成されます。
コメント	このエージェントのオプションのコメント。また、コメントが不要である場合は、NULLを指定します。 DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。

使用上の注意

• 伝播ジョブがアクセスする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ジョブ」を参照してください。

---

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 );

パラメータ

表76-23 TIB/Rendezvous用のALTER_MSGSYSTEM_LINKプロシージャのパラメータ

パラメータ	説明
linkname	メッセージ・システム・リンク名。
properties	TIB/Rendezvousメッセージ・システム・リンクの基本プロパティ。NULLの場合、どのリンク・プロパティも変更されません。
options	オプションのリンク・プロパティ。NULLの場合、どのオプションも変更されません。NULL以外の場合、このリストで指定されたプロパティは、現行のオプション・プロパティと組み合され、新しいリンク・オプションのセットを構成します。
comment	ユーザーが指定するコメント。また、コメントが不要である場合は、NULLを指定します。 DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。

使用上の注意

VARCHAR2データ型のメッセージ・リンク・プロパティの既存値を保持するには、その特定のプロパティにDBMS_MGWADM.NO_CHANGEを指定します。別のデータ型のプロパティの既存値を保持するには、そのプロパティにNULLを指定します。

optionsパラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。

関連項目: 「SYS.MGW_PROPERTIESオブジェクト・タイプ」

一部のプロパティは変更できません。このようなプロシージャを変更しようとすると、エラーが発生します。変更可能なプロパティとオプションの中には、動的に変更できるものが少数あります。メッセージ・ゲートウェイでは、動的に変更された新しい値がすぐに使用されます。その他のプロパティやオプションに対する変更を有効にするには、メッセージ・ゲートウェイ・エージェントを停止し、再起動する必要があります。

関連項目: メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項を参照してください。

---

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);

パラメータ

表76-24 WebSphere MQ用のALTER_MSGSYSTEM_LINKプロシージャのパラメータ

パラメータ	説明
linkname	メッセージ・システム・リンク名。
properties	WebSphere MQメッセージ・システム・リンクの基本プロパティ。NULLの場合、リンク・プロパティは変更されません。
options	オプションのリンク・プロパティ。どのオプションも変更しない場合はNULLを設定します。NULL以外の場合、このリストで指定されたプロパティは、現行のオプション・プロパティと組み合され、新しいリンク・オプションのセットを構成します。
comment	オプションの説明。必要ない場合はNULLを設定します。 DBMS_MGWADM.NO_CHANGEが指定された場合、現行の値は変更されません。

使用上の注意

VARCHAR2データ型のメッセージ・リンク・プロパティの既存値を保持するには、その特定のプロパティにDBMS_MGWADM.NO_CHANGEを指定します。別のデータ型のプロパティの既存値を保持するには、そのプロパティにNULLを指定します。

optionsパラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。

関連項目: 「SYS.MGW_PROPERTIESオブジェクト・タイプ」

一部のプロパティは変更できません。このようなプロシージャを変更しようとすると、エラーが発生します。変更可能なプロパティとオプションの中には、動的に変更できるものが少数あります。メッセージ・ゲートウェイでは、動的に変更された新しい値がすぐに使用されます。その他のプロパティやオプションに対する変更を有効にするには、メッセージ・ゲートウェイ・エージェントを停止し、再起動する必要があります。

関連項目: メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項を参照してください。

---

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);

パラメータ

表76-25 ALTER_PROPAGATION_SCHEDULEプロシージャのパラメータ

パラメータ	説明
schedule_id	変更する伝播スケジュールを識別します。
duration	将来使用するために予約されています。
next_time	将来使用するために予約されています。
latency	ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。ソース・キュー内に利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値はNULL、または0より大きい値です。latencyがNULLの場合、メッセージ・ゲートウェイ・エージェントのデフォルトのポーリング間隔が使用されます。デフォルトのポーリング間隔は5秒間ですが、このデフォルト値はメッセージ・ゲートウェイの初期化ファイルによって上書きできます。

使用上の注意

このプロシージャは、各パラメータの既存値を常に上書きします。特定のパラメータが指定されない場合、既存値はデフォルト値で上書きされます。

---

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 );

パラメータ

表76-26 ALTER_SUBSCRIBERプロシージャのパラメータ

パラメータ	説明
subscriber_id	変更するサブスクライバを識別します。
rule	ソース・キューからメッセージをデキューするために、サブスクライバが使用するオプションのサブスクリプション・ルールを指定します。このパラメータの構文および解釈は、サブスクライバの伝播タイプによって決まります。 NULL値は、サブスクリプション・ルールが必要ないことを示します。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
transformation	メッセージ・ゲートウェイによって定義されるユーザー定義型とOracle Streams AQペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、サブスクライバの伝播タイプによって決まります。 NULL値は、変換機能が必要ないことを示します。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。
exception_queue	例外メッセージ・ロギングに使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。サブスクライバと関連付けられた例外キューがない場合、問題発生時に伝播は停止します。このパラメータの構文および解釈は、サブスクライバの伝播タイプによって決まります。 NULL値は、例外キューが使用されないことを示します。DBMS_MGWADM.NO_CHANGEの場合、現行の値は変更されません。 ソース・キューと例外キューを同じキューにはできません。
options	オプションのサブスクライバ・プロパティ。NULLの場合、どのオプションも変更されません。NULL以外の場合、このリストで指定されたプロパティは、現行のオプションのプロパティと組み合され、新しいサブスクライバ・オプションのセットが形成されます。

使用上の注意

サブスクライバがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Streams AQキューにアクセスします。それ以外の場合は、Oracle Streams AQのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。

JMSソースから伝播を行う場合、サブスクライバ・ルールは変更できません。そのため、既存のサブスクライバを削除して、新しいルールとともにサブスクライバを追加する必要があります。JMSにおいて永続サブスクリプション上のメッセージ・セレクタを変更することは、サブスクリプションを削除してから再作成することと同じです。

Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。 したがって、変換パラメータをDBMS_MGWADM.NO_CHANGE（デフォルト値）に設定する必要があります。

optionsパラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。

関連項目: オプションのパラメータの詳細は、「SYS.MGW_PROPERTIESオブジェクト・タイプ」を参照してください。 WebSphere MQサブスクライバ・オプションの詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項を参照してください。 TIB/Rendezvousサブスクライバ・オプションの詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項を参照してください。 アウトバウンド伝播パラメータの解釈については、「OUTBOUND_PROPAGATIONサブスクライバ」を参照してください。 インバウンド伝播パラメータの解釈については、「INBOUND_PROPAGATIONサブスクライバ」を参照してください。

---

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 );

パラメータ

表76-27 CLEANUP_GATEWAYプロシージャのパラメータ

パラメータ	説明
action	実行するクリーンアップ処理。値は次のとおりです。 DBMS_MGWADM.CLEAN_STARTUP_STATE（メッセージ・ゲートウェイ起動状態のリカバリの場合） DBMS_MGWADM.CLEAN_LOG_QUEUES（ログ・キューのクリーンアップの場合） DBMS_MGWADM.RESET_SUB_MISSING_LOG_REC（ログ・レコードが存在しないために発生した伝播ジョブのリカバリの場合） DBMS_MGWADM.RESET_SUB_MISSING_MESSAGE（メッセージが存在しないために発生した伝播ジョブのリカバリの場合）
sarg	actionに指定された値に応じて意味が変わるオプションの引数。指定した処理で引数を使用しない場合は、NULLを指定してください。
agent_name	メッセージ・ゲートウェイ・エージェントを識別します。DBMS_MGWADM.DEFAULT_AGENTはデフォルトのエージェントを指定します。

使用上の注意

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ステータスは、メッセージ・ゲートウェイ・エージェントがすでに実行されている状況がメッセージ・ゲートウェイの起動ジョブによって検出されたことを示します。正常な使用環境では、このような状況は決して発生しません。

この処理では次のタスクが実行されます。

• 外部メッセージ・ゲートウェイ・エージェント・プロセスの起動に使用されるスケジューラ・ジョブを削除します。

• 特定の構成情報を既知の状態に設定します。 たとえば、エージェント・ステータスを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以外の値を指定してください。

永続ソース・メッセージが存在しないためにエラーになったメッセージ・ゲートウェイ伝播ジョブをメッセージ・ゲートウェイ・エージェントによって復元します。エージェントはメッセージを非永続メッセージとして取り扱い、伝播ジョブの処理を続けます。メッセージ・ゲートウェイ・エージェントが実行されていない場合は、処理に失敗します。

---

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 );

パラメータ

表76-28 CREATE_AGENTプロシージャのパラメータ

パラメータ	説明
agent_name	エージェントの識別に使用される名前。
username	Oracle Databaseへの接続に使用するユーザー名を指定します。
password	Oracle Databaseへの接続に使用するパスワードを指定します。ユーザー名を指定した場合は、パスワードも指定する必要があります。
データベース	Oracle Databaseへの接続に使用するデータベース接続文字列を指定します。NULLは、ローカル接続を使用することを示します。ユーザー名を指定した場合は、値を指定できます。NULLではなく接続文字列を指定することを強くお薦めします。通常は、tnsnames.ora内のネットワーク・サービス名を指定します。
conntype	Oracle Databaseとの接続タイプ（DBMS_MGWADM.JDBC_OCIまたはDBMS_MGWADM.JDBC_THIN）を指定します。
max_memory	メッセージ・ゲートウェイ・エージェントが使用する最大ヒープ・サイズ（MB）を指定します。
max_threads	メッセージ・ゲートウェイ・エージェントが作成するメッセージ・スレッドの数を指定します。これにより、エージェントが同時に処理できる伝播ジョブの数が決定されます。
service	このエージェントが使用するOracle Schedulerジョブ・クラスが親和性を持つデータベース・サービスを指定します。つまり、RAC環境では、メッセージ・ゲートウェイ・エージェントは、このサービスに割り当てられたデータベース・インスタンスでのみ実行されます。NULLの場合、ジョブ・クラスは、各インスタンスにマッピングされるデフォルト・サービスに属します。
initfile	エージェントが使用するメッセージ・ゲートウェイの初期化ファイルを指定します。NULLは、デフォルトの初期化ファイルが使用されることを示します。指定する値はファイルのフルパス名である必要があります。
comment	このエージェントのオプションのコメント。必要ない場合はNULLを設定します。

使用上の注意

• メッセージ・ゲートウェイをインストールすると、デフォルト・エージェントが自動的に構成されます。 デフォルト・エージェントの名前はDEFAULT_AGENTです。このプロシージャは追加エージェントを作成する場合に使用できます。

• username, passwordおよびdatabaseパラメータは、メッセージ・ゲートウェイ・エージェントがOracle Databaseへの接続に使用する接続情報を指定します。 Oracleの管理者はデータベース・ユーザーを作成し、ロールMGW_AGENT_ROLEを付与する必要があります。接続情報は、このプロシージャをコールするときに指定する必要はありませんが、エージェントを起動する前に指定する必要があります。

• serviceパラメータは、Oracle Schedulerのジョブ・クラスを作成する場合に使用します。ジョブ・クラスは、メッセージ・ゲートウェイ・エージェントを起動するスケジューラ・ジョブを作成する場合に使用されます。Oracleの管理者は、データベース・サービスを作成する必要があります。値がNULLの場合、ジョブ・クラスはすべてのインスタンスがマッピングされる内部サービスに属します。

---

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);

パラメータ

表76-29 CREATE_JOBプロシージャのパラメータ

パラメータ	説明
job_name	伝播ジョブを識別するためのユーザー定義名。
propagation_type	メッセージ伝播のタイプを指定します。 DBMS_MGWADM.OUTBOUND_PROPAGATION（Oracle Streams AQからOracle以外への伝播の場合） DBMS_MGWADM.INBOUND_PROPAGATION（Oracle以外からOracle Streams AQへの伝播の場合）
source	メッセージの伝播元であるソース・キューを指定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
destination	メッセージの伝播先である宛先キューを指定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
rule	ソース・キューからメッセージをデキューするために使用するオプションのサブスクリプション・ルールを指定します。ルールが必要ない場合はNULLを設定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
transformation	メッセージ・ゲートウェイによって定義されるユーザー定義型とOracle Streams AQペイロードとの間の変換に必要な変換機能を指定します。必要な変換機能のタイプは、propagation_typeに指定された値によって決まります。 変換を指定しない場合、Oracle Streams AQペイロード・タイプはメッセージ・ゲートウェイによってサポートされる必要があります。
exception_queue	例外メッセージ・ロギングの目的で使用されるキューを指定します。このキューは、伝播ソースと同じメッセージ・システム上にあることが必要です。NULLの場合、問題発生時に例外キューは使用されず、伝播は停止します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。 ソース・キューと例外キューを同じキューにはできません。
poll_interval	ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値はNULL、または0より大きい値です。NULLの場合、メッセージ・ゲートウェイのデフォルトのポーリング間隔が使用されます。デフォルトのポーリング間隔は5秒間ですが、このデフォルト値はメッセージ・ゲートウェイの初期化ファイルによって上書きできます。
options	オプションのジョブ・プロパティ。オプションのジョブ・プロパティがない場合は、NULLを設定します。これらは、メッセージ・システムでサポートされている、通常あまり使用されない構成プロパティです。
enabled	この伝播ジョブが作成後も有効かどうかを指定します。使用できる値はTRUEまたはFALSEです。 TRUE（デフォルト）の場合、ジョブは作成後も有効です。 FALSEの場合、ジョブは作成後に使用不可になります。メッセージを伝播する前に、伝播ジョブを使用可能にし、メッセージ・ゲートウェイ・エージェントを実行する必要があります。
コメント	このジョブのオプションのコメントです。必要ない場合はNULLを設定します。

使用上の注意

• ジョブが使用可能で、メッセージが伝播されるようにメッセージ・ゲートウェイ・エージェントが適切に起動されている必要があります。

• 伝播ジョブがアクセスする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 Stream AQのネイティブ・インタフェースが使用されている場合は、Oracle Stream AQのオプションのサブスクライバ・ルールを指定します。また、Oracle JMSインタフェースが使用されている場合は、JMSセレクタを指定します。NULLの場合、ルールまたはセレクタは使用されません。ネイティブのOracle Stream AQインタフェースを使用し、伝播ソースがシングル・コンシューマ・キューである場合、このパラメータにはNULLを指定する必要があります。

• transformation - Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるユーザー定義型に変換するために使用される変換機能を指定します。完全な変換名（schema.name）が指定されている場合は、この名前を使用する必要があります。

  メッセージ・ゲートウェイ伝播では、Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるユーザー定義型に変換するための変換機能を使用して、Oracle Streams AQキューからメッセージをデキューします。その後、メッセージは、メッセージ・ゲートウェイのユーザー定義型に基づいて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永続サブスクライバを作成します。エージェントが実行されていないときにADD_SUBSCRIBERプロシージャをコールすると、次にエージェントが起動された時点で、永続サブスクライバが作成されます。

  例外キューには、次の条件があります。

  • 例外キューとして使用される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 − メッセージ・ゲートウェイによって定義されるユーザー定義型をOracle Streams AQペイロード・タイプに変換するために使用する変換機能を指定します。完全な変換名（schema.name）が指定されている場合は、この名前を使用する必要があります。

  メッセージ・ゲートウェイ伝播は、Oracle以外のメッセージ・システムのキューからメッセージをデキューし、メッセージ本体をメッセージ・ゲートウェイによって定義される既知のユーザー定義型に変換します。変換機能は、メッセージがOracle Streams AQキューにエンキューされるときに、メッセージ・ゲートウェイ・ユーザー定義型をOracle Streams AQペイロード・タイプに変換するために使用されます。

• exception_queue − 例外が発生した場合にメッセージを移動する登録済のOracle以外のキューの名前を指定します。 構文は、registered_queue@message_linkである必要があります。

  ソース・キューにサブスクライバが必要かどうかは、Oracle以外のメッセージ・システムの要件によって決まります。永続サブスクライバが必要である場合は、メッセージ・ゲートウェイ・エージェントによって永続サブスクライバが作成されます。エージェントが実行されていないときにこのプロシージャをコールすると、次にエージェントが起動された時点で、Oracle以外のメッセージング・システムにサブスクライバが作成されます。

  例外キューには、次の条件があります。

  • 例外キューは、登録済のOracle以外のキューであることが必要です。

  • ソース・キューと例外キューは、同じメッセージ・システム・リンクを使用する必要があります。

---

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 );

パラメータ

表76-30 TIB/Rendezvous用のCREATE_MSGSYSTEM_LINKプロシージャのパラメータ

パラメータ	説明
linkname	このメッセージ・システム・リンクを識別するためのユーザー定義名。
properties	TIB/Rendezvousメッセージ・システム・リンクの基本プロパティ。
options	オプションのリンク・プロパティ。オプションのプロパティがない場合は、NULLを設定します。これらは、メッセージ・システムでサポートされている、あまり使用されない構成プロパティです。
comment	ユーザーが指定した説明。必要ない場合はNULLを設定します。
agent_name	このリンクに関連付けられたすべての伝播ジョブの処理に使用されるメッセージ・ゲートウェイ・エージェントを指定します。DBMS_MGWADM.DEFAULT_AGENTはデフォルトのエージェントを指定します。

使用上の注意

エージェント名が指定されていない場合、メッセージ・ゲートウェイのデフォルトのエージェントが、このリンクに関連付けられた伝播ジョブを処理します。

関連項目: メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のTIB/Rendezvousシステムのプロパティに関する項を参照してください。

---

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);

パラメータ

表76-31 WebSphere MQ用のCREATE_MSGSYSTEM_LINKプロシージャのパラメータ

パラメータ	説明
linkname	メッセージ・システム・リンクを識別するためのユーザー定義名。
properties	WebSphere MQメッセージ・システム・リンクの基本プロパティ。
options	オプションのリンク・プロパティ。オプションのプロパティがない場合は、NULLを設定します。これらは、メッセージ・システムでサポートされている、あまり使用されない構成プロパティです。
comment	ユーザーが指定した説明。必要ない場合はNULLを設定します。
agent_name	このリンクに関連付けられたすべての伝播ジョブの処理に使用されるメッセージ・ゲートウェイ・エージェントを指定します。DBMS_MGWADM.DEFAULT_AGENTはデフォルトのエージェントを指定します。

使用上の注意

エージェント名が指定されていない場合、メッセージ・ゲートウェイのデフォルトのエージェントが、このリンクに関連付けられた伝播ジョブを処理します。

関連項目: メッセージ・システムのプロパティおよびオプションの詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のWebSphere MQシステムのプロパティに関する項を参照してください。

---

DB_CONNECT_INFOプロシージャ

このプロシージャは、Oracle Databaseに接続するためにメッセージ・ゲートウェイのデフォルト・エージェントが使用する接続情報を構成します。

注意: テクノロジが改良されたため（「ALTER_AGENTプロシージャ」を参照）、このサブプログラムは使用されなくなりました（このサブプログラムは、下位互換性を維持する目的でのみ保持されています）。

構文

DBMS_MGWADM.DB_CONNECT_INFO (
   username      IN VARCHAR2,
   password      IN VARCHAR2,
   database      IN VARCHAR2 DEFAULT NULL);

パラメータ

表76-32 DB_CONNECT_INFOプロシージャのパラメータ

パラメータ	説明
username	Oracle Databaseへの接続に使用するユーザー名。NULLは設定できません。
password	Oracle Databaseへの接続に使用するパスワード。NULLは設定できません。
データベース	メッセージ・ゲートウェイ・エージェントが使用するデータベース接続文字列。NULLは、ローカル接続を使用することを示します。 NULL以外の値を設定することを強くお薦めします。通常は、tnsnames.ora内のネットワーク・サービス名を指定します。

使用上の注意

メッセージ・ゲートウェイ・エージェントは、このプロシージャで構成されたユーザーとしてOracle Databaseに接続します。 Oracleの管理者は、ユーザーを作成し、そのユーザーにロールMGW_AGENT_ROLEを付与した後、このプロシージャをコールしてメッセージ・ゲートウェイを構成する必要があります。 ロールMGW_AGENT_ROLEは、データベースに格納されているメッセージ・ゲートウェイ構成情報へのアクセス、Oracle Streams AQキューとのメッセージのデキューとエンキュー、および特定のOracle Streams AQ管理タスクの実行に必要となる特別な権限をこのユーザーに付与するために使用されます。

---

DISABLE_JOBプロシージャ

このプロシージャは、伝播ジョブを無効にします。

構文

DBMS_MGWADM.DISABLE_JOB (
   job_name  IN VARCHAR2);

パラメータ

表76-33 DISABLE_JOBプロシージャのパラメータ

パラメータ	説明
job_name	伝播ジョブを識別します。

---

DISABLE_PROPAGATION_SCHEDULEプロシージャ

このプロシージャは、伝播スケジュールを無効にします。

注意: テクノロジが改良されたため（「DISABLE_JOBプロシージャ」を参照）、このサブプログラムは使用されなくなりました（このサブプログラムは、下位互換性を維持する目的でのみ保持されています）。

構文

DBMS_MGWADM.DISABLE_PROPAGATION_SCHEDULE (
   schedule_id  IN VARCHAR2);

パラメータ

表76-34 DISABLE_PROPAGATION_SCHEDULEプロシージャのパラメータ

パラメータ	説明
schedule_id	使用禁止にする伝播スケジュールを識別します。

---

ENABLE_JOBプロシージャ

このプロシージャは、伝播ジョブを使用可能にします。

構文

DBMS_MGWADM.ENABLE_JOB (
   job_name  IN VARCHAR2 );

パラメータ

表76-35 ENABLE_JOBプロシージャのパラメータ

パラメータ	説明
job_name	伝播ジョブを識別します。

---

ENABLE_PROPAGATION_SCHEDULEプロシージャ

このプロシージャは、伝播スケジュールを使用可能にします。

注意: テクノロジが改良されたため（「ENABLE_JOBプロシージャ」を参照）、このサブプログラムは使用されなくなりました（このサブプログラムは、下位互換性を維持する目的でのみ保持されています）。

構文

DBMS_MGWADM.ENABLE_PROPAGATION_SCHEDULE (
   schedule_id  IN VARCHAR2 );

パラメータ

表76-36 ENABLE_PROPAGATION_SCHEDULEプロシージャのパラメータ

パラメータ	説明
schedule_id	使用可能にする伝播スケジュールを識別します。

---

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);

パラメータ

表76-37 REGISTER_FOREIGN_QUEUEプロシージャのパラメータ

パラメータ	説明
name	登録されるキュー名。この名前は、メッセージ・ゲートウェイ内で外部キューを識別します。外部メッセージ・システムのキュー名と一致する必要はありません。
linkname	このキューが存在するメッセージ・システムに対するリンク名。
provider_queue	メッセージ・プロバイダ（ネイティブ）のキュー名。NULLの場合は、nameパラメータで指定された値がプロバイダ・キュー名として使用されます。
domain	キューのドメイン・タイプ。NULLは、ドメイン・タイプがメッセージ・システムに基づいて自動的に判断されることを意味します。 DBMS_MGWADM.DOMAIN_QUEUEは、キュー（Point-to-Pointモデル）を示します。 DBMS_MGWADM.DOMAIN_TOPICは、トピック（パブリッシュ・サブスクライブ・モデル）を示します。
options	オプションのキュー・プロパティ。
comment	ユーザーが指定した説明。NULLを設定することもできます。

使用上の注意

このプロシージャは、Oracle以外のメッセージ・システムに物理的なキューを作成しません。Oracle以外のキューは、そのメッセージ・システムの管理ツールを使用して作成する必要があります。

関連項目: WebSphere MQメッセージ・システムまたはTIB/Rendezvousメッセージ・システムのキューを登録する場合の詳細は、『Oracle Streamsアドバンスト・キューイング・ユーザーズ・ガイド』のオプションの外部キュー構成プロパティに関する項を参照してください。

---

REMOVE_AGENTプロシージャ

このプロシージャは、メッセージ・ゲートウェイ・エージェントを削除します。

構文

DBMS_MGWADM.REMOVE_AGENT(
   agent_name   IN   VARCHAR2 );

パラメータ

表76-38 REMOVE_AGENTプロシージャのパラメータ

パラメータ	説明
agent_name	メッセージ・ゲートウェイ・エージェントを識別します。

使用上の注意

このメッセージ・ゲートウェイ・エージェントを削除する前に、このエージェントに関連付けられたすべてのメッセージ・システム・リンクを削除し、このエージェントを停止する必要があります。メッセージ・ゲートウェイのデフォルト・エージェントを削除することはできません。

---

REMOVE_JOBプロシージャ

このプロシージャは、伝播ジョブを削除します。

構文

DBMS_MGWADM.REMOVE_JOB(
   job_name   IN   VARCHAR2,   force      IN   PLS_INTEGER DEFAULT DBMS_MGWADM.NO_FORCE);

パラメータ

表76-39 REMOVE_JOBプロシージャのパラメータ

パラメータ	説明
job_name	伝播ジョブを識別します。
force	メッセージ・ゲートウェイがこの伝播ジョブに関連するすべてのクリーンアップ処理を実行できない場合でも、このプロシージャを正常終了させるかどうかを指定します。 値: DBMS_MGWADM.NO_FORCE、DBMS_MGWADM.FORCE NO_FORCE（デフォルト）は、メッセージ・ゲートウェイがクリーンアップ処理を正常に実行できない場合、ジョブを削除しないことを意味します。 FORCEは、すべてのクリーンアップ処理を完了できない場合でも、ジョブを削除することを意味します。

使用上の注意

• メッセージ・ゲートウェイ・エージェントは、Oracle DatabaseおよびOracle以外のメッセージ・システムの様々なリソースを使用して伝播アクティビティを実行します。ジョブを削除する場合は、これらのリソースを解放する必要があります。たとえば、ジョブを削除するときに削除する必要があるソース・キューに、メッセージ・ゲートウェイが永続サブスクライバを作成することがあります。したがって、通常このプロシージャは、メッセージ・ゲートウェイ・エージェントが実行中で、このジョブに関連付けられたOracle以外のメッセージ・システムにアクセスできるときにコールしてください。

• アウトバウンド伝播の場合、伝播ソースが複数のコンシューマ・キューであるときは、ローカル・サブスクライバがOracle Streams AQキューから削除されます。

---

REMOVE_MSGSYSTEM_LINKプロシージャ

このプロシージャは、Oracle以外のメッセージ・システムに対するメッセージ・システム・リンクを削除します。

構文

DBMS_MGWADM.REMOVE_MSGSYSTEM_LINK(
   linkname  IN VARCHAR2);

パラメータ

表76-40 REMOVE_MSGSYSTEM_LINKプロシージャのパラメータ

パラメータ	説明
linkname	メッセージ・システム・リンク名。

使用上の注意

メッセージ・システム・リンクを削除するには、このリンクと関連付けられた登録済のすべてのキューを削除する必要があります。削除対象のリンクを参照する登録済の外部キュー（Oracle以外の）がある場合、このプロシージャは失敗します。

---

REMOVE_OPTIONプロシージャ

このプロシージャは、メッセージ・ゲートウェイ構成オプションを削除します。エージェント・オプション、メッセージ・リンク・オプションまたは伝播ジョブ・オプションを削除する場合に使用できます。

構文

DBMS_MGWADM.REMOVE_OPTION (
   target_type   IN   PLS_INTEGER,
   target_name   IN   VARCHAR2,
   option_name   IN   VARCHAR2);

パラメータ

表76-41 REMOVE_OPTIONプロシージャのパラメータ

パラメータ	説明
target_type	メッセージ・ゲートウェイ・エンティティのターゲット・タイプを指定します。 DBMS_MGWADM.AGENT_JAVA_PROP（メッセージ・ゲートウェイ・エージェントのJava Systemプロパティを削除する場合） DBMS_MGWADM.MSGLINK_OPTION（メッセージ・リンク・オプションを削除する場合） DBMS_MGWADM.JOB_OPTION（伝播ジョブ・オプションを削除する場合）
target_name	ターゲットの名前または識別子。このパラメータの値は、target_typeパラメータに指定された値によって決まります。NULL以外の値を指定してください。
option_name	オプション名。NULL以外の値を指定してください。

関連項目: option_typeパラメータのオプションについては、表76-10「DBMS_MGWADM定数: SET_OPTIONおよびREMOVE_OPTIONプロシージャのtarget_type引数」を参照してください。

使用上の注意

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に設定する必要があります。

---

REMOVE_SUBSCRIBERプロシージャ

このプロシージャは、伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを削除します。

注意: テクノロジが改良されたため（「REMOVE_JOBプロシージャ」を参照）、このサブプログラムは使用されなくなりました（このサブプログラムは、下位互換性を維持する目的でのみ保持されています）。

構文

DBMS_MGWADM.REMOVE_SUBSCRIBER (
   subscriber_id  IN VARCHAR2,
   force          IN BINARY_INTEGER DEFAULT DBMS_MGWADM.NO_FORCE );

パラメータ

表76-42 REMOVE_SUBSCRIBERプロシージャのパラメータ

パラメータ	説明
subscriber_id	削除するサブスクライバを識別します。
force	メッセージ・ゲートウェイがこのサブスクライバに関連するすべてのクリーンアップ処理を実行できない場合でも、このプロシージャを正常終了させるかどうかを指定します。 値: DBMS_MGWADM.NO_FORCE、DBMS_MGWADM.FORCE NO_FORCEは、メッセージ・ゲートウェイがクリーンアップ処理を正常に実行できない場合、サブスクライバを削除しないことを意味します（デフォルト）。 FORCEは、すべてのクリーンアップ処理を完了できない場合でも、サブスクライバを削除することを意味します。

使用上の注意

• メッセージ・ゲートウェイ・エージェントは、Oracle DatabaseおよびOracle以外のメッセージ・システムの様々なリソースを使用して伝播アクティビティを実行します。これらのリソースは通常、各サブスクライバと関連付けられ、サブスクライバが不要になったときに解放される必要があります。したがって、このプロシージャは、メッセージ・ゲートウェイ・エージェントが実行中で、このサブスクライバに関連付けられたOracle以外のメッセージ・システムにアクセスできるときにのみコールしてください。

• アウトバウンド伝播の場合、ローカル・サブスクライバがOracle Streams AQキューから削除されます。

---

RESET_JOBプロシージャ

このプロシージャは、伝播ジョブの伝播エラー状態をリセットします。

構文

DBMS_MGWADM.RESET_JOB (
   job_name   IN   VARCHAR2);

パラメータ

表76-43 RESET_JOBプロシージャのパラメータ

パラメータ	説明
job_name	伝播ジョブを識別します。

使用上の注意

このプロシージャを使用すると、障害状態に設定され、伝播アクティビティが停止された伝播ジョブをリセットすることができます。管理者は問題を解決してから、このプロシージャをコールして、エージェントが伝播ジョブを再試行できるようにする必要があります。 MGW_JOBSビューのSTATUSフィールドは、ジョブ・ステータスを示します。

---

RESET_SUBSCRIBERプロシージャ

このプロシージャは、サブスクライバの伝播エラー状態をリセットします。

注意: テクノロジが改良されたため（「RESET_JOBプロシージャ」を参照）、このサブプログラムは使用されなくなりました（このサブプログラムは、下位互換性を維持する目的でのみ保持されています）。

構文

DBMS_MGWADM.RESET_SUBSCRIBER (
   subscriber_id  IN VARCHAR2 );

パラメータ

表76-44 RESET_SUBSCRIBERプロシージャのパラメータ

パラメータ	説明
subscriber_id	サブスクライバを識別します。

---

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);

パラメータ

表76-45 SCHEDULE_PROPAGATIONプロシージャのパラメータ

パラメータ	説明
schedule_id	スケジュールを識別するユーザー定義名を指定します。
propagation_type	メッセージ伝播のタイプを指定します。Oracle Streams AQからOracle以外への伝播の場合は、DBMS_MGWADM.OUTBOUND_PROPAGATIONです。 Oracle以外からOracle Streams AQへの伝播の場合は、DBMS_MGWADM.INBOUND_PROPAGATIONです。
source	メッセージの伝播元であるソース・キューを指定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
destination	メッセージの伝播先である宛先キューを指定します。このパラメータの構文および解釈は、propagation_typeに指定された値によって決まります。
start_time	将来使用するために予約されています。
duration	将来使用するために予約されています。
next_time	将来使用するために予約されています。
latency	ソース・キュー内のメッセージをチェックするときに、メッセージ・ゲートウェイ・エージェントが使用するポーリング間隔を秒単位で指定します。ソース・キュー内に利用可能なメッセージが存在しない場合、このポーリング間隔が経過するまで、エージェントはポーリングを再実行しません。エージェントによってメッセージが検出されると、利用可能なメッセージが存在するかぎり、メッセージの伝播が継続されます。 指定できる値はNULL、または0より大きい値です。latencyがNULLの場合、メッセージ・ゲートウェイ・エージェントのデフォルトのポーリング間隔が使用されます。デフォルトのポーリング間隔は5秒間ですが、このデフォルト値はメッセージ・ゲートウェイの初期化ファイルによって上書きできます。

使用上の注意

アウトバウンド伝播の場合、パラメータは次のように解釈されます。

• source - メッセージの伝播元であるOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

• destination - メッセージの伝播先の外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

インバウンド伝播の場合、パラメータは次のように解釈されます。

• source - メッセージの伝播元である外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

• destination - メッセージの伝播先のOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

スケジュールは、作成時に使用可能な状態に設定されます。

---

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);

パラメータ

表76-46 SET_LOG_LEVELプロシージャのパラメータ

パラメータ	説明
log_level	メッセージ・ゲートウェイ・エージェントが情報をログに記録するときのレベル。 DBMS_MGWADM.BASIC_LOGGINGの場合は最小限の情報が生成され、DBMS_MGWADM.TRACE_DEBUG_LOGGINGの場合は最大限の情報が生成されます。
agent_name	メッセージ・ゲートウェイ・エージェントを識別します。DBMS_MGWADM.DEFAULT_AGENTはデフォルトのエージェントを指定します。

関連項目: log_levelパラメータの詳細は、表76-3「DBMS_MGWADM定数: ロギング・レベル」を参照してください。

---

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 );

パラメータ

表76-47 SET_OPTIONプロシージャのパラメータ

パラメータ	説明
target_type	メッセージ・ゲートウェイ・エンティティのターゲット・タイプを指定します。 DBMS_MGWADM.AGENT_JAVA_PROP（メッセージ・ゲートウェイ・エージェントのJava Systemプロパティを設定する場合） DBMS_MGWADM.MSGLINK_OPTION（メッセージ・リンク・オプションを設定する場合） DBMS_MGWADM.JOB_OPTION（伝播ジョブ・オプションを設定する場合）
target_name	ターゲットの名前または識別子。このパラメータの値は、target_typeパラメータに指定された値によって決まります。NULL以外の値を指定してください。
option_name	オプション名。NULL以外の値を指定してください。
option_value	オプション値。
encrypted	値を暗号化して保存するかどうかを指定します。 値を暗号化形式で保存する場合は、TRUE 値をクリアテキスト形式で保存する場合は、FALSE

関連項目: option_typeパラメータのオプションについては、表76-10「DBMS_MGWADM定数: SET_OPTIONおよびREMOVE_OPTIONプロシージャのtarget_type引数」を参照してください。

使用上の注意

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に設定する必要があります。

---

SHUTDOWNプロシージャ

このプロシージャは、メッセージ・ゲートウェイ・エージェントを停止します。メッセージ・ゲートウェイが再起動されるまで、伝播アクティビティは実行されません。

構文

DBMS_MGWADM.SHUTDOWN (
   sdmode      IN BINARY_INTEGER DEFAULT DBMS_MGWADM.SHUTDOWN_NORMAL);

DBMS_MGWADM.SHUTDOWN (
   agent_name  IN VARCHAR2);

パラメータ

表76-48 SHUTDOWNプロシージャのパラメータ

パラメータ	説明
sdmode	停止モード。 現在指定できる値は、通常の停止を意味するDBMS_MGWADM.SHUTDOWN_NORMALのみです。メッセージ・ゲートウェイ・エージェントは、現在進行中の伝播作業を完了しようとします。
agent_name	メッセージ・ゲートウェイ・エージェントを識別します。DBMS_MGWADM.DEFAULT_AGENTはデフォルトのエージェントを指定します。

使用上の注意

エージェント名を指定しない場合、メッセージ・ゲートウェイのデフォルト・エージェントは停止します。

---

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);

パラメータ

表76-49 STARTUPプロシージャのパラメータ

パラメータ	説明
instance	メッセージ・ゲートウェイ・エージェントの起動に使用されるジョブ・キューのジョブを実行できるインスタンスを指定します。0（ゼロ）の場合は、どのインスタンスでもジョブを実行できます。 注意: このパラメータは使用しないことをお薦めします。
force	DBMS_MGWADM.FORCEの場合は、ジョブ・インスタンスとして正の整数がすべて受け入れられます。 DBMS_MGWADM.NO_FORCE（デフォルト）の場合は、指定したインスタンスが実行している必要があり、そうでない場合は、ルーチンに例外が発生します。 注意: このパラメータは使用しないことをお薦めします。
agent_name	メッセージ・ゲートウェイ・エージェントを識別します。DBMS_MGWADM.DEFAULT_AGENTはデフォルトのエージェントを指定します。

使用上の注意

• エージェント名を指定しない場合は、デフォルトのメッセージ・ゲートウェイ・エージェントが起動します。

• forceおよびinstanceパラメータは使用されないため、無視されます。 instanceアフィニティ・パラメータを使用して、特定のインスタンス上でデフォルト・エージェントを起動した場合、管理者はデータベース・サービスを作成し、DBMS_MGWADM.ALTER_AGENTプロシージャを使用して、このサービスをデフォルト・エージェントに割り当てる必要があります。

• DBMS_MGWADM.CREATE_AGENTまたはDBMS_MGWADM.ALTER_AGENTサブプログラムによってエージェント・ユーザーが構成されるまで、メッセージ・ゲートウェイ・エージェントは起動できません。

---

UNREGISTER_FOREIGN_QUEUEプロシージャ

このプロシージャは、Oracle以外のキュー・エンティティをメッセージ・ゲートウェイから削除します。

構文

DBMS_MGWADM.UNREGISTER_FOREIGN_QUEUE(
   name         IN VARCHAR2,
   linkname     IN VARCHAR2);

パラメータ

表76-50 UNREGISTER_FOREIGN_QUEUEプロシージャのパラメータ

パラメータ	説明
name	キュー名
linkname	キューが存在するメッセージ・システムに対するリンク名

使用上の注意

• このプロシージャは、Oracle以外のメッセージ・システムの物理的なキューを削除しません。

• キューの登録を解除するには、このキューを参照しているすべての伝播ジョブ、サブスクライバおよびスケジュールの登録を解除する必要があります。伝播ジョブ、サブスクライバまたは伝播スケジュールがOracle以外のキューを参照している場合、このプロシージャは失敗します。

---

UNSCHEDULE_PROPAGATIONプロシージャ

このプロシージャは、伝播スケジュールを削除します。

注意: テクノロジが改良されたため（「REMOVE_JOBプロシージャ」を参照）、このサブプログラムは使用されなくなりました（このサブプログラムは、下位互換性を維持する目的でのみ保持されています）。

構文

DBMS_MGWADM.UNSCHEDULE_PROPAGATION (
   schedule_id   IN VARCHAR2 );

パラメータ

表76-51 UNSCHEDULE_PROPAGATIONプロシージャのパラメータ

パラメータ	説明
schedule_id	削除する伝播スケジュールを識別します。