jms-resource

概要: 操作

詳細: 操作

索引

MO名称:

jms-resource -

JMSリソース

定義:

ObjectName: {0}:type=jms-resource,name={2},category=config

CLIName: domain.resources.{2}

操作の概要

createJmsConnectionFactoryGUI (コネクションファクトリリソースの作成)

コネクションファクトリリソースを作成します。

createJmsLogicalDestinationGUI (送信先リソースの作成)

送信先リソースを作成します。

操作の詳細

createJmsConnectionFactoryGUI (コネクションファクトリリソースの作成)

コネクションファクトリリソースを作成します。

戻り値:: javax.management.ObjectName

引数:

jndiName -
    java.lang.String

: コネクションファクトリリソースのJNDI名を指定します。値を省略することはできません。

restype -
    java.lang.String

コネクションファクトリリソースのタイプを指定します。
指定できるのは、javax.jms.ConnectionFactory、javax.jms.QueueConnectionFactory、javax.jms.TopicConnectionFactoryです。

値の有効範囲:

javax.jms.ConnectionFactory	-	javax.jms.ConnectionFactory
javax.jms.QueueConnectionFactory	-	javax.jms.QueueConnectionFactory
javax.jms.TopicConnectionFactory	-	javax.jms.TopicConnectionFactory

description -
    java.lang.String

: コネクションファクトリリソースの説明を指定します。

wojmsBrokerHostName -
    java.lang.String

: 接続するJMS サーバのホスト名を指定します(「コネクションタイプ」の設定値がTCPまたはTLSの場合)。

wojmsBrokerHostPort -
    java.lang.String

: 接続するJMS サーバのポート番号を指定します(「コネクションタイプ」の設定値がTCPまたはTLSの場合)。

wojmsBrokerServicePort -
    java.lang.Integer

使用するサービスのポート番号を指定します(「コネクションタイプ」の設定値がTCPまたはTLSの場合)。この属性値は、主にファイアウォールを通過させるポート番号を特定するために使用します。

0：特定しない。

値の範囲:: 0-65535

wojmsConfiguredClientID -
    java.lang.String

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

wojmsEnableSharedClientID -
    java.lang.Boolean

: Topicで、マルチコンシューマ負荷分散や、管理環境下でのプロセス多重を利用する場合にtrue(共有する)を指定します。

true：共有する
false：共有しない

wojmsConnectionType -
    java.lang.String

使用するコネクションのタイプを指定します。

TCP：通常コネクション
TLS：SSL コネクション

値の有効範囲:

TCP	-	TCP
TLS	-	TLS

wojmsReconnectAttempts -
    java.lang.Integer

JMS サーバへの再接続試行回数を指定します。 -1は無制限です。

値の範囲:: -1,0-

wojmsReconnectEnabled -
    java.lang.Boolean

: JMSサーバへの自動再接続を有効にするかどうかを指定します。
(既定値：false(再接続しない))

wojmsReconnectInterval -
    java.lang.Integer

JMS サーバへの再接続遅延時間をミリ秒単位で指定します。
指定する時間が短すぎる場合、JMSサーバが復旧していない可能性があります。指定する時間が長すぎる場合、再接続処理が失敗したと見なされる可能性があります。

値の範囲:: -1,0-

wojmsDefaultPassword -
    java.lang.String

: JMSサーバの認証に使われる既定のパスワードを指定します。
(既定値：guest)

wojmsDefaultUsername -
    java.lang.String

: JMSサーバの認証に使われる既定のユーザ名を指定します。
(既定値：guest)

wojmsDisableSetClientID -
    java.lang.Boolean

: クライアントがJMS API（setClientID()）を使用して、クライアントID を変更できないようにします。

true：変更を許可しない
false：変更を許可する

wojmsPingInterval -
    java.lang.Integer

JMSサーバとの接続を確認する間隔を秒単位で指定します。-1は監視を行わないことを意味します。
接続監視は、JMSサーバに制御用パケット(PING)を定期的に発行して行います。

値の範囲:: -1,0,1-2147483

wojmsAckOnAcknowledge -
    java.lang.String

