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(ローカル、リモートに関係なくメッセージを配信する))

supportOrderedRedelivery (再配信時の順序保証) メッセージ再配信時の順序保証を行うかどうかを指定します。(既定値：false(再配信時の順序保証はしない))

wojmsRedeliveryDelay (再配信遅延時間) 再配信遅延時間を指定します。(単位：秒、既定値：0(待ち合わせ無し))

wojmsRedeliveryLimit (再配信回数) 再配信回数を指定します。(既定値：-1(無制限))

wojmsRedeliveryDestination (不達メッセージ転送先) 不達メッセージの転送先を指定します。

操作の概要

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

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

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

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

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

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

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

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

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

sendMessage (JMSメッセージの送信) JMSメッセージを送信します。

moveMessages (メッセージ移動) 送信先のメッセージを移動します。メッセージの移動を行う場合は、あらかじめ、移動元と移動先の送信先を一時停止しておく必要があります。

updateMessagePriority (メッセージの優先順位変更) メッセージの優先順位を変更します。

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

name (送信先名)

送信先名です。

詳細:

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

型:

java.lang.String

desttype (送信先タイプ)

送信先タイプです。

詳細:

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

型:

java.lang.String

値の有効範囲:

topic	-	topic
queue	-	queue

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

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

詳細:

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

型:

java.lang.String

長さの範囲:

-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.String

長さの範囲:

-1,1-2147483647

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

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

詳細:

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

型:

java.lang.String

長さの範囲:

-1,0-2147483647

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

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

詳細:

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

型:

java.lang.String

長さの範囲:

-1,1-2147483647

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

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

詳細:

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

型:

java.lang.String

長さの範囲:

-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.String

localDeliveryPreferred (ローカル配信優先)

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

詳細:

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

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

型:

java.lang.String

supportOrderedRedelivery (再配信時の順序保証)

メッセージ再配信時の順序保証を行うかどうかを指定します。(既定値：false(再配信時の順序保証はしない))

詳細:

メッセージ再配信時の順序保証を行うかどうかを指定します。

true：再配信時の順序保証を行います。接続できるコンシューマ数は1になります。
false：再配信時の順序保証を行いません。

型:

java.lang.String

wojmsRedeliveryDelay (再配信遅延時間)

再配信遅延時間を指定します。(単位：秒、既定値：0(待ち合わせ無し))

詳細:

メッセージ再配信で、配信の遅延時間を指定します。0は、待ち合わせ無しを意味します。この設定は、JMSサービスの設定より優先されます。

型:

java.lang.String

長さの範囲:

0-2147483

wojmsRedeliveryLimit (再配信回数)

再配信回数を指定します。(既定値：-1(無制限))

詳細:

メッセージ再配信回数の上限を指定します。-1は無制限を、0は再配信なしを意味します。この設定は、JMSサービスの設定より優先されます。

型:

java.lang.String

長さの範囲:

-1,0-

wojmsRedeliveryDestination (不達メッセージ転送先)

不達メッセージの転送先を指定します。

詳細:

再配信回数を超過したメッセージを転送する送信先名を指定します。ここに指定する送信先は、あらかじめ作成しておく必要があります(自動的に作成されません)。この設定は、JMSサービスの設定より優先されます。

型:

java.lang.String

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を指定します。

sendMessage (JMSメッセージの送信)

JMSメッセージを送信します。

戻り値:

void

引数:

msgtype - java.lang.String

送信メッセージのタイプを指定します。

TextMessage : メッセージボディにStringを含むものです。
Message : メッセージボディのない軽量なメッセージです。
BytesMessage : メッセージボディにバイト配列を含むものです。

値の有効範囲:

TextMessage

Message

BytesMessage

bodyType - java.lang.String

メッセージボディの指定方法を指定します。

text : メッセージボディに指定された文字列をボディそのものとして設定します。
file : メッセージボディに指定された文字列をファイル名として、指定されたファイルの内容をメッセージボディに設定します。

値の有効範囲:

text

file

body - java.lang.String

メッセージボディを指定します。

