名称

create-jms-resource - JMSリソースの登録

形式

create-jms-resource --user admin_user [--password admin_password] [--host host_name] [--port port_number] [--passwordfile filename] [--terse=true|false] [--echo=true|false] [--interactive=true|false] [--restype resource_type] [--enabled=true|false] [--description text] [--property (name=value) [:name=value]*] [--wojmsDestinationName destination_name] [--wojmsDestinationDescription description] [--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] [--wojmsRedeliveryDelay delay] [--wojmsPingInterval ping_interval] [--wojmsEnableSharedClientID enable_shared_clientID] [--wojmsAddressList address_list] [--wojmsAddressListBehavior behavior] [--wojmsAddressListIterations num_list_iterations] jndi_name

説明

JMSリソースを登録します。このコマンドはリモートモードでのみ使用できます。

オプション

--user

ドメインアプリケーションサーバの管理ユーザ名

--password

ドメインアプリケーションサーバの管理ユーザのパスワード

--host

ドメインアプリケーションサーバが起動しているマシン名

--port

ドメインアプリケーションサーバのポート番号(既定値：6212)

--passwordfile

ドメインアプリケーションサーバの管理ユーザのパスワードを含むファイル

--terse

trueを指定すると、出力データがスクリプトによる処理のための簡潔なデータとなります。既定値はfalseです。

--echo

trueを指定すると、標準出力でコマンドライン文が表示されます。既定値はfalseです。

--interactive

true(既定値)を指定すると、パスワードオプション入力用のプロンプトを表示します。

--restype

JMSリソースの種類はjavax.jms.Topic、 javax.jms.Queue、 javax.jms.TopicConnectionFactory、javax.jms.QueueConnectionFactory、 javax.jms.ConnectionFactoryです。

--enabled

リソースが動作中に有効化されるかどうかを決定します。既定値はtrueです。

--description

JMSリソースのテキスト記述

--property

JMSリソースを構成するための任意の属性名/値

--wojmsDestinationName

物理的な送信先の名前を指定します。この名前には、create-jmsdestコマンドで作成した送信先名を指定します。

--wojmsDestinationDescription

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

--wojmsBrokerHostName

接続するJMS サーバのホスト名を指定します (wojmsConnectionType の設定値がTCPまたはTLSの場合)。値を指定していない場合は、JMSホストのホストが使われます。

--wojmsBrokerHostPort

接続するJMS サーバのポート番号を指定しま す (wojmsConnectionTypeの設定値が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メッセージの数がこの制限に到達すると、メッセージ配信が停止 し、 wojmsConsumerFlowThresholdに指定した値を下回ると配信は再開されます。すべてのコンシューマの滞留数の合計がwojmsConnectionFlowLimitの値に到達すると、コネクションレベルの制限により配信が停止します。）既定値は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(無効)です。

--wojmsRedeliveryDelay

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

--wojmsPingInterval

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

--wojmsEnableSharedClientID

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

--wojmsAddressList

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

--wojmsAddressListBehavior

アドレスリストから、接続先を選択する方法を指定します。PRIORITY：アドレスリストに指定された順番に接続します。RANDOM：ランダムに選択します。デフォルトはRANDOMです。

--wojmsAddressListIterations

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

オペランド

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 j2ee --wojmsDefaultPassword j2ee 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 admin1 --password adminadmin1 --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)