ルート・スキーマ: SAF Agent
型: object
ソースを表示
- acknowledgeInterval(optional): integer(int64)
デフォルト値: -1
受信側が連続して2回送信する確認応答の最大間隔。
制約
- ドメイン・スコープ指定MBeanには表示されません
- bytesMaximum(optional): integer(int64)
最小値: -1
デフォルト値: -1
このSAFエージェントに保存可能な最大バイト数の割当て(合計バイト数)。
値の範囲: >= BytesThresholdHigh
制約
- ドメイン・スコープ指定MBeanには表示されません
- bytesThresholdHigh(optional): integer(int64)
最小値: -1
デフォルト値: -1
SAFエージェントに保存されているバイト数に基づいてイベントを発生させる上限しきい値。
デフォルト値の-1に設定すると、このSAFエージェントでのイベントは無効になります。
送信機能のあるエージェントにのみ適用されます。
BytesThresholdHighの更新の影響を受けるのは、新規のリクエストのみです。
バイト数がこのしきい値を超えた場合、発生するイベントは次のとおりです。
値の範囲: <= bytesmaximum;>= BytesThresholdLow
制約
- ドメイン・スコープ指定MBeanには表示されません
- bytesThresholdLow(optional): integer(int64)
最小値: -1
デフォルト値: -1
SAFエージェントに保存されているバイト数に基づいて、イベントを発生させる下限しきい値。
デフォルト値の-1に設定すると、このSAFエージェントでのイベントは無効になります。
送信機能のあるエージェントにのみ適用されます。
BytesThresholdLowの更新の影響を受けるのは、新規のリクエストのみです。
バイト数がこのしきい値を下回った場合、発生するイベントは次のとおりです。
値の範囲: <= bytesthresholdhigh< p>
制約
- ドメイン・スコープ指定MBeanには表示されません
- conversationIdleTimeMaximum(optional): integer(int64)
最小値: 0
デフォルト値: 0
送信側が会話で使用されるリソースを解放するまでの許容最長期間(ミリ秒)。
指定期間内に会話のためのアクティビティがない場合、送信エージェントはその会話のためのリソースをすべて解放し、受信側にも同じことをするよう通知します。
値
ConversationIdleTimeMaximumを更新すると、更新後に開始する接続では、新しい値が使用されます。
制約
- ドメイン・スコープ指定MBeanには表示されません
- defaultRetryDelayBase(optional): integer(int64)
最小値: 1
デフォルト値: 20000
元の配信試行と、1回目の再試行との間の時間(単位はミリ秒)。
値の範囲: <= retrydelaymaximum。retrydelaymultiplierが1.0でない場合。< p>
制約
- ドメイン・スコープ指定MBeanには表示されません
- defaultRetryDelayMaximum(optional): integer(int64)
最小値: 1
デフォルト値: 180000
連続して行われる2回の配信再試行の間の最長期間(単位はミリ秒)。
値の範囲: > = RetryDelayBase。RetryDelayMultiplierが1.0でない場合。
制約
- ドメイン・スコープ指定MBeanには表示されません
- defaultRetryDelayMultiplier(optional): number(double)
最小値: 1
デフォルト値: 1
前回の遅延時間を乗算して、次に使用する遅延時間を計算するための因数。
値の範囲: >= 1。
制約
- ドメイン・スコープ指定MBeanには表示されません
- defaultTimeToLive(optional): integer(int64)
最小値: 0
デフォルト値: 0
エージェントが確実にメッセージを送信することを保証する、デフォルトの時間(単位はミリ秒)。
制約
- ドメイン・スコープ指定MBeanには表示されません
- deploymentOrder(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 1000
デプロイの優先度。サーバーはこの値を使用して項目のデプロイ順を決定します。優先度は、同じタイプでデプロイ可能なアイテム間で決められます。
たとえば、サーバーではすべてのEJBを優先度に従ってデプロイしてから、起動クラスを優先度に従ってデプロイします。
「デプロイ順序」の値が小さい項目から順にデプロイされます。「デプロイ順序」の値が等しいデプロイメントの順序付けは保証されていません。クラスタ間の順序付けは保証されていません。
制約
- ドメイン・スコープ指定MBeanには表示されません
- dynamicallyCreated(optional): boolean
読取り専用: true
デフォルト値: false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
制約
- ドメイン・スコープ指定MBeanには表示されません
- forwardingPausedAtStartup(optional): boolean
デフォルト値: false
起動時にメッセージ転送のためにエージェントを一時停止するかどうかを指定します。
有効にした場合、送信エージェントはメッセージを転送します。そうでない場合、送信エージェントはメッセージを転送しません。
値が変更されてアクティブ化される場合、その値を反映するには、(コンソールでサーバーの再起動が必要であるという警告を受けていなくても) MBeanが割り当てられているすべてのサーバーを再起動する必要があります。
制約
- ドメイン・スコープ指定MBeanには表示されません
- id(optional): integer(int64)
読取り専用: true
このMBeanインスタンスの一意のIDを返します
制約
- ドメイン・スコープ指定MBeanには表示されません
- incomingPausedAtStartup(optional): boolean
デフォルト値: false
起動時に新しく配信されるメッセージのためにエージェントを一時停止するかどうかを指定します。
有効にした場合、送信エージェントは新しいメッセージを受け入れます。そうでない場合、送信エージェントは新しいメッセージを受け入れません。
値が変更されてアクティブ化される場合、その値を反映するには、(コンソールでサーバーの再起動が必要であるという警告を受けていなくても) MBeanが割り当てられているすべてのサーバーを再起動する必要があります。
制約
- ドメイン・スコープ指定MBeanには表示されません
- loggingEnabled(optional): boolean
デフォルト値: true
メッセージ転送が失敗した場合に、サーバー・ログ・ファイルにメッセージを記録するかどうかを指定します。
制約
- ドメイン・スコープ指定MBeanには表示されません
- maximumMessageSize(optional): integer(int32)
最小値: 0
デフォルト値: 2147483647
このSAFエージェントの個々のメッセージに許可される最大バイト数。
メッセージのサイズには、メッセージの本文、ユーザー定義のプロパティ、ユーザー定義のJMSヘッダー・フィールド(JMSCorrelationIDおよびJMSType)が含まれます
構成された最大メッセージ・サイズを超えるメッセージをSAFエージェントに送信したプロデューサは、ResourceAllocationExceptionを受け取ります。
最大メッセージ・サイズは、メッセージの最初の生成に対してのみ適用されます。エラー宛先に転送されるメッセージや、分散宛先のメンバーに転送されるメッセージは、サイズをチェックされません。たとえば、宛先の最大メッセージ・サイズが128KB、対応するエラー宛先の最大メッセージ・サイズが64KBで構成されている場合、96KBのメッセージは(64KBを超えても)エラー宛先にリダイレクトできますが、プロデューサが96KBのメッセージをエラー宛先に直接送信することはできません。
送信機能のあるエージェントにのみ適用されます。
MaximumMessageSizeを更新すると影響を受けるのは、新しく配信されるメッセージのみです。保存されているメッセージは影響を受けません。
制約
- ドメイン・スコープ指定MBeanには表示されません
- messageBufferSize(optional): integer(int64)
最小値: -1
デフォルト値: -1
ディスクへページングされる前のメモリー内のメッセージ本文を保存する際のメモリー使用量。
値 -1 (デフォルト)は、サーバーがJVMの最大ヒープ・サイズに基づいて自動的にサイズを決定することを示します。このデフォルトは、最大ヒープ・サイズの3分の1か、512MBのうち小さい方のサイズに設定されます。
バッファが大きくなるほど、多くのメッセージがキューまたはトピックに待機している際にJMSでより多くのメモリーが消費されます。このバッファ・サイズを超えると、JMSはメモリー使用量をバッファ・サイズ未満に抑えようとして、PagingDirectoryで指定したディレクトリに、メッセージ本文を書き込むことがあります。
バッファ・サイズを超えても、JMSサーバーは新しいメッセージを受信し続けます。そのため、メッセージ受信速度がディスクへの書込み速度を上回る場合は、メモリー不足に陥るおそれがあります。メッセージ負荷の大きいユーザーが、できるかぎり高い可用性をサポートするには、割り当てまたはしきい値を設定してフロー制御を有効にする必要があります。
送信機能のあるエージェントにのみ適用されます。
ページングは、常にサポートされています。
メモリー・サイズを更新すると、メッセージ数がリセットされるので、更新後に受信されるリクエストのみが、新しいメモリー・サイズを適用されます。
制約
- ドメイン・スコープ指定MBeanには表示されません
- messageCompressionOptions(optional): string
デフォルト値: GZIP_DEFAULT_COMPRESSION
指定可能な値: [ "GZIP_DEFAULT_COMPRESSION", "GZIP_BEST_COMPRESSION", "GZIP_BEST_SPEED", "LZF" ]
永続ストアおよびJMSページング・ストアに対してJMSメッセージ本文の圧縮が有効な場合に使用する、メッセージ圧縮のタイプを指定します。
JDK GZIP APIを使用したDEFAULT_COMPRESSIONレベルのメッセージ圧縮を行う場合は、GZIP_DEFAULT_COMPRESSIONを使用します。
JDK GZIP APIを使用したBEST_COMPRESSIONレベルのメッセージ圧縮を行う場合は、GZIP_BEST_COMPRESSIONを使用します。
JDK GZIP APIを使用したBEST_SPEEDレベルのメッセージ圧縮を行う場合は、GZIP_BEST_SPEEDを使用します。
オープン・ソースLZFを使用したメッセージ圧縮を行う場合は、LZFを使用します。
制約
- ドメイン・スコープ指定MBeanには表示されません
- messagesMaximum(optional): integer(int64)
最小値: -1
デフォルト値: -1
このSAFエージェントに保存可能な最大メッセージ数の割当て(合計メッセージ数)。
デフォルト値-1は、サーバー・インスタンスで保存可能なメッセージ数が制限されていないことを示します。ただし、あまり大きなメッセージ数を割り当てると、メモリーが飽和状態になるおそれがあるので、残りのアプリケーションの負荷を考慮に入れ、利用可能なシステム・メモリーの総量に見合った値にしてください。
送信エージェントにのみ適用されます。
最大メッセージ数の割当てを更新すると、メッセージ数がリセットされるため、更新後に受信されたリクエストのみが、新しい割当てを適用されます。
値の範囲: >= MessagesThresholdHigh
制約
- ドメイン・スコープ指定MBeanには表示されません
- messagesThresholdHigh(optional): integer(int64)
最小値: -1
デフォルト値: -1
SAFエージェントに保存されているメッセージ数に基づいてイベントを発生させる上限しきい値。
デフォルト値の-1に設定すると、このSAFエージェントでのイベントは無効になります。
送信機能のあるエージェントにのみ適用されます。
MessagesThresholdHighの更新の影響を受けるのは、新規のリクエストのみです。
メッセージ数がこのしきい値を超えた場合、発生するイベントは次のとおりです。
値の範囲: <= messagesmaximum;>= MessagesThresholdLow
制約
- ドメイン・スコープ指定MBeanには表示されません
- messagesThresholdLow(optional): integer(int64)
最小値: -1
デフォルト値: -1
SAFエージェントに保存されているメッセージ数に基づいてイベントを発生させる下限しきい値。
デフォルト値の-1に設定すると、このSAFエージェントでのイベントは無効になります。
送信機能のあるエージェントにのみ適用されます。
MessagesThresholdLowの更新の影響を受けるのは、新規のリクエストのみです。
メッセージ数がこのしきい値を下回った場合、発生するイベントは次のとおりです。
値の範囲: <= messagesthresholdhigh.< p>
制約
- ドメイン・スコープ指定MBeanには表示されません
- name(optional): string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています
Name=user-specified-name
制約
- notes(optional): string
この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<)はXMLエンティティ<に変換されます。<キャリッジ・リターン/ライン・フィードは維持されます。
ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。
- pagingDirectory(optional): string
デフォルト値: oracle.doceng.json.BetterJsonNull@11518582
JMSサーバーのメッセージ本文のサイズが、メッセージ・バッファ・サイズを超過した場合に、メッセージ本文が書き込まれる場所を指定します。指定されていない場合、メッセージはホストWebLogic Serverインスタンスのディレクトリ内のtmpディレクトリに書き込まれます。たとえば次のようになります。domainName/servers/servername/tmp
値が変更されてアクティブ化される場合、その値を反映するには、(コンソールでサーバーの再起動が必要であるという警告を受けていなくても) MBeanが割り当てられているすべてのサーバーを再起動する必要があります。
制約
- 有効なnull
- ドメイン・スコープ指定MBeanには表示されません
- pagingMessageCompressionEnabled(optional): boolean
デフォルト値: false
JMSページング・ストアでのメッセージ本文の圧縮(永続メッセージと非永続メッセージ)を有効にします。false(デフォルト値)に設定すると、圧縮は実行されません。
制約
- ドメイン・スコープ指定MBeanには表示されません
- receivingPausedAtStartup(optional): boolean
デフォルト値: false
起動時にメッセージ受信のためにエージェントを一時停止するかどうかを指定します。
有効にした場合、送信エージェントはメッセージを受信します。そうでない場合、送信エージェントはメッセージを受信しません。
値が変更されてアクティブ化される場合、その値を反映するには、(コンソールでサーバーの再起動が必要であるという警告を受けていなくても) MBeanが割り当てられているすべてのサーバーを再起動する必要があります。
制約
- ドメイン・スコープ指定MBeanには表示されません
- serviceType(optional): string
デフォルト値: Both
指定可能な値: [ "Both", "Sending-only", "Receiving-only" ]
このSAFエージェントが提供するサービスのタイプ。JMSでは、メッセージ送信側の送信エージェントのみが必要となります。一方、Web Services Reliable Messagingでは、メッセージの送信エージェントと受信エージェントの両方が必要です。
送信専用 永続ストレージへのメッセージの格納、受信側へのメッセージの転送、および確認応答が時間内に戻らなかった場合のメッセージの再送を行うエージェントを構成します。
受信専用 受信エージェントから送信されたメッセージの検出と重複排除、および最終的な宛先へのメッセージの配信を行うエージェントを構成します。
両方 送信エージェントと受信エージェントの機能を備えたエージェントを構成します。
値が変更されてアクティブ化される場合、その値を反映するには、(コンソールでサーバーの再起動が必要であるという警告を受けていなくても) MBeanが割り当てられているすべてのサーバーを再起動する必要があります。
制約
- ドメイン・スコープ指定MBeanには表示されません
- store(optional): array Persistent Store Reference
タイトル: Persistent Store Reference
永続ストア参照が含まれます。
SAFエージェントのための、永続的なディスクベースのファイル・ストア、またはJDBCでアクセス可能なデータベース。
ストアが構成されていなければ、サーバーのデフォルト・ストアが使用されます。
値が変更されてアクティブ化される場合、その値を反映するには、(コンソールでサーバーの再起動が必要であるという警告を受けていなくても) MBeanが割り当てられているすべてのサーバーを再起動する必要があります。
制約
- 再起動が必要
- ドメイン・スコープ指定MBeanには表示されません
- storeMessageCompressionEnabled(optional): boolean
デフォルト値: false
JMSストアでのメッセージ本文の圧縮を有効にします。false(デフォルト値)に設定すると、圧縮は実行されません。
制約
- ドメイン・スコープ指定MBeanには表示されません
- tags(optional): array Items
- targets(optional): array Target References
タイトル: Target References
ターゲット参照の配列が含まれます。
制約
- ドメイン・スコープ指定MBeanには表示されません
- type(optional): string
- windowInterval(optional): integer(int64)
最小値: 0
デフォルト値: 0
JMS送信エージェントが、単一バッチでメッセージを転送するまでに待機する最長時間(ミリ秒)分散キューまたは分散トピックの場合、WindowInterval設定は無視されます。
送信エージェントは、(A)ソース宛先メッセージ数が、構成された「ウィンドウ・サイズ」以上になるか、(B)待機時間が指定された「ウィンドウ間隔」になるかの、いずれかの条件が満たされるまで(どちらが先であるかは問わない)、メッセージ・バッチを転送せずに待機します。
制約
- ドメイン・スコープ指定MBeanには表示されません
- windowSize(optional): integer(int32)
最小値: 1
デフォルト値: 10
JMSメッセージの場合は、バッチ内のメッセージ数。送信エージェントは、ソース宛先メッセージ数がこの値以上になるまで、メッセージ・バッチを転送せずに待機します。分散キューまたは分散トピックの場合、WindowSize設定は無視され、常に内部的に1メッセージに設定されます。
WSRMの場合は、会話中にソース宛先とターゲット宛先の間で許容される未応答メッセージの最大数。
制約
- ドメイン・スコープ指定MBeanには表示されません
{
"type":"object",
"properties":{
"acknowledgeInterval":{
"default":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The maximum interval between two successive acknowledgements sent by the receiving side.</p><ul><li><p>Applies only to agents with receiving capability.</p></li><li><p>A value of <code>-1</code> specifies that there is no time limit between successive acknowledgement.</p></li><li><p>Updating <code>AcknowlegeInterval</code> causes connections starting after the update to use the new value.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"bytesMaximum":{
"default":-1,
"minimum":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.</p><ul><li><p>The default value of <code>-1</code> specifies that there is no WebLogic-imposed limit on the number of bytes that can be stored. However, excessive bytes volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.</p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>BytesMaximum</code> affects only new requests.</p></li></ul><p><b>Range of Values:</b> >= BytesThresholdHigh</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"bytesThresholdHigh":{
"default":-1,
"minimum":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The upper threshold value that triggers events based on the number of bytes stored in the SAF agent.</p><ul><li><p>The default value of <code>-1</code> disables the events for this SAF agent. </p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>BytesThresholdHigh</code> affects only new requests.</p></li><li><p>If the number of bytes exceeds this threshold, the triggered events are:</p><ul><li><p><b>Log Messages</b>: A message is logged on the server indicating a high threshold condition.</p></li><li><p><b>Flow Control</b>: The agent becomes armed and instructs producers to begin decreasing their message flow.</p></li></ul></li></ul><p><b>Range of Values:</b> <= BytesMaximum; >= BytesThresholdLow</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"bytesThresholdLow":{
"default":-1,
"minimum":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The lower threshold that triggers events based on the number of bytes stored in the SAF agent.</p><ul><li><p>The default value of <code>-1</code> disables the events for this SAF agent. </p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>BytesThresholdLow</code> affects only new requests.</p></li><li><p>If the number of bytes falls below this threshold, the triggered events are:</p><ul><li><p><b>Log Messages</b>: A message is logged on the server indicating that the threshold condition has cleared.</p></li><li><p><b>Flow Control</b>: The agent becomes disarmed and instructs producers to begin increasing their message flow.</p></li></ul></li></ul><p><b>Range of Values:</b> <= BytesThresholdHigh</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"conversationIdleTimeMaximum":{
"default":0,
"minimum":0,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The maximum amount of time allowed, in milliseconds, before a sending side releases the resources used by a conversation.</p><ul><li><p>If there is no activity for a conversation for the specified amount of time, the sending agent releases all resources for that conversation and notifies the receiving agent to do the same.</p></li><li><p>A value of <code></code> specifies that resources for a conversation are not released unless the application explicitly closes the conversation.</p></li><li><p>Updating <code>ConversationIdleTimeMaximum</code> causes connections starting after the update to use the new value.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"defaultRetryDelayBase":{
"default":20000,
"minimum":1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The amount of time, in milliseconds, between the original delivery attempt and the first retry.</p><ul><li><p>If <code>RetryDelayMultiplier</code> is set to <code></code>, this defines the interval between any two successive retry attempts.</p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>DefaultRetryDelayBase</code> causes connections starting after the update to use the new value.</p></li></ul><p><b>Range of Values:</b> <= RetryDelayMaximum if RetryDelayMultiplier is not 1.0. </p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"defaultRetryDelayMaximum":{
"default":180000,
"minimum":1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The maximum amount of time, in milliseconds, between two successive delivery retry attempts.</p><ul><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>DefaultRetryDelayMaximum</code> causes connections starting after the update to use the new value.</p></li></ul><p><b>Range of Values:</b> > = RetryDelayBase if RetryDelayMultiplier is not 1.0. </p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"defaultRetryDelayMultiplier":{
"default":1,
"minimum":1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"number",
"format":"double",
"description":"<p>The factor used to multiply the previous delay time to calculate the next delay time to be used.</p><ul><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>DefaultRetryDelayMuliplier</code> causes connections starting after the update to use the new value.</p></li></ul><p><b>Range of Values:</b> >= 1.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"defaultTimeToLive":{
"default":0,
"minimum":0,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The default amount of time, in milliseconds, that the agent guarantees to reliably send messages.</p><ul><li><p>A value of 0 means the agent guarantees to reliably send messages for the duration of the conversation.</p></li><li><p>Updating <code>DefaultTimeToLive</code> causes conversations starting after the update to use the new value.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"deploymentOrder":{
"default":1000,
"minimum":0,
"maximum":2147483647,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"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><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"dynamicallyCreated":{
"readOnly":true,
"default":false,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"boolean",
"description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"forwardingPausedAtStartup":{
"default":false,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"boolean",
"description":"<p>Specifies whether the agent is paused for forwarding messages at the startup time.</p><p>When enabled, the sending agent forwards messages. Otherwise, the sending agent does not forward any messages.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"id":{
"readOnly":true,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>Return the unique id of this MBean instance</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"incomingPausedAtStartup":{
"default":false,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"boolean",
"description":"<p>Specifies whether the agent is paused for incoming messages at startup time.</p><p>When enabled, the sending agent accepts new messages. Otherwise, the sending agent does not accept any new messages.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"loggingEnabled":{
"default":true,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"boolean",
"description":"<p>Specifies whether a message is logged in the server log file when a message fails to be forwarded.</p><ul><li><p>If selected, this applies to messages that fail to be forwarded and delivered to the final destination when there is no error handling in a SAF application or the application's error handling fails.</p></li><li><p>Applies only to agents with receiving capability.</p></li><li><p>Updating <code>LoggingEnabled</code> causes connections starting after the update to use the new value.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"maximumMessageSize":{
"default":2147483647,
"minimum":0,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int32",
"description":"<p>The maximum number of bytes allowed in individual messages on this SAF agent.</p><ul><li><p>The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: <code>JMSCorrelationID</code> and <code>JMSType</code></p></li><li><p>Producers sending messages that exceed the configured maximum message size for the SAF agent will receive a <code>ResourceAllocationException</code></p></li><li><p>The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.</p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>MaximumMessageSize</code> affects only incoming messages; stored messages are not affected.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"messageBufferSize":{
"default":-1,
"minimum":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The amount of memory used to store message bodies in memory before they are paged out to disk.</p><ul><li><p>A value of -1 (the default) specifies that the server will automatically determine a size based on the maximum heap size of the JVM. This default will be set to either one-third the maximum heap size, or 512 megabytes, whichever is smaller.</p></li><li><p>The larger the buffer, the more memory JMS will consume when many messages are waiting on queues or topics. Once the buffer is surpassed, JMS may write message bodies to the directory specified by PagingDirectory in an effort to reduce memory usage below this buffer.</p></li><li><p>Surpassing the buffer size does not stop the JMS server from accepting new messages. It is still possible to run out of memory if messages are arriving faster than they can be written to disk. Users with high messaging loads who wish to support the highest possible availability should consider setting a quota or setting a threshold and enabling flow control.</p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Paging is always supported. </p></li><li><p>Updating the memory size resets the message count so that only requests arriving after the update are charged against the new memory size.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"messageCompressionOptions":{
"default":"GZIP_DEFAULT_COMPRESSION",
"enum":[
"GZIP_DEFAULT_COMPRESSION",
"GZIP_BEST_COMPRESSION",
"GZIP_BEST_SPEED",
"LZF"
],
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"string",
"description":"<p>Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.</p><ul><li><p>Use <code>GZIP_DEFAULT_COMPRESSION</code> to enable message compression using the JDK GZIP API with <code>DEFAULT_COMPRESSION</code> level.</p></li><li><p>Use <code>GZIP_BEST_COMPRESSION</code> to enable message compression using the JDK GZIP API with <code>BEST_COMPRESSION</code> level.</p></li><li><p>Use <code>GZIP_BEST_SPEED</code> to enable message compression using the JDK GZIP API with <code>BEST_SPEED</code> level.</p></li><li><p>Use <code>LZF</code> to enable message compression using Open Source LZF.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"messagesMaximum":{
"default":-1,
"minimum":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The maximum message quota (total amount of messages) that can be stored in this SAF agent.</p><ul><li><p>The default value of <code>-1</code> specifies that the server instance has no limit on the number of messages that can be stored. However, excessive message volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.</p></li><li><p>Applies only to sending agents.</p></li><li><p>Updating the maximum message quota resets the message count so that only requests arriving after the update are charged against the new quota.</p></li></ul><p><b>Range of Values:</b> >= MessagesThresholdHigh</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"messagesThresholdHigh":{
"default":-1,
"minimum":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The upper threshold that triggers events based on the number of messages stored in the SAF agent.</p><ul><li><p>The default value of <code>-1</code> disables the events for this SAF agent. </p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>MessagesThresholdHigh</code> affects only new requests.</p></li><li><p>If the number of messages exceeds this threshold, the triggered events are:</p><ul><li><p><b>Log Messages</b>: A message is logged on the server indicating a high threshold condition.</p></li><li><p><b>Flow Control</b>: The agent becomes armed and instructs producers to begin decreasing their message flow.</p></li></ul></li></ul><p><b>Range of Values:</b> <= MessagesMaximum; >= MessagesThresholdLow</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"messagesThresholdLow":{
"default":-1,
"minimum":-1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The low threshold that triggers events based on the number of messages stored in the SAF agent.</p><ul><li><p>The default value of <code>-1</code> disables the events for this SAF agent. </p></li><li><p>Applies only to agents with sending capability.</p></li><li><p>Updating <code>MessagesThresholdLow</code> affects only new requests.</p></li><li><p>If the number of messages falls below this threshold, the triggered events are:</p><ul><li><p><b>Log Messages</b>: A message is logged on the server indicating that the threshold condition has cleared.</p></li><li><p><b>Flow Control</b>: The agent becomes disarmed and instructs producers to begin increasing their message flow.</p></li></ul></li></ul><p><b>Range of Values:</b> <= MessagesThresholdHigh.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</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>"
},
"pagingDirectory":{
"default":null,
"x-weblogic-legalNull":true,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"string",
"description":"<p> Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size. If unspecified, messages are written to the <code>tmp</code> directory in the host WebLogic Server instance's directory. For example, <code><i>domainName</i>/servers/<i>servername</i>/tmp</code>. </p><ul><li><p>For best performance, this directory should not be the same as the directory used by the SAF agent's persistent store.</p></li><li><p>Applies only to agents with sending capability.</p></li></ul><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>legal null</li><li>not visible for domain scoped mbeans</li></ul>"
},
"pagingMessageCompressionEnabled":{
"default":false,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"boolean",
"description":"<p>Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. When <code>false</code>, the default value, no compression is performed.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"receivingPausedAtStartup":{
"default":false,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"boolean",
"description":"<p>Specifies whether the agent is paused for receiving messages at the startup time.</p><p>When enabled, the sending agent receives messages. Otherwise, the sending agent does not receive any messages.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"serviceType":{
"default":"Both",
"enum":[
"Both",
"Sending-only",
"Receiving-only"
],
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"string",
"description":"<p>The type of service that this SAF agent provides. JMS requires only a Sending agent on the sending side for messages. Whereas, Web Services Reliable Messaging requires both a Sending and Receiving agent for messages.</p><ul><li><p><b>Sending-only</b> Configures an agent that stores messages in persistent storage, forwards messages to the receiving side, and re-transmits messages when acknowledgements do not come back in time.</p></li><li><p><b>Receiving-only</b> Configures an agent that detects and eliminates duplicate messages sent by a receiving agent, and delivers messages to the final destination.</p></li><li><p><b>Both</b> Configures an agent that has sending and receiving agent functionality. </p></li></ul><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"store":{
"x-weblogic-restartRequired":true,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"title":"Persistent Store Reference",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"Contains the persistent store reference. <p>The persistent disk-based file store or JDBC-accessible database for the SAF agent.</p><p>If a store is not configured, the server's default store is used.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>restart required</li><li>not visible for domain scoped mbeans</li></ul>"
},
"storeMessageCompressionEnabled":{
"default":false,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"boolean",
"description":"<p>Enables the JMS store to perform message body compression. When set to <code>false</code>, the default value, no compression is performed.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"tags":{
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"targets":{
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"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><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</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>"
},
"windowInterval":{
"default":0,
"minimum":0,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int64",
"description":"<p>The maximum amount of time, in milliseconds, that a JMS sending agent waits before forwarding messages in a single batch. For a distributed queue or topic, <code>WindowInterval</code> setting is ignored.</p><p>A sending agent waits to forward the message batch until either: (A) the source destination message count is greater than or equal to the configured <code>Window Size</code>; (B) it has waited a specified <code>Window Interval</code>, whichever comes first.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
},
"windowSize":{
"default":10,
"minimum":1,
"x-weblogic-notVisibleForDomainScopedMBeans":true,
"type":"integer",
"format":"int32",
"description":"<p>For JMS messages, the number of messages in a batch. A sending agent waits to forward a message batch until the source destination message count is greater than or equal to this value. For a distributed queue or topic, <code>WindowSize</code> setting is ignored and always internally set to 1 message.</p><p>For WSRM, the maximum number of unacknowledged messages allowed between a source destination and a target destination during a conversation.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}
},
"description":""
}