ルート・スキーマ: メッセージング・ブリッジ
型: object
ソースの表示
- asyncEnabled(optional): boolean
デフォルト値: true
メッセージング・ブリッジ・インスタンスが非同期メッセージング・モードで転送を行うかどうかを指定します。
AsyncEnabledは、ソース宛先で非同期受信がサポートされているメッセージング・ブリッジ・インスタンスに対してのみ適用されます。非同期モードで転送するメッセージング・ブリッジ・インスタンスは、ソース宛先によって駆動されます。メッセージング・ブリッジ・インスタンスはメッセージをリスニングし、到着したものを転送します。AsyncEnabledが選択されていない場合、ソースで非同期受信がサポートされていても、ブリッジ・インスタンスは強制的に同期モードで動作します。
ノート:「サービス品質」が「必ず1回」に設定されているメッセージング・ブリッジ・インスタンスが非同期モードで動作するには、ソース宛先でMDBTransactionインタフェースがサポートされている必要があります。ソース宛先でMDBTransactionがサポートされていないことが検出されると、ブリッジは自動的に同期モードに切り替わります。
- batchInterval(optional): integer(int64)
デフォルト値: -1
1回のトランザクションで、「バッチ・サイズ」に到達したかどうかに関係なく、メッセージのバッチを送信するまでにメッセージング・ブリッジ・インスタンスが待機する最長時間(ミリ秒単位)。
- batchSize(optional): integer(int32)
最小値: 0
デフォルト値: 10
1回のトランザクションで処理されるメッセージ数。
「バッチ・サイズ」は、同期モードでメッセージを転送しているメッセージング・ブリッジ・インスタンスに対してのみ適用され、2フェーズのトランザクションを必要とするQOS (サービスの品質)が保持されます。
- deploymentOrder(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 1000
デプロイの優先度。サーバーはこの値を使用して項目のデプロイ順を決定します。優先度は、同じタイプでデプロイ可能なアイテム間で決められます。
たとえば、サーバーではすべてのEJBを優先度に従ってデプロイしてから、起動クラスを優先度に従ってデプロイします。
「デプロイ順序」の値が小さい項目から順にデプロイされます。「デプロイ順序」の値が等しいデプロイメントの順序付けは保証されていません。クラスタ間の順序付けは保証されていません。
- distributionPolicy(optional): string
デフォルト値: Distributed
使用可能な値: [ "Distributed", "Singleton" ]
構成済JMSアーティファクトのインスタンスをクラスタにターゲット指定する際の名前と配布方法を指定します。JMSアーティファクトは、そのターゲットがクラスタに直接設定されている場合、またはリソース・グループにスコープ指定され、そのリソース・グループがクラスタにターゲット指定されている場合にクラスタをターゲットとします。この設定がストアで構成されると、そのストアを参照するすべてのJMSアーティファクトに適用されます。有効なオプション:
Distributedは、クラスタ内の各サーバーJVMにインスタンスを作成します。すべてのSAFエージェント、およびクラスタのターゲットとして指定されたか、リソース・グループにスコープ指定された、分散宛先をホストするJMSサーバーに必要です。
Singletonは、クラスタ内の単一サーバーJVMに単一インスタンスを作成します。クラスタのターゲットとして指定されたか、リソース・グループにスコープ指定されたスタンドアロン(分散されていない)宛先をホストするJMSサーバー、およびクラスタのターゲットとして指定されたか、リソース・グループにスコープ指定されたパス・サービスに必要です。「移行ポリシー」は、このオプションをJMSサーバーと使用する場合は「失敗時」または「常時」、メッセージング・ブリッジと使用する場合には「失敗時」、パス・サービスと使用する場合には「常時」である必要があります。
インスタンスの名前付けに関するノート:
メッセージング・ブリッジに関するノート:
クラスタのターゲットとして指定されたメッセージ・ブリッジに対して、サーバーごとにインスタンスが必要な場合は、ブリッジ「」分散ポリシーおよび「移行ポリシー」をそれぞれ「分散完了」/「オフ」(デフォルト)に設定することをお勧めします。
クラスタのターゲットとして指定されたブリッジに対して、クラスタごとに単一インスタンスが必要な場合は、ブリッジ分散ポリシーおよび「移行ポリシー」をそれぞれ「シングルトン」/「失敗時」に設定することをお勧めします。
ブリッジをクラスタのターゲットとして指定できないが、構成済のクラスタでシングルトン動作がまだ必要な場合は、移行可能なターゲットにブリッジをターゲット指定し、移行可能なターゲットの「移行ポリシー」を「必ず1回」に構成できます。
- durabilityEnabled(optional): boolean
デフォルト値: true
メッセージング・ブリッジで恒久メッセージが許可されるかどうかを指定します。
ソース宛先がJMSトピックの場合にこれが有効化されていると、失敗のイベント時にメッセージが失われないように、メッセージング・ブリッジ・インスタンスで恒久サブスクリプションが使用されます。ソース宛先がJMSキューの場合、DurabilityEnabledは無視されます。
ソース宛先で恒久サブスクリプションが使用されている場合にこれが有効化されていると、ソースJMS実装では、メッセージング・ブリッジ・インスタンスが実行されていないときでも、送られてきたメッセージを保存します。これらのメッセージは、ブリッジ・インスタンスが再起動されたときにターゲット宛先に転送されます。管理者側で、恒久性を無効にすることができます。
この属性が有効化されていない場合は、ブリッジ・インスタンスの停止中にソースJMS実装に送信されたメッセージは、ターゲット宛先に転送されません。
- dynamicallyCreated(optional): boolean
読取り専用: true
デフォルト値: false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
- failbackDelaySeconds(optional): integer(int64)
デフォルト値: -1
優先サーバーに障害が発生して再起動した後で、クラスタのターゲットとして指定されたJMSアーティファクト・インスタンスを優先サーバーにフェイルバックする前に、遅延させる時間を秒数で指定します。
この遅延により、システムが安定し、依存サービスが再起動されるまでの時間が確保され、再起動時のシステム障害を予防します。
>
値に
値に-1を指定した場合、遅延は発生せず、インスタンスはただちにフェイルバックします。
ノート: この設定は、JMSアーティファクトがクラスタのターゲットとして指定され、移行ポリシーがOn-FailureまたはAlwaysに設定されている場合にのみ適用されます。
- failOverLimit(optional): integer(int32)
最小値: -1
デフォルト値: -1
特定のJVMにフェイルオーバーできる、クラスタのターゲットとして指定されたJMSアーティファクト・インスタンス数の制限を指定します。
これを使用して非常に多くのインスタンスがサーバー上で開始することを防ぎ、以前は大きかったクラスタの非常に少数のサーバーを開始するときのシステム障害を回避できます。
通常の制限値では、希望する最小のクラスタ・サイズですべてのインスタンスを実行できるようにする必要があります。これは、(smallest-cluster-size * (limit + 1))がインスタンスの総数以上である必要があることを意味します。
-1の値は、フェイルオーバー制限がないこと(無制限)を意味します。
ノート: この設定は、JMSアーティファクトがクラスタのターゲットとして指定され、移行ポリシーがOn-FailureまたはAlwaysに設定されている場合にのみ適用されます。
- id(optional): integer(int64)
- idleTimeMaximum(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 60
メッセージング・ブリッジ・インスタンスがアイドル状態にある最大秒数。
- initialBootDelaySeconds(optional): integer(int64)
デフォルト値: 60
クラスタのターゲットとして指定されたJMSインスタンスを新しく起動されたWebLogic Serverで開始する前に、遅延させる時間を秒数で指定します。この設定がストアで構成されると、そのストアを参照するすべてのJMSアーティファクトに適用されます。
これにより、システムが安定し、依存サービスが再起動されるまでの時間が確保され、再起動時のシステム障害を予防します。
ノート: この設定は、JMSアーティファクトがクラスタのターゲットとして指定され、移行ポリシーがOn-FailureまたはAlwaysに設定されている場合にのみ適用されます。
- migrationPolicy(optional): string
デフォルト値: Off
使用可能な値: [ "Off", "On-Failure", "Always" ]
クラスタのターゲットとして指定されたJMSサービス・アーティファクト・インスタンスの移行および再起動の動作を制御します。この設定がクラスタのターゲットとして指定されたストアで構成されると、そのストアを参照するすべてのJMSアーティファクトに適用されます。移行可能ターゲットとして指定されたJMSアーティファクトでの移行と再起動の有効化については、移行可能ターゲット設定を参照してください。
Offはクラスタのターゲットとして指定されたJMSサービス・オブジェクトの移行サポートを無効にし、「再起動準備完了」のデフォルトをfalseに変更します。「移行ポリシー」が「オフ」の場合に再起動を有効にするには、「再起動準備完了」を明示的にtrueに構成する必要があります。このポリシーは「シングルトン」移行ポリシーと組み合わせることはできません。
On-Failureは、サブシステム・サービスまたはWebLogic Serverインスタンスの失敗時に、インスタンスの自動フェイルバックおよびロード・バランシングを含む、インスタンスの自動移行および再起動を有効にします。
Alwaysは、On-Failureと同じ動作を提供し、正常な停止または部分クラスタの開始の場合でも、自動的にインスタンスを移行します。
ノート: On-FailureおよびAlwaysでは、クラスタのリースを構成しておく必要があります
メッセージング・ブリッジに関するノート:
クラスタのターゲットとして指定されたメッセージ・ブリッジに対して、サーバーごとにインスタンスが必要な場合は、ブリッジ「」分散ポリシーおよび「移行ポリシー」をそれぞれ「分散完了」/「オフ」(デフォルト)に設定することをお勧めします。
クラスタのターゲットとして指定されたブリッジに対して、クラスタごとに単一インスタンスが必要な場合は、ブリッジ分散ポリシーおよび「移行ポリシー」をそれぞれ「シングルトン」/「失敗時」に設定することをお勧めします。
「常時」の「移行ポリシー」はブリッジには推奨されません。
ブリッジをクラスタのターゲットとして指定できないが、構成済のクラスタでシングルトン動作がまだ必要な場合は、移行可能なターゲットにブリッジをターゲット指定し、移行可能なターゲットの「移行ポリシー」を「必ず1回」に構成できます。
- name(optional): string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています
Name=user-specified-name
制約
- notes(optional): string
この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。
ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。
- numberOfRestartAttempts(optional): integer(int32)
最小値: -1
デフォルト値: 6
再起動の最大試行回数を指定します。
値falseに設定するのと同じ動作を指定することになります
-1の値を指定すると、起動するか、またはサーバー・インスタンスが停止するまで、再起動の試行を続けます。
- partialClusterStabilityDelaySeconds(optional): integer(int64)
デフォルト値: 240
部分的に起動されたクラスタが、「常時」または「失敗時」の移行ポリシーで構成された、クラスタのターゲットとして指定されたすべてのJMSアーティファクト・インスタンスを開始する前に、遅延させる時間を秒数で指定します。
このタイムアウトが期限切れになるか、すべてのサーバーが稼働中になるまで、クラスタは稼働しているサーバーの合計数と構成済のクラスタ・サイズに基づいて、このようなインスタンスのサブセットを開始します。タイムアウト期限に達するか、すべてのサーバーが起動すると、システムはクラスタが安定しているとみなし、残りのサービスをすべて起動します。
この遅延により、サーバーが順次起動される場合も、クラスタ全体でサービスのバランスが確実に維持されます。クラスタが完全に開始される(安定化)か、個別のサーバーが開始されると、これは無視されます。
- preserveMsgProperty(optional): boolean
デフォルト値: false
ブリッジ・インスタンスがメッセージを転送する際に、メッセージ・プロパティを保持するかどうかを指定します。
次のメッセージ・プロパティは保持されます。
message ID
message timestamp
user ID
delivery mode
priority
expiration time
redelivery limit
順序単位の名前
ターゲット・ブリッジ宛先が外部JMSサーバー上にある場合、次のメッセージ・プロパティが保持されます。
delivery mode
priority
expiration time
- QOSDegradationAllowed(optional): boolean
デフォルト値: false
構成されたQOS (サービスの品質)が使用できないときに、このメッセージング・ブリッジ・インスタンスでQOSの低下を許可するかどうかを指定します。
これを有効化すると、構成されたQOSが使用できないときは、メッセージング・ブリッジ・インスタンスによってQOSが低下します。QOSが低下した場合、ログ・メッセージがWebLogicの起動ウィンドウまたはログ・ファイルに配信されます。
これが有効化されておらず、リクエストされたサービス品質をメッセージング・ブリッジ・インスタンスが満たせない場合は、エラーが発生し、メッセージング・ブリッジ・インスタンスは起動しません。
- qualityOfService(optional): string
デフォルト値: Exactly-once
使用可能な値: [ "Exactly-once", "Atmost-once", "Duplicate-okay" ]
このメッセージング・ブリッジ・インスタンスのQOS (サービスの品質)。
「必ず1回」: ソース宛先の各メッセージが正確に1回のみターゲットに転送されます。これはメッセージング・ブリッジ・インスタンスで提供できるもっとも高いQOSです。
「最大1回」: ソースの各メッセージが1回のみターゲットに転送されますが、転送中にメッセージが失われる可能性があります。
「重複可」: ソース宛先のメッセージはターゲットに転送されます(失われることはありません)が、重複して転送されることがあります。
制約
- セキュア・デフォルト: "Exactly-once"
- reconnectDelayIncrease(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 5
メッセージング・ブリッジ・インスタンスが、再接続に失敗してから、次の試行を行うまでの待機時間の延長分(秒単位)。
ReconnectDelayMinimumおよびReconnectDelayMaximumとともに使用します。宛先への接続が失敗すると、ブリッジ・インスタンスはまずReconnectDelayMinimumによって定義された秒数のみ待機します。再接続の試行が失敗するたびに、ブリッジ・インスタンスはReconnectDelayIncreaseで定義された秒数のみ、待機時間を延長します。最大遅延時間は、ReconnectDelayMaximumで定義されます。待機時間が最大値に到達すると、ブリッジ・インスタンスはそれ以上待機時間を延長しません。ブリッジ・インスタンスから宛先への接続が成功すると、ブリッジ・インスタンスは、待機時間をReconnectDelayMinimumで定義された初期値にリセットします。
- reconnectDelayMaximum(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 60
メッセージング・ブリッジ・インスタンスが、ソースまたはターゲットへの再接続に失敗してから、次の試行を行うまでの最長待機時間(秒単位)。
ReconnectDelayMinimumおよびReconnectDelayIncreaseとともに使用します。宛先への接続が失敗すると、ブリッジ・インスタンスはまずReconnectDelayMinimumによって定義された秒数のみ待機します。再接続の試行が失敗するたびに、ブリッジ・インスタンスはReconnectDelayIncreaseで定義された秒数のみ、待機時間を延長します。最大遅延時間は、ReconnectDelayMaximumで定義されます。待機時間が最大値に到達すると、ブリッジ・インスタンスはそれ以上待機時間を延長しません。ブリッジ・インスタンスから宛先への接続が成功すると、ブリッジ・インスタンスは、待機時間をReconnectDelayMinimumで定義された初期値にリセットします。
- reconnectDelayMinimum(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 15
メッセージング・ブリッジ・インスタンスが、エラーの後でソース宛先またはターゲット宛先に再接続しようとするまでの最小待機時間(秒単位)。
ReconnectDelayMaximumおよびReconnectDelayIncreaseとともに使用します。宛先への接続が失敗すると、ブリッジ・インスタンスはまずReconnectDelayMinimumによって定義された秒数のみ待機します。再接続の試行が失敗するたびに、ブリッジ・インスタンスはReconnectDelayIncreaseで定義された秒数のみ、待機時間を延長します。最大遅延時間は、ReconnectDelayMaximumで定義されます。待機時間が最大値に到達すると、ブリッジ・インスタンスはそれ以上待機時間を延長しません。ブリッジ・インスタンスから宛先への接続が成功すると、ブリッジ・インスタンスは、待機時間をReconnectDelayMinimumで定義された初期値にリセットします。
- restartInPlace(optional): boolean
正常なWebLogic Serverインスタンスで実行されている、クラスタまたはスタンドアロン・サーバーのターゲットとして指定されたJMSアーティファクト・インスタンスが失敗した場合に定期的な自動インプレース再起動を有効にします。移行可能なターゲットとして指定されたJMSアーティファクトのインプレース再起動については、移行可能なターゲットの設定を参照してください。「再起動準備完了」設定がストアで構成されると、そのストアを参照するすべてのJMSアーティファクトに適用されます。
JMSアーティファクトの「移行ポリシー」が「オフ」に設定されている場合、「再起動準備完了」はデフォルトで無効になります。
JMSアーティファクトの「移行ポリシー」が「失敗時」または「常時」に設定されている場合、「再起動準備完了」はデフォルトで有効になります。
この属性は必要に応じて内部接続を自動的に再起動するWebLogic Messaging Bridgesでは使用されません。
クラスタのターゲットとして指定されたJMSアーティファクトで、「移行ポリシー」が「失敗時」または「常時」に設定されている場合、構成された最大再試行回数を超えて再起動が失敗すると、クラスタ内の別のサーバーに移行します。
- secondsBetweenRestarts(optional): integer(int32)
最小値: 1
デフォルト値: 30
障害が発生したサービス・インスタンスの再起動を試行する間隔を秒数で指定します。
- selector(optional): string
メッセージング・ブリッジ・インスタンス経由で送信されるメッセージのフィルタ。
選択条件に一致するメッセージのみが、メッセージング・ブリッジを経由して送信されます。
- sourceDestination(optional): array ブリッジ宛先の共通参照
タイトル: Bridge Destination Common Reference
ブリッジ宛先の共通参照が含まれます。
メッセージング・ブリッジ・インスタンスがメッセージを読み取るソース宛先。
制約
- started(optional): boolean
デフォルト値: true
ターゲットとするメッセージング・ブリッジ・インスタンスの初期動作状態を指定します。
メッセージング・ブリッジがメッセージの転送を開始した後(実行中)には、「起動済み」を使用してアクティブなメッセージング・ブリッジ・インスタンスを一時的にサスペンドするか、停止しているメッセージング・ブリッジ・インスタンスを再起動します。
一時的に停止中のメッセージング・ブリッジ・インスタンスを起動するには、「起動済み」チェック・ボックスを選択します。
実行中のメッセージング・ブリッジ・インスタンスを一時的に停止するには、「起動済み」チェック・ボックスをクリアします。
この値は、メッセージング・ブリッジ・インスタンスの実行時の状態を示すものではありません。
- tags(optional): array 項目
- targetDestination(optional): array ブリッジ宛先の共通参照
タイトル: Bridge Destination Common Reference
ブリッジ宛先の共通参照が含まれます。
メッセージング・ブリッジ・インスタンスが、ソース宛先から受け取るメッセージを転送するターゲット宛先。
制約
- targets(optional): array ターゲット参照
タイトル: Target References
ターゲット参照の配列が含まれます。
現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。
- transactionTimeout(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 30
各トランザクションがタイムアウトするまでに、トランザクション・マネージャが待機する時間(秒単位)。
- type(optional): string
{
"type":"object",
"properties":{
"QOSDegradationAllowed":{
"default":false,
"type":"boolean",
"description":"<p>Specifies if this messaging bridge instance allows the degradation of its QOS (quality of service) when the configured QOS is not available.</p><ul><li><p>When enabled, the messaging bridge instance degrades the QOS when the configured QOS is not available. If the QOS is degraded, a log message is delivered to the WebLogic startup window or log file.</p></li><li><p>When not enabled, if messaging bridge instance cannot satisfy the quality of service requested, an error results and the messaging bridge instance does not start.</p></li></ul>"
},
"asyncEnabled":{
"default":true,
"type":"boolean",
"description":"<p>Specifies if a messaging bridge instance forwards in asynchronous messaging mode.</p><p>AsyncEnabled only applies to messaging bridge instances whose source destination supports asynchronous receiving. Messaging bridges instances that forward in asynchronous mode are driven by the source destination. A messaging bridge instance listens for messages and forwards them as they arrive. When <code>AsyncEnabled</code> is not selected, a bridge instance is forced to work in synchronous mode, even if the source supports asynchronous receiving.</p><p><b>Note:</b> For a messaging bridge instance with a QOS of <i>Exactly-once</i> to work in asynchronous mode, the source destination has to support the <code>MDBTransaction</code> interface. Otherwise, the bridge automatically switches to synchronous mode if it detects that <code>MDBTransaction</code> is not supported by the source destination.</p>"
},
"batchInterval":{
"default":-1,
"type":"integer",
"format":"int64",
"description":"<p>The maximum amount of time, in milliseconds, that a messaging bridge instance waits before sending a batch of messages in one transaction, regardless of whether the <code>Batch Size</code> has been reached or not.</p><ul><li><p>Only applies to a messaging bridge instance forwarding messages in synchronous mode and has a QOS (quality of service) that requires two-phase transactions.</p></li><li><p>The default value of <code>-1</code> indicates that the bridge instance waits until the number of messages reaches the <code>Batch Size</code> before it completes a transaction.</p></li></ul>"
},
"batchSize":{
"default":10,
"minimum":0,
"type":"integer",
"format":"int32",
"description":"<p>The number of messages that are processed within one transaction.</p><p><code>Batch Size</code> only applies to a messaging bridge instance forwarding messages in synchronous mode and has a QOS (quality of service) that requires two-phase transactions.</p>"
},
"deploymentOrder":{
"default":1000,
"minimum":0,
"maximum":2147483647,
"type":"integer",
"format":"int32",
"description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p>"
},
"distributionPolicy":{
"default":"Distributed",
"enum":[
"Distributed",
"Singleton"
],
"type":"string",
"description":"<p>Specifies how the instances of a configured JMS artifact are named and distributed when cluster-targeted. A JMS artifact is cluster-targeted when its target is directly set to a cluster, or when it is scoped to a resource group and the resource group is in turn targeted to a cluster. When this setting is configured on a store, it applies to all JMS artifacts that reference the store. Valid options:</p><ul><li><p><code>Distributed</code> Creates an instance on each server JVM in a cluster. Required for all SAF agents and for cluster-targeted or resource-group-scoped JMS servers that host distributed destinations. </p></li><li><p><code>Singleton</code> Creates a single instance on a single server JVM within a cluster. Required for cluster-targeted or resource-group-scoped JMS servers that host standalone (non-distributed) destinations and for cluster-targeted or resource-group-scoped path services. The <code>Migration Policy</code> must be <code>On-Failure</code> or <code>Always</code> when using this option with a JMS server, <code>On-Failure</code> when using this option with a messaging bridge, and <code>Always</code> when using this option with a path service. </p></li></ul><p><b>Instance Naming Note:</b></p><ul><li><p> The <code>DistributionPolicy</code> determines the instance name suffix for cluster-targeted JMS artifacts. The suffix for a cluster-targeted <code>Singleton</code> is <code>-01</code> and for a cluster-targeted <code>Distributed</code> is <code>@ClusterMemberName</code>. </p></li></ul><p><b>Messaging Bridge Notes:</b></p><ul><li><p> When an instance per server is desired for a cluster-targeted messaging bridge, Oracle recommends setting the bridge <code>Distributed Policy</code> and <code>Migration Policy</code> to <code>Distributed/Off</code>, respectively; these are the defaults. </p></li><li><p> When a single instance per cluster is desired for a cluster-targeted bridge, Oracle recommends setting the bridge <code>Distributed Policy</code> and <code>Migration Policy</code> to <code>Singleton/On-Failure</code>, respectively. </p></li><li><p> If you cannot cluster-target a bridge and still need singleton behavior in a configured cluster, you can target the bridge to a migratable target and configure the <code>Migration Policy</code> on the migratable target to <code>Exactly-Once</code>. </p></li></ul>"
},
"durabilityEnabled":{
"default":true,
"type":"boolean",
"description":"<p>Specifies whether or not the messaging bridge allows durable messages.</p><p>When enabled and the source destination is a JMS topic, a messaging bridge instance uses a durable subscription to ensure that no messages are lost in the event of a failure. <code>DurabilityEnabled</code> ignored if the source destination is a JMS queue.</p><ul><li><p>When enabled and the source destination uses durable subscriptions, the source JMS implementation saves messages that are sent when a messaging bridge instance is not running. When the bridge instance is restarted, these messages are forwarded to the target destination. The administrator can choose not to be durable.</p></li><li><p>When not enabled, messages that are sent to the source JMS implementation while the bridge instance is down cannot be forwarded to the target destination.</p></li></ul>"
},
"dynamicallyCreated":{
"readOnly":true,
"default":false,
"type":"boolean",
"description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
},
"failOverLimit":{
"default":-1,
"minimum":-1,
"type":"integer",
"format":"int32",
"description":"<p>Specify a limit for the number of cluster-targeted JMS artifact instances that can fail over to a particular JVM.</p><p>This can be used to prevent too many instances from starting on a server, avoiding a system failure when starting too few servers of a formerly large cluster.</p><p>A typical limit value should allow all instances to run in the smallest desired cluster size, which means (smallest-cluster-size * (limit + 1)) should equal or exceed the total number of instances. </p><ul><li><p>A value of <code>-1</code> means there is no fail over limit (unlimited).</p></li><li><p>A value of <code></code> prevents any fail overs of cluster-targeted JMS artifact instances, so no more than 1 instance will run per server (this is an instance that has not failed over).</p></li><li><p>A value of <code></code> allows one fail-over instance on each server, so no more than two instances will run per server (one failed over instance plus an instance that has not failed over).</p></li></ul><p><b>Note:</b> This setting only applies when the JMS artifact is cluster-targeted and the Migration Policy is set to <code>On-Failure</code> or <code>Always</code></p>"
},
"failbackDelaySeconds":{
"default":-1,
"type":"integer",
"format":"int64",
"description":"<p>Specifies the amount of time, in seconds, to delay before failing a cluster-targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.</p><p>This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.</p><ul><li><p>A value > <code></code> specifies the time, in seconds, to delay before failing a JMS artifact back to its user preferred server.</p></li><li><p>A value of <code></code> indicates that the instance would never failback.</p></li><li><p>A value of <code>-1</code> indicates that there is no delay and the instance would failback immediately.</p></li></ul><p><b>Note:</b> This setting only applies when the JMS artifact is cluster-targeted and the Migration Policy is set to <code>On-Failure</code> or <code>Always</code></p>"
},
"id":{
"readOnly":true,
"type":"integer",
"format":"int64",
"description":"<p>Return the unique id of this MBean instance</p>"
},
"idleTimeMaximum":{
"default":60,
"minimum":0,
"maximum":2147483647,
"type":"integer",
"format":"int32",
"description":"<p>The maximum amount of time, in seconds, that a messaging bridge instance remains idle.</p><ul><li><p>In <i>asynchronous</i> mode, this is the longest amount of time a messaging bridge instance stays idle before it checks the sanity of its connection to the source.</p></li><li><p>In <i>synchronous</i> mode, this is the amount of time the messaging bridge can block on a receive call if no transaction is involved.</p></li></ul>"
},
"initialBootDelaySeconds":{
"default":60,
"type":"integer",
"format":"int64",
"description":"<p>Specifies the amount of time, in seconds, to delay before starting a cluster-targeted JMS instance on a newly booted WebLogic Server instance. When this setting is configured on a store, it applies to all JMS artifacts that reference the store. </p><p>This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.</p><ul><li><p>A value > <code></code> is the time, in seconds, to delay before before loading resources after a failure and restart.</p></li><li><p>A value of <code></code> specifies no delay.</p></li></ul><p><b>Note:</b> This setting only applies when the JMS artifact is cluster-targeted and the Migration Policy is set to <code>On-Failure</code> or <code>Always</code></p>"
},
"migrationPolicy":{
"default":"Off",
"enum":[
"Off",
"On-Failure",
"Always"
],
"type":"string",
"description":"<p>Controls migration and restart behavior of cluster-targeted JMS service artifact instances. When this setting is configured on a cluster-targeted store, it applies to all JMS artifacts that reference the store. See the migratable target settings for enabling migration and restart on migratable-targeted JMS artifacts.</p><ul><li><p><code>Off</code> Disables migration support for cluster-targeted JMS service objects, and changes the default for Restart In Place to false. If you want a restart to be enabled when the Migration Policy is Off, then Restart In Place must be explicitly configured to true. This policy cannot be combined with the <code>Singleton</code> Migration Policy. </p></li><li><p><code>On-Failure</code> Enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances. </p></li><li><p><code>Always</code> Provides the same behavior as <code>On-Failure</code> and automatically migrates instances even in the event of a graceful shutdown or a partial cluster start. </p></li></ul><p><b>Note:</b> Cluster leasing must be configured for <code>On-Failure</code> and <code>Always</code>. </p><p><b>Messaging Bridge Notes:</b></p><ul><li><p> When an instance per server is desired for a cluster-targeted messaging bridge, Oracle recommends setting the bridge <code>Distributed Policy</code> and <code>Migration Policy</code> to <code>Distributed/Off</code>, respectively; these are the defaults. </p></li><li><p> When a single instance per cluster is desired for a cluster-targeted bridge, Oracle recommends setting the bridge <code>Distributed Policy</code> and <code>Migration Policy</code> to <code>Singleton/On-Failure</code>, respectively. </p></li><li><p> A <code>Migration Policy</code> of <code>Always</code> is not recommended for bridges. </p></li><li><p> If you cannot cluster-target a bridge and still need singleton behavior in a configured cluster, you can target the bridge to a migratable target and configure the <code>Migration Policy</code> on the migratable target to <code>Exactly-Once</code>. </p></li></ul>"
},
"name":{
"readOnly":true,
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"notes":{
"type":"string",
"description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code><</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
},
"numberOfRestartAttempts":{
"default":6,
"minimum":-1,
"type":"integer",
"format":"int32",
"description":"<p>Specifies the maximum number of restart attempts.</p><ul><li><p>A value > <code></code> specifies the maximum number of restart attempts.</p></li><li><p>A value of <code></code> specifies the same behavior as setting getRestartInPlace to <code>false</code></p></li><li><p>A value of <code>-1</code> means infinite retry restart until it either starts or the server instance shuts down.</p></li></ul>"
},
"partialClusterStabilityDelaySeconds":{
"default":240,
"type":"integer",
"format":"int64",
"description":"<p>Specifies the amount of time, in seconds, to delay before a partially started cluster starts all cluster-targeted JMS artifact instances that are configured with a Migration Policy of <code>Always</code> or <code>On-Failure</code>. </p><p>Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.</p><p>This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored after a cluster is fully started (stable) or when individual servers are started.</p><ul><li><p>A value > <code></code> specifies the time, in seconds, to delay before a partially started cluster starts dynamically configured services.</p></li><li><p>A value of <code></code> specifies no delay.</p></li></ul>"
},
"preserveMsgProperty":{
"default":false,
"type":"boolean",
"description":"<p>Specifies if message properties are preserved when messages are forwarded by a bridge instance.</p><p>The following message properties are preserved:</p><ul><li><p><code>message ID</code></p></li><li><p><code>message timestamp</code></p></li><li><p><code>user ID</code></p></li><li><p><code>delivery mode</code></p></li><li><p><code>priority</code></p></li><li><p><code>expiration time</code></p></li><li><p><code>redelivery limit</code></p></li><li><p><code>unit of order name</code></p></li></ul><p>If the target bridge destination is on a foreign JMS server, the following message properties are preserved:</p><ul><li><p><code>delivery mode</code></p></li><li><p><code>priority</code></p></li><li><p><code>expiration time</code></p></li></ul>"
},
"qualityOfService":{
"x-weblogic-secureDefault":"Exactly-once",
"default":"Exactly-once",
"enum":[
"Exactly-once",
"Atmost-once",
"Duplicate-okay"
],
"type":"string",
"description":"<p>The QOS (quality of service) for this messaging bridge instance.</p><ul><li><p><code>Exactly-once</code>: Each message in the source destination is transferred to the target exactly once. This is the highest QOS a messaging bridge instance can offer.</p></li><li><p><code>Atmost-once</code>: Each message in the source is transferred to the target only once with the possibility of being lost during the forwarding.</p></li><li><p><code>Duplicate-okay</code>: Messages in the source destination are transferred to the target (none are lost) but some may appear in the target more than once.</p></li></ul><p><h5>Constraints</h5></p><ul><li>secure default : \"Exactly-once\"</li></ul>"
},
"reconnectDelayIncrease":{
"default":5,
"minimum":0,
"maximum":2147483647,
"type":"integer",
"format":"int32",
"description":"<p>The incremental delay time, in seconds, that a messaging bridge instance increases its waiting time between one failed reconnection attempt and the next retry.</p><p>Use with <code>ReconnectDelayMinimum</code> and <code>ReconnectDelayMaximum</code>. After the first failure to connect to a destination, the bridge instance waits for the number of seconds defined by <code>ReconnectDelayMinimum</code>. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by <code>ReconnectDelayIncrease</code>. The maximum delay time is defined by <code>ReconnectDelayMaximum</code>. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by <code>ReconnectDelayMinimum</code></p>"
},
"reconnectDelayMaximum":{
"default":60,
"minimum":0,
"maximum":2147483647,
"type":"integer",
"format":"int32",
"description":"<p>The longest amount of time, in seconds, that a messaging bridge instance waits between one failed attempt to connect to the source or target, and the next retry.</p><p>Use with <code>ReconnectDelayMinimum</code> and <code>ReconnectDelayIncrease</code>. After the first failure to connect to a destination, a bridge instance waits for the number of seconds defined by <code>ReconnectDelayMinimum</code>. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by <code>ReconnectDelayIncrease</code>. The maximum delay time is defined by <code>ReconnectDelayMaximum</code>. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by <code>ReconnectDelayMinimum</code></p>"
},
"reconnectDelayMinimum":{
"default":15,
"minimum":0,
"maximum":2147483647,
"type":"integer",
"format":"int32",
"description":"<p>The minimum amount of time, in seconds, that a messaging bridge instance waits before it tries to reconnect to the source or target destination after a failure.</p><p>Use with <code>ReconnectDelayMaximum</code> and <code>ReconnectDelayIncrease</code>. After the first failure to connect to a destination, the bridge instance waits for the number of seconds defined by <code>ReconnectDelayMinimum</code>. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by <code>ReconnectDelayIncrease</code>. The maximum delay time is defined by <code>ReconnectDelayMaximum</code>. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by <code>ReconnectDelayMinimum</code></p><p></p>"
},
"restartInPlace":{
"type":"boolean",
"description":"<p> Enables a periodic automatic in-place restart of failed cluster-targeted or standalone-server-targeted JMS artifact instance(s) running on healthy WebLogic Server instances. See the migratable target settings for in-place restarts of migratable-targeted JMS artifacts. When the Restart In Place setting is configured on a store, it applies to all JMS artifacts that reference the store.</p><ul><li><p>If the Migration Policy of the JMS artifact is set to <code>Off</code>, Restart In Place is disabled by default.</p></li><li><p>If the Migration Policy of the JMS artifact is set to <code>On-Failure</code> or <code>Always</code>, Restart In Place is enabled by default.</p></li><li><p>This attribute is not used by WebLogic messaging bridges which automatically restart internal connections as needed.</p></li><li><p>For a JMS artifact that is cluster-targeted and the Migration Policy is set to <code>On-Failure</code> or <code>Always</code>, if restart fails after the configured maximum retry attempts, it will migrate to a different server within the cluster. </p></li></ul>"
},
"secondsBetweenRestarts":{
"default":30,
"minimum":1,
"type":"integer",
"format":"int32",
"description":"<p>Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.</p>"
},
"selector":{
"type":"string",
"description":"<p>The filter for messages that are sent across the messaging bridge instance.</p><p>Only messages that match the selection criteria are sent across the messaging bridge:</p><ul><li><p>For queues, messages that do not match the selection criteria are left behind and accumulate in the queue.</p></li><li><p>For topics, messages that do not match the connection criteria are dropped.</p></li></ul>"
},
"sourceDestination":{
"x-weblogic-restartRequired":true,
"title":"Bridge Destination Common Reference",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"Contains the bridge destination common reference. <p>The source destination from which this messaging bridge instance reads messages.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
},
"started":{
"default":true,
"type":"boolean",
"description":"<p>Specifies the initial operating state of a targeted messaging bridge instance.</p><ul><li><p>If enabled, the messaging bridge instance forwards messages (running).</p></li><li><p>If not enabled, the messaging bridge instance does not forward messages (temporarily stopped).</p></li></ul><p>After a messaging bridge has started forwarding messages (running), use <code>Started</code> to temporarily suspend an active messaging bridge instance or restart an stopped messaging bridge instance.</p><ul><li><p>Select the <code>Started</code> checkbox to start a messaging bridge instance that has been temporarily stopped.</p></li><li><p>Clear the <code>Started</code> checkbox to temporarily stop a messaging bridge instance that was running.</p></li><li><p>This value does not indicate the run-time state of a messaging bridge instance.</p></li></ul>"
},
"tags":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>Return all tags on this Configuration MBean</p>"
},
"targetDestination":{
"x-weblogic-restartRequired":true,
"title":"Bridge Destination Common Reference",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"Contains the bridge destination common reference. <p>The target destination where a messaging bridge instance sends the messages it receives from the source destination.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
},
"targets":{
"title":"Target References",
"type":"array",
"items":{
"title":"Target Reference",
"type":"object",
"properties":{
"identity":{
"title":"Identity",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}
},
"description":"Contains the target reference."
},
"description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p>"
},
"transactionTimeout":{
"default":30,
"minimum":0,
"maximum":2147483647,
"type":"integer",
"format":"int32",
"description":"<p>The amount of time, in seconds, that the transaction manager waits for each transaction before timing it out.</p><ul><li><p>Transaction timeouts are used when the QOS (quality of service) for a messaging bridge instance requires transactions.</p></li><li><p>If a bridge is configured with <i>Exactly-once</i> QOS, the receiving and sending is completed in one transaction.</p></li></ul>"
},
"type":{
"readOnly":true,
"x-weblogic-unharvestable":true,
"type":"string",
"description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
}
},
"description":""
}