MO名称:

jms-physical-destination -

送信先

定義:

ObjectName

{0}:type=jms-physical-destination,name={2},config={1},category=config

CLIName

server.jms-service.jms-physical-destination.{2}

属性の概要

name (送信先名) 送信先名です。

desttype (送信先タイプ) 送信先タイプです。

consumerFlowLimitNum (コンシューマへのフロー制限数) コンシューマへのフロー制限数を指定します。 (既定値：1000)

limitBehavior (制限到達時の振る舞い) 制限到達時の振る舞いを指定します。 (既定値：REJECT_NEWEST)

maxBytesPerMsg (1 メッセージ当たりの最大サイズ) 1 メッセージ当たりの最大サイズを指定します。 (単位：バイト、既定値：-1 (無制限))

maxNumActiveConsumers (アクティブコンシューマの最大数) アクティブコンシューマの最大数を指定(キューの場合のみ)します。 (既定値：-1 (無制限))

maxNumBackupConsumers (バックアップコンシューマの最大数) バックアップコンシューマの最大数を指定(キューの場合のみ)します。 (既定値：0)

maxNumMsgs (メッセージの最大数) メッセージの最大数を指定します。 (既定値：-1 (無制限))

maxNumProducers (プロデューサの最大数) プロデューサの最大数を指定します。 (既定値：100)

maxTotalMsgBytes (メッセージの最大合計サイズ) メッセージの最大合計サイズを指定します。 (単位：バイト、既定値：-1 (無制限))

isLocalOnly (ローカル配信のみ) ローカル配信のみかどうかを表します。クラスタ内で動作するキューの場合のみ有効です。 (既定値：false(クラスタ内のすべてのコンシューマが配信対象となる))

localDeliveryPreferred (ローカル配信優先) ローカル配信優先かどうかを指定します。クラスタ内で動作する場合のみ有効です。 (既定値：false(ローカル、リモートに関係なくメッセージを配信する))

操作の概要

getInfo (情報取得) 送信先の情報を取得します。

pause (一時停止) 送信先を一時停止します。

resume (再開) 一時停止中の送信先を再開します。

getMessages (メッセージ一覧の取得) 送信先に滞留しているメッセージの一覧を取得します。

purgeMessage (指定メッセージパージ) 送信先の1件のメッセージをパージします。

purge (メッセージ全件パージ) 送信先のすべてのメッセージをパージします。

listDur (永続サブスクリプションの一覧表示) トピックの永続サブスクリプションを一覧表示します(トピックの場合のみ)。

purgeDur (永続サブスクリプションのメッセージパージ) 永続サブスクリプションのすべてのメッセージをパージします(トピックの場合のみ)。

deleteDur (永続サブスクリプションの削除) 永続サブスクリプションを削除します(トピックの場合のみ)。

getProperties (プロパティ一覧の取得) プロパティの一覧を取得します。

setProperty (プロパティの設定) プロパティの名前と値を設定します。

delete (削除) JMSサーバ上の物理的な送信先を削除します。

name (送信先名)

送信先名です。

詳細:

送信先の名前です。
送信先の名前を変更することはできません。

型:

java.lang.String

desttype (送信先タイプ)

送信先タイプです。

詳細:

送信先のタイプ（topic/queue）を指定します。
送信先のタイプを変更することはできません。

型:

java.lang.String

値の有効範囲:

topic	-	topic
queue	-	queue

consumerFlowLimitNum (コンシューマへのフロー制限数)

コンシューマへのフロー制限数を指定します。
(既定値：1000)

詳細:

JMSサーバが一度の処理でコンシューマに配信するメッセージの最大数を指定します。ただし、各コンシューマが使用するコネクションファクトリで指定された制限値の方が低い場合は、その値が優先します。-1は無制限です。

型:

java.lang.Integer

値の範囲:

-1,0-2147483647

limitBehavior (制限到達時の振る舞い)

制限到達時の振る舞いを指定します。
(既定値：REJECT_NEWEST)