コンシューマからのACKNOWLEDGE(確認通知）に対して、JMSサーバが受諾通知を返すか否かを指定します。

true：返します。
false：返しません。
指定なし：AUTO_ACKNOWLEDGE/CLIENT_ACKNOWLEDGEモードの場合のみ返します。

trueを指定すると、JMSサーバはコンシューマからのすべてのACKNOWLEDGEに対して受諾通知を返すため、コンシューマはその通知を待ち合わせます。

falseを指定すると、JMSサーバはコンシューマからのどのACKNOWLEDGEに対しても受諾通知を返さないため、コンシューマはその通知を待ち合わせません。

何も指定しないと、JMSサーバはAUTO_ACKNOWLEDGEとCLIENT_ACKNOWLEDGEモードのACKNOWLEDGEに対して受諾通知を返し、コンシューマはその通知を待ち合わせます。DUPS_OK_ACKNOWLEDGEのACKNOWLEDGEに対しては受諾通知を返さず、コンシューマはその通知を待ち合わせません。

値の有効範囲:

NOT_SPECIFIED	-	指定なし
true	-	true
false	-	false

wojmsAckOnProduce -
    java.lang.String

プロデューサからのメッセージに対して、JMSサーバが受諾通知を返すか否かを指定します。

true：永続/非永続ともに返します。
false：永続/非永続ともに返しません。
指定なし：永続メッセージのみ返します。

trueの場合、JMSサーバはプロデューサから受け付けた、永続/非永続メッセージすべてに対して受諾通知を返すため、プロデューサの呼び出しスレッドはその受諾通知を待ち合わせます。

falseの場合、JMSサーバはプロデューサから受け付けた、どの永続/非永続メッセージに対しても受諾通知を返さないため、プロデューサの呼び出しスレッドはその通知を待ち合わせません。

指定なしの場合、JMSサーバはプロデューサから受け付けた、永続メッセージに対してのみ受諾通知を返すため、プロデューサの呼び出しスレッドはその通知を待ち合わせます。

値の有効範囲:

NOT_SPECIFIED	-	指定なし
true	-	true
false	-	false

wojmsAckTimeout -
    java.lang.Integer

クライアントがJMSサーバからの受諾通知を待ち合わせる、通知タイムアウトの時間（ミリ秒単位）を指定します。この時間を超過すると例外が発生します。

0：必ず待ちあわせます。

値の範囲:: 0-

wojmsConnectionFlowCount -
    java.lang.Integer

JMSサーバがクライアントランタイムに対して連続して配信できるJMSメッセージの数を指定します。
指定した数のJMSメッセージをクライアントランタイムに配信すると配信が一時的にサスペンドされ、それまで止められていた制御系のメッセージが配信されます。クライアントの状態に応じて、配信が再開されます。

0を指定すると、サスペンドされません。0以外の値を指定すると、負荷の高いJMSメッセージ配信の影響により制御系メッセージが滞留するのを防ぐことができます。

値の範囲:: 0-

wojmsConnectionFlowLimit -
    java.lang.Integer

コネクションレベルで滞留させることができるメッセージの最大数を指定します（「コネクションフロー制御を有効にする」がtrueの場合にのみ有効です）。

クライアントランタイムに配信されたJMSメッセージの数がこの制限に到達すると、メッセージ配信が停止し、制限を下回ると配信は再開されます。
この制限は、メッセージの滞留によりクライアントランタイムで発生するメモリ不足を抑止するのに有効です。

値の範囲:: 0-

wojmsConnectionFlowLimitEnabled -
    java.lang.Boolean

: コネクションレベルのフロー制御を有効にするか否かを指定します。

true：有効
false：無効

wojmsConsumerFlowLimit -
    java.lang.Integer

コンシューマレベルで滞留させることができるメッセージの最大数を指定します。
この制限は、キューのマルチコンシューマの間での負荷分散を実現するために使用します。
この制限値は、キューの「コンシューマフロー制御開始点」属性で指定した値の方が小さい場合、その値でオーバライドされます。
クライアントランタイムに配信されたJMSメッセージの数がこの制限に到達すると、メッセージ配信が停止し、「コンシューマフロー制御解除点」に指定した値を下回ると配信は再開されます。（すべてのコンシューマの滞留数の合計が「コネクションフロー制御開始点」の値に到達すると、コネクションレベルの制限により配信が停止します。）

値の範囲:: 0-

wojmsConsumerFlowThreshold -
    java.lang.Integer

コンシューマレベルのフロー制御が解除されるメッセージの数を「コンシューマフロー制御開始点」に対する割合で指定します。

値の範囲:: 0-100

wojmsJMSDeliveryMode -
    java.lang.String

配信モードを指定します。

PERSISTENT：永続
NON_PERSISTENT：非永続

値の有効範囲:

PERSISTENT	-	PERSISTENT
NON_PERSISTENT	-	NON_PERSISTENT

wojmsJMSExpiration -
    java.lang.Long

メッセージの有効期限をミリ秒単位で指定します。

0：有効期限なし。

値の範囲:: 0-

wojmsJMSPriority -
    java.lang.Integer

メッセージの優先順位を指定します。0～9 までの数字で、大きい数ほど優先度は高くなります。

値の有効範囲:

0	-	0
1	-	1
2	-	2
3	-	3
4	-	4
5	-	5
6	-	6
7	-	7
8	-	8
9	-	9

wojmsOverrideJMSDeliveryMode -
    java.lang.Boolean

: クライアントからの配信モードの変更を許可するかどうかを指定します。

true：変更を許可する
false：変更を許可しない

wojmsOverrideJMSExpiration -
    java.lang.Boolean

: クライアントからのメッセージ有効期限の変更を許可するかどうかを指定します。

true：変更を許可する
false：変更を許可しない

wojmsOverrideJMSHeadersToTemporaryDestinations -
    java.lang.Boolean

: 一時的な送信先宛てのメッセージの優先順位、有効期限、配信モードの変更を許可するかどうかを指定します。
優先順位、有効期限、配信モードの変更にはそれぞれ別途許可が必要となります。

true：変更を許可する
false：変更を許可しない

wojmsOverrideJMSPriority -
    java.lang.Boolean

: クライアントからのメッセージ優先順位の変更を許可するかどうかを指定します。

true：変更を許可する
false：変更を許可しない

wojmsSetJMSXAppID -
    java.lang.Boolean

: JMSXAppID メッセージプロパティを有効にするかどうかを指定します。

true：有効
false：無効

wojmsSetJMSXConsumerTXID -
    java.lang.Boolean

: JMSXConsumerTXID メッセージプパティを有効にするかどうかを指定します。

true：有効
false：無効

wojmsSetJMSXProducerTXID -
    java.lang.Boolean

: JMSXProducerTXID メッセージプロパティを有効にするかどうかを指定します。

true：有効
false：無効

wojmsSetJMSXRcvTimestamp -
    java.lang.Boolean

: JMSXRcvTimestamp メッセージプロパティを有効にするかどうかを指定します。

true：有効
false：無効

wojmsSetJMSXUserID -
    java.lang.Boolean

: JMSXUserID メッセージプロパティを有効にするかどうかを指定します。

true：有効
false：無効

wojmsRedeliveryDelay -
    java.lang.Integer

メッセージ再配信で、配信の遅延時間を秒単位で指定します。0は、待ち合わせ無しを意味します。

値の範囲:: 0-2147483

wojmsAddressList -
    java.lang.String

: 接続先のアドレスリストを指定します。この値を設定した場合は、「JMSサーバのホスト名」(wojmsBrokerHostName)と、「JMSサーバのホストのポート番号」(wojmsBrokerHostPort)の設定は無視されます。

アドレスの構文は、[hostName][:port]で、複数のアドレスを指定する場合は、「,」で区切ります。

wojmsAddressListBehavior -
    java.lang.String

アドレスリストから、接続先を選択する方法を指定します。

PRIORITY：アドレスリストに指定された順番
RANDOM：ランダムに選択

接続障害後の再接続は、どちらの場合も、接続がエラーになったJMSサーバに対するアドレスから始まります。

値の有効範囲:

PRIORITY	-	PRIORITY
RANDOM	-	RANDOM

wojmsAddressListIterations -
    java.lang.Integer

接続の試行を中止して例外を通知するまでの、アドレスリストの繰り返し回数を指定します。-1は無制限を意味します。

値の範囲:: -1,1-2147483647

props -
    java.util.Properties

: JMSコネクションファクトリリソースを構成するための任意の属性名/値の組を指定します。

createJmsLogicalDestinationGUI (送信先リソースの作成)

送信先リソースを作成します。

戻り値:: javax.management.ObjectName

引数:

jndiName -
    java.lang.String

: 送信先リソースのJNDI名を指定します。値を省略することはできません。

restype -
    java.lang.String

送信先リソースのタイプを指定します。
指定できるのは、javax.jms.Topicと、javax.jms.Queueです。

値の有効範囲:

javax.jms.Topic	-	javax.jms.Topic
javax.jms.Queue	-	javax.jms.Queue

wojmsDestinationName -
    java.lang.String

: 物理的な送信先の名前を指定します。
送信先名には、英数字と、「_」、「$」が使えます。先頭の文字として、数字を使うことはできません。

description -
    java.lang.String

: 送信先リソースの説明を指定します。

wojmsDestinationDescription -
    java.lang.String

: 送信先の説明を指定します。

props -
    java.util.Properties

: 送信先リソースを構成するための任意の属性名/値の組を指定します。