名称
create-jms-resource - JMSリソースの登録
形式
create-jms-resource [ --user admin_user ] [ --password
admin_password ] [ --host host_name ] [ --port port_number
] [ --protocol=rmi|jmxmp ] [ --passwordfile filename ] [
--encrypted=true|false ] [ --terse=true|false ] [ --
echo=true|false ] [ --interactive=true|false ] [ --
secure=true|false ] [ --legacy=true|false ] [ --help ] -
-restype type [ --enabled=true ] [ --description text ] [
--cascade=true|false ] [ --property
name=value[:name=value]* ] [ --wojmsDestinationName
destination_name ] [ --wojmsDestinationDescription descrip-
tion ] [ --wojmsBrokerHostName host_name ] [ --
wojmsBrokerHostPort host_port ] [ --wojmsBrokerServicePort
port_number ] [ --wojmsConfiguredClientID client_id ] [
--wojmsConnectionType connection_type ] [ --
wojmsReconnectAttempts reconnect_attempts ] [ --
wojmsReconnectEnabled=true|false ] [ --
wojmsReconnectInterval reconnect_interval ] [ --
wojmsDefaultPassword password ] [ --wojmsDefaultUsername
user-name ] [ --wojmsDisableSetClientID=true|false ] [ --
wojmsAckOnAcknowledge=true|false ] [ --
wojmsAckOnProduce=true|false ] [ --wojmsAckTimeout
ack_timeout ] [ --wojmsConnectionFlowCount flow_count ] [
--wojmsConnectionFlowLimit flow_limit ] [ --
wojmsConnectionFlowLimitEnabled=true|false ] [ --
wojmsConsumerFlowLimit flow_limit ] [ --
wojmsConsumerFlowThreshold threshold ] [ --
wojmsJMSDeliveryMode delivery_mode ] [ --wojmsJMSExpiration
expiration ] [ --wojmsJMSPriority priority ] [ --
wojmsOverrideJMSDeliveryMode=true|false ] [ --
wojmsOverrideJMSExpiration=true|false ] [ --
wojmsOverrideJMSHeadersToTemporaryDestinations=true|false ]
[ --wojmsOverrideJMSPriority=true|false ] [ --
wojmsSetJMSXAppID=true|false ] [ --
wojmsSetJMSXConsumerTXID=true|false ] [ --
wojmsSetJMSXProducerTXID=true|false ] [ --
wojmsSetJMSXRcvTimestamp=true|false ] [ --
wojmsSetJMSXUserID=true|false ] [ --
wojmsSetJMSXDeliveryCount=true|false ] [ --
wojmsRedeliveryDelay delay ] [ --wojmsPingInterval
ping_interval ] [ --wojmsEnableSharedClientID
enable_shared_clientID ] [ --wojmsAddressList address_list
] [ --wojmsAddressListBehavior behavior ] [ --
wojmsAddressListIterations num_list_iterations ] [ --
wojmsSocketConnectTimeout connect_timeout ] [ --
wojmsPortMapperSoTimeout so_timeout ] jndi_name
説明
JMSリソースを登録します。このコマンドはリモートモードでの み
使用できます。
オプション
-u --user
ドメインの運用管理エージェントの管理ユーザ名。
既にotxadmin loginコマンドでログインしている場 合 は、
--userオプションの指定は不要です。
-w --password
ドメインの運用管理エージェントの管理ユーザのパ ス ワー
ド。
-H --host
ドメインの運用管理エージェントが起動しているマシン名。
-p --port
ドメインの運用管理エージェントのポート番号。既定 値 は
6212です。
--protocol
ドメインの運用管理エージェントとの接続プロトコルを選択
します。指定できるプロトコルは、rmi、jmxmpです。既定値
はrmiです。
-W --passwordfile
ドメインの運用管理エージェントのパスワードを含むファイ
ル。
--encrypted
ドメインの運用管理エージェントのパスワードに暗号化され
た パスワードを利用する場合に指定します。既定値はfalse
です。暗号化されたパスワードの生成にはencryptコマン ド
を 使 用してください。このオプションはpasswordfileオプ
ションが指定されている場合のみ有効です。
-t --terse
trueを指定すると、出力データがスクリプトによる処理のた
めの簡潔なデータとなります。既定値はfalseです。
-e --echo
trueを指定すると、標準出力でコマンドライン文が表示され
ます。既定値はfalseです。
-I --interactive
true(既定値)を指定すると、パスワードオプション入力用の
プロンプトを表示します。
-s --secure
trueを指定すると、ドメインの運用管理エージェントとの通
信にSSL/TLSを利用します。既定値はfalseです。
--legacy
trueを指定すると、コマンドの接続先のサーバがV8か、V9か
確認します。確認後V8であれば旧互換動作を行い、V9であれ
ばV9の動作を行います。falseの場合は接続先のサーバを 確
認せずにV9の動作を行います。既定値はfalseです。
--help
コマンドのヘルプを表示します。
--restype
JMSリソースの種類はjavax.jms.Topic、 javax.jms.Queue、
javax.jms.TopicConnectionFactory、
javax.jms.QueueConnectionFactory、
javax.jms.ConnectionFactoryです。
--enabled
リソースが動作中に有効化されるかどうかを決定します。既
定値はtrueです。
--description
JMSリソースのテキスト記述
--property
JMSリソースを構成するための任意の属性名/値
--cascade
物理的な送信先を同時に生成するかどうかを指定し ま す。
trueはwojmsDestinationNameオプションで指定された名前の
物理的な送信先を生成します。生成される送信先の属性はす
べて既定値となります。指定された名前の物理的な送信先が
既に存在している場合は生成しません。既定値はfalse(生成
しない)です。
--wojmsDestinationName
物理的な送信先の名前を指定します。 こ の 名 前 に は、
create-jmsdestコマンドで作成した送信先名を指定します。
--wojmsDestinationDescription
送信先の説明を指定します。
--wojmsBrokerHostName
接続するJMS サーバのホスト名を指定します (wojmsConnec-
tionType の設定値がTCPまたはTLSの場合)。値を指定してい
ない場合は、JMSホストのホストが使われます。
--wojmsBrokerHostPort
接続するJMS サーバのポート番号を指定しま す (wojmsCon-
nectionTypeの設定値がTCPまたはTLSの場合)。値を指定して
いない場合は、JMSホストのポート番号が使われます。
--wojmsBrokerServicePort
使用する サー ビ ス の ポー ト 番 号 を 指 定 し ま す
(wojmsConnectionType の設定値がTCPまたはTLSの場合)。こ
の属性値は、主にファイアウォールを通過させるポート番号
を 特定するために使用します。0は特定しません。デフォル
ト値は0です。
--wojmsConfiguredClientID
クライアントID を指定します。
--wojmsConnectionType
使用するコネクションのタイプを指定します。TCPは通常 コ
ネクションです。TLSはSSL コネクションです。既定値はTCP
です。
--wojmsReconnectAttempts
JMS サーバへの再接続試行回数を指定します。-1は無制限で
す。既定値は0です。
--wojmsReconnectEnabled
JMS サーバへの再接続を有効にするかどうかを指定します。
既定値はfalseです。
--wojmsReconnectInterval
JMS サーバへの再接続遅延時間をミリ秒単位で指定します。
指 定する時間が短すぎる場合、JMSサーバが復旧していない
可能性があります。指定する時間が長すぎる場合、再接続処
理が失敗したと見なされる可能性があります。既定値は3000
（ミリ秒）です。
--wojmsDefaultPassword
JMSサーバの認証に使われるデフォルトのパスワードを指 定
します。既定値はguestです。
--wojmsDefaultUsername
JMSサーバの認証に使われるデフォルトのユーザ名を指定 し
ます。既定値はguestです。
--wojmsDisableSetClientID
クライアントがJMS API（setClientID()）を使用して、クラ
イアントID を変更できないよう指定します。既定値はfalse
です。
--wojmsAckOnAcknowledge
コンシューマからのACKNOWLEDGE(確認通知）に対して、 JMS
サーバが受諾通知を返すか否かを指定します。trueを指定す
ると、JMSサーバはコンシューマからのすべてのACKNOWLEDGE
に対して受諾通知を返すため、コンシューマはその通知を待
ち合わせます。falseを指定すると、JMSサーバはコンシュー
マ からのどのACKNOWLEDGEに対しても受諾通知を返さないた
め、コンシューマはその通知を待ち合わせません。何も指定
し な い と、 JMS サー バ は AUTO_ACKNOWLEDGE と
CLIENT_ACKNOWLEDGEモードのACKNOWLEDGEに対して受諾通 知
を 返 し、 コ ン シュー マはその通知を待ち合わせます。
DUPS_OK_ACKNOWLEDGEのACKNOWLEDGEに対しては受諾通知を返
さず、コンシューマはその通知を待ち合わせません。既定値
は指定なしです。
--wojmsAckOnProduce
プロデューサからのメッセージに対して、JMSサーバが受 諾
通 知を返すか否かを指定します。trueの場合、JMSサーバは
プロデューサから受け付けた、永続/非永続メッセージす べ
てに対して受諾通知を返すため、プロデューサの呼び出しス
レッドはその受諾通知を待ち合わせます。falseの場合、JMS
サー バ は プロデューサから受け付けた、どの永続/非永続
メッセージに対しても受諾通知を返さないため、プロデュー
サの呼び出しスレッドはその通知を待ち合わせません。指定
なしの場合、JMSサーバはプロデューサから受け付けた、 永
続メッセージに対してのみ受諾通知を返すため、プロデュー
サの呼び出しスレッドはその通知を待ち合わせます。既定値
は指定なしです。
--wojmsAckTimeout
クライアントがJMSサーバからの受諾通知を待ち合わせ る、
通知タイムアウトの時間（ミリ秒単位）を指定します。この
時間を超過すると例外が発生します。0を指定すると、必 ず
待ちあわせます。既定値は0です。
--wojmsConnectionFlowCount
JMSサーバがクライアントランタイムに対して連続して配 信
で き るJMSメッセージの数を指定します。指定した数のJMS
メッセージをクライアントランタイムに配信すると配信が一
時 的 にサスペンドされ、それまで止められていた制御系の
メッセージが配信されます。クライアントの状態に応じて、
配 信が再開されます。0を指定すると、サスペンドされませ
ん。0以外の値を指定すると、負荷の高いJMSメッセージ配信
の 影 響により制御系メッセージが滞留を防ぐことができま
す。既定値は100です。
--wojmsConnectionFlowLimit
コネクションレベルで滞留させることができるメッセージの
最 大数を指定します。（wojmsConnectionFlowLimitEnabled
がtrueの場合にのみ有効）クライアントランタイムに配信さ
れ たJMSメッセージの数がこの制限に到達すると、メッセー
ジ配信が停止し、制限を下回ると配信は再開されます。この
制限は、メッセージの滞留によりクライアントランタイムで
発生するメモリ不足を抑止するのに有効です。既定値は1000
です。
--wojmsConnectionFlowLimitEnabled
コネクションレベルのフロー制御を有効にするか否かを指定
し ます。trueは有効にします。falseは無効にします。既定
値はfalse(無効)です。
--wojmsConsumerFlowLimit
コンシューマレベルで滞留させることができるメッセージの
最 大 数 を 指 定します。この制限は、queueのマルチコン
シューマの間での負荷分散を実現するために使用します。こ
の制限値は、queueのconsumerFlowLimit属性で指定した値の
方が小さい場合、その値でオーバライドされます。クライア
ン トランタイムに配信されたJMSメッセージの数がこの制限
に到達すると、メッセージ配信が停止 し、 wojmsConsumer-
FlowThreshold に 指 定した値を下回ると配信は再開されま
す。（すべてのコンシューマの滞留数の合計がwojmsConnec-
tionFlowLimit の値に到達すると、コネクションレベルの制
限により配信が停止します。）既定値は1000です。
--wojmsConsumerFlowThreshold
コンシューマレベルのフロー制御が解除されるメッセージの
数をwojmsConsumerFlowLimitに対する割合で指定します。既
定値は50(%)です。
--wojmsJMSDeliveryMode
配信モードを指定し ま す。 PERSISTENT は 永 続 で す。
NON_PERSISTENTは非永続です。既定値は、PERSISTENT（永続
)です。
--wojmsJMSExpiration
メッセージの有効期限をミリ秒単位で指定します。0は破 棄
されません。既定値は0(破棄されない)です。
--wojmsJMSPriority
メッセージの優先順位を指定します。0〜9 までの数字で 大
きい数程優先度は高くなります。既定値は4です。
--wojmsOverrideJMSDeliveryMode
クライアントからの配信モードの変更を許可するかどうかを
指 定します。trueは変更を許可します。falseは変更を許可
しません。既定値は、false(許可しない)です。
--wojmsOverrideJMSExpiration
クライアントからのメッセージ有効期限の変更を許可するか
ど うかを指定します。trueは変更を許可します。falseは変
更を許可しません。既定値はfalse(変更を許可しな い ) で
す。
--wojmsOverrideJMSHeadersToTemporaryDestinations
一時的な送信先宛てのメッセージの優先順位、有効期限、配
信 モー ドの変更を許可するかどうかを指定します。優先順
位、有効期限、配信モードの変更にはそれぞれ別途許可が必
要 となります。trueは変更を許可します。falseは変更を許
可します。既定値は、false(変更を許可しない)です。
--wojmsOverrideJMSPriority
クライアントからのメッセージ優先順位の変更を許可するか
ど うかを指定します。trurは変更を許可します。falseは変
更を許可しません。既定値はfalse(変更を許可しな い ) で
す。
--wojmsSetJMSXAppID
JMSXAppID メッセージプロパティを有効にするかどうかを指
定 し ま す。trueは有効になります。falseは無効になりま
す。既定値はfalse(無効)です。
--wojmsSetJMSXConsumerTXID
JMSXConsumerTXID メッセージプパティを有効にするかど う
か を指定します。trueは有効になります。falseは無効にな
ります。既定値はfalse(無効)です。
--wojmsSetJMSXProducerTXID
JMSXProducerTXID メッセージプロパティを有効にするか ど
う かを指定します。trueは有効になります。falseは無効に
なります。既定値はfalse(無効)です。
--wojmsSetJMSXRcvTimestamp
JMSXRcvTimestamp メッセージプロパティを有効にするか ど
う かを指定します。trueは有効になります。falseは無効に
なります。既定値はfalse(無効)です。
--wojmsSetJMSXUserID
JMSXUserID メッセージプロパティを有効にするかどうか を
指 定します。trueは有効になります。falseは無効になりま
す。既定値はfalse(無効)です。
--wojmsSetJMSXDeliveryCount
JMSXDeliveryCount メッセージプロパティを有効にするかど
う かを指定します。trueは有効になります。falseは無効に
なります。既定値はfalse(無効)です。
--wojmsRedeliveryDelay
メッセージ再配信で、配信の遅延時間を秒単位で指定 し ま
す。 0は、待ち合わせ無しを意味します。既定値は、0(待ち
合わせ無し)です。
--wojmsPingInterval
JMSサーバとの接続を確認する間隔を秒単位で指定しま す。
-1 は 監 視を行わないことを意味します。接続監視は、JMS
サーバに制御用パケット(PING)を定期的に発行して行 い ま
す。デフォルト値は30(秒)です。
--wojmsEnableSharedClientID
Topicで、マルチコンシューマ負荷分散や、管理環境下で の
プ ロ セス多重を利用する場合にtrue(共有する)を指定しま
す。デフォルト値はfalse(共有しない)です。
--wojmsAddressList
接続先のアドレスリストを指定します。この値を設定した場
合は、「JMSサーバのホスト名」(wojmsBrokerHostName)と、
「JMSサーバのホストのポート番号」(wojmsBrokerHostPort)
の設定は無視されます。
--wojmsAddressListBehavior
アドレスリストから、接続先を選択する方法を指定します。
PRIORITY：アドレスリストに指定された順番に接続します。
RANDOM：ランダムに選択します。デフォルトは PRIORITY で
す。
--wojmsAddressListIterations
接続の試行を中止して例外を通知するまでの、アドレスリス
トの繰り返し回数を指定します。-1は無制限を意味します。
--wojmsSocketConnectTimeout
JMSサーバへのTCPコネクションを確立するときのタイムアウ
ト時間をミリ秒単位で指定します。0 はタイムアウト無しを
意味します。
--wojmsPortMapperSoTimeout
JMSサーバとのコネクション確立処理中に、JMSサーバからの
応答を待機する時間をミリ秒単位で指定します。この値は、
JMSサーバとの接続に関連付けられ て い る ソ ケッ ト の
SO_TIMEOUTとして設定されます。-1は、SO_TIMEOUTを設定し
ません。0 はタイムアウト無しを意味します。
オペランド
jndi_name
作成されるJMSリソースのJNDI名
使用例
例1: JMSトピックコネクションファクトリリソースを作成す
る
otxadmin> create-jms-resource --user admin
--password adminadmin --host bluestar --port 6212
--restype javax.jms.TopicConnectionFactory --description
"example of creating a JMS Topic connection factory"
--wojmsDefaultUsername javaee --wojmsDefaultPassword javaee
jms/TopicConnectionFactory
Command create-jms-resource executed successfully
jms/TopicConnectionFactoryはリソースのJNDI名であり、wojmsDe-
faultUsername とwojmsDefaultPasswordオプションはコネクション
ファクトリに必要なユーザ名／パスワードを設定しま す。 JMS リ
ソー スに対するJNDI名は慣習的にjms/ namingサブコンテクストを
含みます。
例2: 永続的な予約としてJMSコネクションファクトリリソー
スを作成する
otxadmin> create-jms-resource --user admin
--password adminadmin --host bluestar --port 6212
--restype javax.jms.TopicConnectionFactory --description
"example of creating a JMS connection factory"
--wojmsConfiguredClientID MyID jms/DurableTopicConnectionFactory
Command create-jms-resource executed successfully
jms/DurableTopicConnectionFactoryはリソースのJNDI名であ り、
wojmsConfiguredClientID オプションはコネクションファクトリに
永続的な予約として使用されるようにクライアントIDを設定 し ま
す。JMSリソースに対するJNDI名は慣習的にjms/ namingサブコンテ
クストを含みます。
例3: JMS送信先リソースの使用法
otxadmin> create-jms-resource --user admin
--password adminadmin --host host_name --port 6212
--restype javax.jms.Queue
--wojmsDestinationName MyPhysicalQueue
--wojmsDestinationDescription "This is sample queue"
jms/MyQueue
Command create-jms-resource executed successfully
jms/MyQueueはリソースのJNDI名であり、wojmsDestinationName オ
プションはリソースが参照する（create-jmsdestコマンドで生成し
た）物理的な送信先を指定します。 wojmsDestinationDescription
オプションは物理的な送信先に関する説明を指定します。
終了ステータス
0 コマンド実行成功
1 コマンド実行失敗
関連事項
delete-jms-resource(1) list-jms-resources(1) create-jmsdest(1)