詳細:

メモリ制限のしきい値に到達したときのJMSサーバの振る舞いを指定します。

FLOW_CONTROL ： プロデューサとの間でフロー制御（低速化）を行います。
REMOVE_OLDEST ： 最古のメッセージを破棄します（プロデューサがメッセージ削除の通知を受け取ることはありません）。
REMOVE_LOW_PRIORITY ： メッセージの有効期限に従い優先度が最低のメッセージを破棄します（プロデューサがメッセージ削除の通知を受け取ることはありません）。
REJECT_NEWEST ： 最新のメッセージを拒否します（永続メッセージの場合はプロデューサにメッセージ拒否の例外が発生しますが、非永続メッセージの場合には発生しません）。

型:

java.lang.String

値の有効範囲:

FLOW_CONTROL	-	FLOW_CONTROL
REMOVE_OLDEST	-	REMOVE_OLDEST
REJECT_NEWEST	-	REJECT_NEWEST
REMOVE_LOW_PRIORITY	-	REMOVE_LOW_PRIORITY

maxBytesPerMsg (1 メッセージ当たりの最大サイズ)

1 メッセージ当たりの最大サイズを指定します。
(単位：バイト、既定値：-1 (無制限))

詳細:

１メッセージあたりの最大サイズを指定します。このサイズを超えたメッセージを送信したとき、永続メッセージの場合はプロデューサに例外が発生しますが、非永続メッセージの場合には何も通知されません。

128,128bは128バイトを、128kは128Kバイト(128×1024=131072バイト)、128mは128Mバイト(128×1024×1024=134217728バイト)を表します。-1は無制限です。

型:

java.lang.String

maxNumActiveConsumers (アクティブコンシューマの最大数)

アクティブコンシューマの最大数を指定(キューの場合のみ)します。
(既定値：-1 (無制限))

詳細:

キューからの配信が負荷分散されているアクティブコンシューマの最大数を指定します。-1は無制限を意味します。
この指定はキューにのみ有効です。

型:

java.lang.Integer

値の範囲:

-1,1-2147483647

maxNumBackupConsumers (バックアップコンシューマの最大数)

バックアップコンシューマの最大数を指定(キューの場合のみ)します。
(既定値：0)

詳細:

アクティブコンシューマの障害時にバックアップするバックアップコンシューマの最大数を指定します。-1は無制限を意味します。
この指定はキューにのみ有効です。

型:

java.lang.Integer

値の範囲:

-1,0-2147483647

maxNumMsgs (メッセージの最大数)

メッセージの最大数を指定します。
(既定値：-1 (無制限))

詳細:

送信先に滞留可能なメッセージの最大数を指定します。-1は無制限を意味します。

型:

java.lang.Integer

値の範囲:

-1,1-2147483647

maxNumProducers (プロデューサの最大数)

プロデューサの最大数を指定します。
(既定値：100)

詳細:

送信先に接続可能なプロデューサ数を指定します。この制限に到達すると、新たなプロデューサは生成できません。-1は無制限を意味します。

型:

java.lang.Integer

値の範囲:

-1,1-2147483647

maxTotalMsgBytes (メッセージの最大合計サイズ)

メッセージの最大合計サイズを指定します。
(単位：バイト、既定値：-1 (無制限))

詳細:

送信先に滞留可能なメッセージの最大合計サイズ（バイト単位）を指定します。
128,128bは128バイトを、128kは128Kバイト(128×1024=131072バイト)、128mは128Mバイト(128×1024×1024=134217728バイト)を表します。-1は無制限です。

型:

java.lang.String

isLocalOnly (ローカル配信のみ)

ローカル配信のみかどうかを表します。クラスタ内で動作するキューの場合のみ有効です。
(既定値：false(クラスタ内のすべてのコンシューマが配信対象となる))

詳細:

ローカル配信のみかどうかを指定します。送信先の作成後は変更できません。