TextMessage : メッセージボディタイプがtextのときは、指定された文字列をボディそのものとして設定し、fileのときは指定された文字列をファイル名として、指定されたファイルの内容をメッセージボディに設定します。
Message : メッセージボディはありません。指定されていても無視します。
BytesMessage : メッセージボディタイプはfileのみ有効です。指定されたファイルの内容をバイト配列に変換して設定します。

useLocalTransaction - java.lang.Boolean

ローカルトランザクションでメッセージを送信するかどうかを指定します。

deliveryMode - java.lang.String

JMSDeliveryModeヘッダの値です。メッセージを永続化するかどうかを指定します。

PERSISTENT : 永続
NON_PERSISTENT : 非永続

値の有効範囲:

PERSISTENT

NON_PERSISTENT

expiration - java.lang.Long

JMSExpirationヘッダの値です。メッセージの有効期限を指定します。0は有効期限がなく、破棄されません。

値の範囲:

0-9223372036854775807

priority - java.lang.Integer

JMSPriorityヘッダの値。メッセージの優先順位(0-9)を指定します。最も低い優先度が0で、最も高い優先度が9です。

値の有効範囲:

0
1
2
3
4
5
6
7
8
9

correlationID - java.lang.String

JMSCorrelationIDヘッダの値。メッセージを別のメッセージとリンクする場合のIDを指定します。指定できるのは、文字列のみです。

replyTo - java.lang.String

JMSReplyToヘッダの値。応答用送信先(メッセージを受信したコンシューマが返信する送信先)を指定します。

replyToType - java.lang.String

応答用送信先のタイプを指定します。(既定値：queue)

値の有効範囲:

queue

topic

jmstype - java.lang.String

JMSTypeヘッダの値を指定します。

delayTime - java.lang.Integer

配信遅延時間を指定します。WebOTX JMS固有の拡張機能で、相対時間(秒)での指定のみ可能です。

値の範囲:

0-2147483

properties - java.util.Properties

メッセージプロパティです。<プロパティ名>=<値>の形式で指定します。設定可能なプロパティ値は、Stringのみです。

moveMessages (メッセージ移動)

送信先のメッセージを移動します。メッセージの移動を行う場合は、あらかじめ、移動元と移動先の送信先を一時停止しておく必要があります。

戻り値:

java.lang.String[]

引数:

moveType - java.lang.String

移動元がQueueの場合に、移動対象とするメッセージタイプを指定します。移動元がTopicの場合は無視されます。

通常メッセージ(normal) ： 通常メッセージが移動対象になります。
不達メッセージ(redeliver) ： 不達メッセージが移動対象になります。元の送信先に戻して、再度配信したいような場合に利用します。
有効期限切れメッセージ(expired) ： 有効期限切れメッセージが移動対象になります。

値の有効範囲:

normal	-	通常メッセージ
redelivery	-	不達メッセージ
expired	-	有効期限切れメッセージ

durName - java.lang.String

移動元の永続サブスクリプション名を指定します。移動元がTopicの場合は指定が必要です。

clientId - java.lang.String

移動元のクライアントIDを指定します。移動元がTopicの場合は指定が必要です。

toDest - java.lang.String

メッセージの移動先となる送信先を指定します。移動対象が不達メッセージの場合は、元の送信先を選択します。

selector - java.lang.String

移動対象メッセージを抽出するためのセレクタを指定します。移動元がQueueの場合のみ有効です。Topicの場合は無視されます。

originalDest - java.lang.String

メッセージの移動対象が、不達メッセージ、または、有効期限切れメッセージの場合に、どの送信先から転送されたメッセージを対象とするかを指定します。省略した場合は、移動先と同じです。
「*」を指定した場合は、すべての送信先が対象となります。

updateMessagePriority (メッセージの優先順位変更)

メッセージの優先順位を変更します。

詳細:

送信先に滞留しているメッセージの優先順位を変更します。クライアントに事前配信されたメッセージは対象外です。

戻り値:

void

引数:

messageID - java.lang.String

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

priority - java.lang.Integer

優先順位を指定します。

値の有効範囲:

0
1
2
3
4
5
6
7
8
9

delete (削除)

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

詳細:

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

戻り値:

void

引数:

destinationName - java.lang.String

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