true：ローカルコンシューマ (送信先が作成されたブローカに接続しているコンシューマ) だけにメッセージを配信するように制限される。
false：クラスタ内のすべてのコンシューマが配信対象となる。

型:

java.lang.Boolean

localDeliveryPreferred (ローカル配信優先)

ローカル配信優先かどうかを指定します。クラスタ内で動作する場合のみ有効です。
(既定値：false(ローカル、リモートに関係なくメッセージを配信する))

詳細:

ローカル配信優先かどうかを指定します。

true：メッセージは、ローカルのJMSサーバにコンシューマが存在しない場合にのみ、リモートコンシューマに配信されます。この場合は、ローカル配信のみかどうかの指定(isLocalOnly)をfalseにする必要があります。
false：ローカル、リモートに関係なく、準備のできているコンシューマへメッセージを配信します。

型:

java.lang.Boolean

getInfo (情報取得)

送信先の情報を取得します。

戻り値:

java.lang.String[]

引数:

なし

pause (一時停止)

送信先を一時停止します。

戻り値:

void

引数:

pauseType - java.lang.Integer

送信先の一時停止タイプを指定します。

PRODUCERS : プロデューサからのメッセージを一時停止
CONSUMERS : コンシューマへのメッセージを一時停止
ALL : プロデューサ、コンシューマともに一時停止

値の有効範囲:

1	-	CONSUMERS
2	-	PRODUCERS
3	-	ALL

resume (再開)

一時停止中の送信先を再開します。

戻り値:

void

引数:

なし

getMessages (メッセージ一覧の取得)

送信先に滞留しているメッセージの一覧を取得します。

戻り値:

java.lang.String[]

引数:

fromIndex - java.lang.Integer

メッセージ一覧に表示する、送信先上のメッセージの開始位置(この位置のメッセージを含みます)を指定します。

値の範囲:

1-2147483647

toIndex - java.lang.Integer

メッセージ一覧に表示する、送信先上のメッセージの終了位置(この位置のメッセージを含みます)を指定します。

値の範囲:

1-2147483647

selector - java.lang.String

メッセージ一覧のためのセレクタを指定します。

needMessageBody - java.lang.Boolean

メッセージ本体を表示するかどうかを指定します。
(既定値：false(表示しない))

purgeMessage (指定メッセージパージ)

送信先の1件のメッセージをパージします。

戻り値:

void

引数:

messageID - java.lang.String

パージ対象のメッセージIDを指定します。

purge (メッセージ全件パージ)

送信先のすべてのメッセージをパージします。

戻り値:

void

引数:

なし

listDur (永続サブスクリプションの一覧表示)

トピックの永続サブスクリプションを一覧表示します(トピックの場合のみ)。

戻り値:

java.lang.String[]

引数:

なし

purgeDur (永続サブスクリプションのメッセージパージ)

永続サブスクリプションのすべてのメッセージをパージします(トピックの場合のみ)。

戻り値:

void

引数:

durName - java.lang.String

永続サブスクリプション名を指定します。

clientId - java.lang.String

クライアントIDを指定します。

deleteDur (永続サブスクリプションの削除)

永続サブスクリプションを削除します(トピックの場合のみ)。

戻り値:

void

引数:

durName - java.lang.String

永続サブスクリプション名を指定します。

clientId - java.lang.String

クライアントIDを指定します。

getProperties (プロパティ一覧の取得)

プロパティの一覧を取得します。

戻り値:

javax.management.AttributeList

引数:

なし

setProperty (プロパティの設定)

プロパティの名前と値を設定します。

戻り値:

void

引数:

nameAndValue - javax.management.Attribute

プロパティの名前と値を指定します。

delete (削除)

JMSサーバ上の物理的な送信先を削除します。

詳細:

JMSサーバ上の物理的な送信先を削除します。削除は、JMSサーバの起動中に行う必要があります。

戻り値:

void

引数:

destinationName - java.lang.String

削除対象の送信先の名前を指定します。