Sun Java System Message Queue 3.7 UR1 管理ガイド

パート III リファレンス

第 13 章コマンド行のリファレンス

この章では、 Message Queue^TM のコマンド行管理ユーティリティーの使い方に関する参照情報を提供します。この章は、次の節から構成されています。

コマンド行の構文

Message Queue のコマンド行ユーティリティーはシェルコマンドです。ユーティリティーの名前はコマンドであり、そのサブコマンドやオプションは、そのコマンドに渡される引数です。ユーティリティーを開始または終了するためのコマンドは別途必要ありません。

コマンド行ユーティリティーはすべて、次のコマンド構文を共有します。

   utilityName [subcommand] [commandArgument] [ [-optionName [optionArgument]] … ]

utilityName は、次のいずれかになります。

imqbrokerd (ブローカユーティリティー)
imqcmd (コマンドユーティリティー)
imqobjmgr (オブジェクトマネージャーユーティリティー)
imqdbmgr (データベースマネージャーユーティリティー)
imqusermgr (ユーザーマネージャーユーティリティー)
imqsvcadmin (サービス管理ユーティリティー)
imqkeytool (キーツールユーティリティー)

サブコマンドおよびコマンドレベル引数を指定する場合は、すべてのオプションとそれらの引数の前に指定する必要があります。オプションは任意の順序で指定できます。サブコマンド、コマンドの引数、オプション、およびオプションの引数はすべて、スペースで区切ります。オプションの引数の値にスペースが含まれる場合は、値全体を引用符で囲む必要があります。属性と値の組み合わせは、通常、引用符で囲んでおきます。

デフォルトブローカを起動する次のコマンドは、サブコマンド節がないコマンド行の例です。

   imqbrokerd

次のコマンドは、より多くの項目を含む例です。

   imqcmd  destroy dst  -t q  -n myQueue  -u admin  -f  -s

このコマンドでは、myQueue という名前のキュー送信先 (送信先タイプ q) が破棄されます。認証はユーザー名 admin で実行され、コマンドによってパスワードが要求されます。確認の要求はされず (-f オプション)、出力を表示しないサイレントモードで実行されます (-s オプション)。

ブローカユーティリティー

ブローカユーティリティー (imqbrokerd) では、ブローカを起動します。コマンド行オプションは、ブローカ設定ファイルの値を上書きします。ただし、上書きの対象は現在のブローカセッションだけです。

表 13–1 に、imqbrokerd コマンドのオプションと、各オプションによって上書きされる設定プロパティー (ある場合) を示します。

表 13–1 ブローカユーティリティーのオプション


オプション	上書きされるプロパティー	説明
`-name` `instanceName`	`imq.instancename`	ブローカのインスタンス名同じホスト上で実行される複数のブローカインスタンスには、異なるインスタンス名を割り当てる必要があります。デフォルト値: `imqbroker`
`-port` `portNumber`	`imq.portmapper.port`	ブローカのポートマッパーのポート番号 Message Queue クライアントは、このポート番号を使用してブローカに接続します。同じホスト上で実行される複数のブローカインスタンスには、異なるポートマッパーのポート番号を割り当てる必要があります。デフォルト値: `7676`
`-cluster` `broker1` [ [ `,` `broker2` ] … ]	`imq.cluster.brokerlist`	ブローカを接続してクラスタを形成します [ブローカクラスタに対してのみ適用します] 指定したブローカは、`imq.cluster.brokerlist` プロパティーのリストとマージされます。各ブローカの引数は、次のいずれかの形式になります。 `hostName:` `portNumber` `hostName` `:portNumber` `hostName` を省略した場合、デフォルト値は `localhost` になります。`portNumber` を省略した場合、デフォルト値は `7676` になります。
`-Dproperty=` `value`	インスタンス設定ファイル内の対応するプロパティー	設定プロパティーを設定しますブローカ設定プロパティーについては、第 14 章「ブローカのプロパティーのリファレンス」を参照してください。注: このオプションを使用してプロパティーを設定するときは、スペルと形式をよく確認してください。誤りのある値は無視され、通知や警告は表示されません。
`-reset props`	なし	設定プロパティーをリセットしますブローカの既存のインスタンス設定ファイル `config.properties` を空のファイルに置き換えます。すべてのプロパティーがデフォルト値になります。
`-reset store`	なし	持続データストアをリセットします持続メッセージ、永続サブスクリプション、およびトランザクション情報を含むすべての持続データをデータストアから消去します。これにより、ブローカインスタンスを新規の状態で起動できます。その後の再起動時に持続ストアがリセットされないようにするには、`-reset` オプションを付けずにブローカインスタンスを再起動します。持続メッセージまたは永続サブスクリプションだけを消去するには、代わりに `-reset` `messages` または `-reset` `durables` を使用します。
`-reset messages`	なし	データストアから持続メッセージを消去します
`-reset durables`	なし	データストアから永続サブスクリプションを消去します
`-backup` `fileName`	なし	設定変更レコードをファイルにバックアップします詳細については、「設定変更レコードの管理」を参照してください。
`-restore` `fileName`	なし	設定変更レコードをバックアップファイルから復元しますバックアップファイルは、`-backup` オプションを使用してあらかじめ作成しておく必要があります。詳細については、「設定変更レコードの管理」を参照してください。
`-remove instance`	なし	ブローカインスタンスを削除します [`-force` を一緒に指定しないかぎり、ユーザーの確認が求められます。] インスタンスに関連付けられたインスタンス設定ファイル、ログファイル、持続ストア、およびその他のファイルとディレクトリを削除します。
`-password` `keyPassword`	`imq.keystore.password`	SSL 証明書キーストアのパスワード [このオプションは異論が多く、最終的には削除される予定です。パスワードを省略して、ユーザーがインタラクティブにパスワードが要求されるようにするか、または `-passfile` オプションを使用して、パスワードが含まれるパスワードファイルを指定します。]
`-dbuser` `userName`	`imq.persist.jdbc.user`	JDBC ベースの持続データストアのユーザー名
`-dbpassword` `dbPassword`	`imq.persist.jdbc.password`	JDBC ベースの持続データストアのパスワード
`-ldappassword` `ldapPassword`	`imq.user_repository.ldap.password`	LDAP ユーザーリポジトリのパスワード
`-passfile` `filePath`	`imq.passfile.enabledimq.passfile.dirpathimq.passfile.name`	パスワードファイルの場所ブローカの `imq.passfile.enabled` プロパティーを `true` に設定し、`imq.passfile.dirpath` をパスワードファイルを含むパスに設定し、`imq.passfile.name` をファイル名自体に設定します。詳細については、「パスワードファイル」を参照してください。
`-shared`	`imq.jms.threadpool_model`	共有スレッドプールモデルを使用して `jms` 接続サービスを実装します。実行スレッドが接続間で共有されるため、サポートされる接続数が増えます。ブローカの `imq.jms.threadpool_model` プロパティーを `shared` に設定します。
`-javahome` `path`	なし	代替 Java ランタイムの場所デフォルトの動作: システムにインストールされているランタイム、または Message Queue にバンドルされているランタイムが使用されます。
`-vmargs` `arg1` [ [ `arg2` ] … ]	なし	Java 仮想マシンに引数を渡します引数はスペースで区切ります。複数の引数またはスペースを含む引数を渡すには、引数のリストを引用符で囲みます。 VM 引数は、コマンド行からのみ渡すことができます。インスタンス設定ファイルには、関連する設定プロパティーはありません。
`-license` [ `licenseName` ]	なし	インストール済み Message Queue 製品エディションのデフォルトとは異なるライセンスを使用する場合に読み込むライセンス `pe`: 基本機能を備えた Platform Edition `try`: 企業向け機能 (90 日間のトライアル) を備えた Platform Edition `unl`: Enterprise Edition ライセンス名を指定しない場合は、システムにインストールされているすべてのライセンスが一覧表示されます。
`-upgrade-store-nobackup`	なし	非互換バージョンから Message Queue 3.5 または 3.5 SP`x` にアップグレードするときに、古いデータストアを自動的に削除します詳細については、『Message Queue Installation Guide』を参照してください。
`-force`	なし	ユーザーの確認なしでアクションを実行しますこのオプションは、通常は確認が必要な `-remove` `instance` および `-upgrade-store-nobackup` オプションのみに適用されます。
`-loglevel` `level`	`imq.broker.log.level`	ロギングレベル `NONE` `ERROR` `WARNING` `INFO` デフォルト値: `INFO`
`-metrics` `interval`	`imq.metrics.interval`	ブローカのメトリックスのロギング間隔 (秒単位)
`-tty`	`imq.log.console.output`	コンソールにすべてのメッセージをログ出力しますブローカの `imq.log.console.output` プロパティーを `ALL` に設定します。指定しない場合は、エラーおよび警告メッセージだけがログ出力されます。
`-s` \| `-silent`	`imq.log.console.output`	サイレントモード (コンソールへのログ出力なし) ブローカの `imq.log.console.output` プロパティーを `NONE` に設定します。
`-version`	なし	バージョン情報を表示します [コマンド行に指定したその他のオプションはすべて無視されます。]
`-h` \| `-help`	なし	使用方法に関するヘルプを表示します

コマンドユーティリティー

コマンドユーティリティー (imqcmd) は、ブローカ、接続サービス、接続、物理的送信先、永続サブスクリプション、およびトランザクションの管理に使用します。

製品のバージョン情報または使用方法に関するヘルプを表示するための -v または -h オプションを使用する場合を除き、すべての imqcmd コマンドでサブコマンドを指定する必要があります。使用可能なサブコマンドのリストを次に示し、それらの詳細を以下の対応する節で説明します。サブコマンドがブローカアドレス (-b オプション) を受け付ける場合、ホスト名またはポート番号を指定しないときは常に、値はデフォルトで localhost および 7676 になります。

「ブローカ管理」
`shutdown bkr`	ブローカをシャットダウンします
`restart bkr`	ブローカを再起動します
`pause bkr`	ブローカを停止します
`resume bkr`	ブローカを再開します
`update bkr`	ブローカのプロパティーを設定します
`reload cls`	クラスタ設定を再読み込みします
`query bkr`	ブローカのプロパティー値を一覧表示します
`metrics bkr`	ブローカのメトリックスを表示します
「接続サービス管理」
`pause svc`	接続サービスを停止します
`resume svc`	接続サービスを再開します
`update svc`	接続サービスのプロパティーを設定します
`list svc`	ブローカで使用可能な接続サービスを一覧表示します
`query svc`	接続サービスのプロパティー値を一覧表示します
`metrics svc`	接続サービスのメトリックスを表示します
「接続管理」
`list cxn`	ブローカ上の接続を一覧表示します
`query cxn`	接続情報を表示します
「物理的送信先管理」
`create dst`	物理的送信先を作成します
`destroy dst`	物理的送信先を破棄します
`pause dst`	物理的送信先のメッセージ配信を停止します
`resume dst`	物理的送信先のメッセージ配信を再開します
`update dst`	物理的送信先のプロパティーを設定します
`purge dst`	物理的送信先からすべてのメッセージを消去します
`compact dst`	物理的送信先を圧縮します
`list dst`	物理的送信先を一覧表示します
`query dst`	物理的送信先のプロパティー値を一覧表示します
`metrics dst`	物理的送信先のメトリックスを表示します
「永続サブスクリプション管理」
`destroy dur`	永続サブスクリプションを破棄します
`purge dur`	永続サブスクリプションのすべてのメッセージを消去します
`list dur`	トピックの永続サブスクリプションを一覧表示します
「トランザクション管理」
`commit txn`	トランザクションをコミットします
`rollback txn`	トランザクションをロールバックします
`list txn`	ブローカが追跡しているトランザクションを一覧表示します
`query txn`	トランザクション情報を表示します

ブローカ管理

コマンドユーティリティーではブローカを起動できません。代わりにブローカユーティリティー (imqbrokerd) を使用します。ブローカの起動後は、表 13–2 に示す imqcmd サブコマンドを使用して、ブローカを管理および制御できます。

表 13–2 ブローカ管理のためのコマンドユーティリティーサブコマンド


構文	説明
`shutdown bkr` [`-b` `hostName` `:portNumber`]	ブローカをシャットダウンします
`restart bkr` [`-b` `hostName` `:portNumber`]	ブローカを再起動しますブローカをシャットダウンしてから、そのブローカの起動時に指定されたオプションを使用して再起動します。
`pause bkr` [`-b` `hostName` `:portNumber`]	ブローカを停止します詳細については、「ブローカの停止」を参照してください。
`resume bkr` [`-b` `hostName` `:portNumber`]	ブローカを再開します
`update bkr` [`-b` `hostName` `:portNumber`] `-o` `property1=` `value1` [ [`-o` `property2` `=value2`] … ]	ブローカのプロパティーを設定しますブローカのプロパティーについては、第 14 章「ブローカのプロパティーのリファレンス」を参照してください。
`reload cls`	クラスタ設定を再読み込みします [ブローカクラスタに対してのみ適用します] すべての持続情報を最新の状態にします。
`query bkr` `-b` `hostName` `:portNumber`	ブローカのプロパティー値を一覧表示しますクラスタでは、指定されたブローカに接続している実行中のすべてのブローカも一覧表示します。
`metrics bkr` [`-b` `hostName` `:portNumber`] [`-m` `metricType`] [`-int` `interval`] [`-msp` `numSamples`]	ブローカのメトリックスを表示します `-m` オプションでは、表示するメトリックスのタイプを指定します。 `ttl`: ブローカで送受信されているメッセージとパケット `rts`: ブローカで送受信されているメッセージとパケットのフローレート (秒単位) `cxn`: 接続、仮想メモリーヒープ、およびスレッドデフォルト値: `ttl`。 `-int` オプションでは、メトリックスを表示する間隔を秒単位で指定します。デフォルト値: `5`。 `-msp` オプションでは、表示するサンプル数を指定します。デフォルト値: 無制限 (無限)。

接続サービス管理

表 13–3 に、接続サービスを管理するための imqcmd サブコマンドを示します。

表 13–3 接続サービス管理のためのコマンドユーティリティーサブコマンド


構文	説明
`pause svc` `-n` `serviceName` [`-b` `hostName:` `portNumber`]	接続サービスを停止します `admin` 接続サービスは停止できません。
`resume svc` `-n` `serviceName` [`-b` `hostName:` `portNumber`]	接続サービスを再開します
`update svc` `-n` `serviceName` [`-b` `hostName:` `portNumber`] `-o` `property1=` `value1` [ [`-o` `property2` `=value2`] … ]	接続サービスのプロパティーを設定します接続サービスのプロパティーについては、「接続のプロパティー」を参照してください。
`list svc` [`-b` `hostName` `:portNumber`]	ブローカで使用可能な接続サービスを一覧表示します
`query svc` `-n` `serviceName` [`-b` `hostName:` `portNumber`]	接続サービスのプロパティー値を一覧表示します
`metrics svc` `-n` `serviceName` [`-b` `hostName:` `portNumber`] [`-m` `metricType`] [`-int` `interval`] [`-msp` `numSamples`]	接続サービスのメトリックスを表示します `-m` オプションでは、表示するメトリックスのタイプを指定します。 `ttl`: 指定の接続サービスを介してブローカで送受信されているメッセージとパケット `rts`: 指定の接続サービスを介してブローカで送受信されているメッセージとパケットのフローレート (秒単位) `cxn`: 接続、仮想メモリーヒープ、およびスレッドデフォルト値: `ttl`。 `-int` オプションでは、メトリックスを表示する間隔を秒単位で指定します。デフォルト値: `5`。 `-msp` オプションでは、表示するサンプル数を指定します。デフォルト値: 無制限 (無限)。

接続管理

表 13–4 に、接続を管理するための imqcmd サブコマンドを示します。

表 13–4 接続サービス管理のためのコマンドユーティリティーサブコマンド


構文	説明
`list cxn` [`-svn` `serviceName`] [`-b` `hostName:` `portNumber`]	ブローカ上の接続を一覧表示します指定された接続サービスに対する、ブローカ上のすべての接続を一覧表示します。接続サービスを指定しない場合は、すべての接続が一覧表示されます。
`query cxn` `-n` `connectionID` [`-b` `hostName:` `portNumber`]	接続情報を表示します

物理的送信先管理

表 13–5 に、物理的送信先を管理するための imqcmd サブコマンドを示します。-t (送信先タイプ) オプションには常に、2 つの値のいずれかを指定できます。

q: キュー送信先

t: トピック送信先

表 13–5 物理的送信先管理のためのコマンドユーティリティーサブコマンド


構文	説明
`create dst` `-t` `destType` `-n` `destName` [`-o` `property1` `=value1`] [ [ `-o` `property2` `=value2`] … ]	物理的送信先を作成します [マスターブローカが一時的に使用できなくなっているブローカクラスタでは実行できません。] 送信先名 `destName` は、スペースを含まない英数字だけを使用でき、英字、下線 (`_`)、またはドル記号 (`$`) 文字で始める必要があります。文字列 `mq` で始めることはできません。
`destroy dst` `-t` `destType` `-n` `destName`	物理的送信先を破棄しますこの操作は、デッドメッセージキューなど、システムが作成した送信先には適用できません。
`pause dst` [`-t` `destType` `-n` `destName`] [`-pst` `pauseType`]	物理的送信先のメッセージ配信を停止します `-t` および `-n` オプションで指定された物理的送信先のメッセージ配信を停止します。これらのオプションを指定しない場合は、すべての送信先が停止されます。 `-pst` オプションでは、停止するメッセージ配信のタイプを指定します。 `CONSUMERS`: メッセージコンシューマへの配信を停止します `PRODUCERS`: メッセージプロデューサへの配信を停止します `ALL`: すべてのメッセージ配信を停止しますデフォルト値: `ALL`
`resume dst` [`-t` `destType` `-ndestName`]	物理的送信先のメッセージ配信を再開します `-t` および `-n` オプションで指定された物理的送信先のメッセージ配信を再開します。これらのオプションを指定しない場合は、すべての送信先が再開されます。
`update dst` `-t` `destType` `-n` `destName` `-o` `property1=` `value1` [ [ `-o` `property2` `=value2`] … ]	物理的送信先のプロパティーを設定します物理的送信先のプロパティーについては、第 15 章「物理的送信先のプロパティーのリファレンス」を参照してください。
`purge dst` `-t` `destType` `-n` `destName`	物理的送信先からすべてのメッセージを消去します
`compact dst` [`-t` `destType` `-n` `destName`]	物理的送信先を圧縮します `-t` および `-n` オプションで指定された物理的送信先のファイルベースの持続データストアを圧縮します。これらのオプションを指定しない場合は、すべての送信先が圧縮されます。圧縮する前に、対象の送信先を停止する必要があります。
`list dst` [`-t` `destType`] [`-tmp`]	物理的送信先を一覧表示します `-t` オプションで指定されたタイプのすべての物理的送信先を一覧表示します。送信先タイプを指定しない場合は、キューとトピックの両方の送信先が一覧表示されます。`-tmp` オプションを指定した場合は、一時的送信先も一覧表示されます。
`query dst` `-t` `destType` `-n` `destName`	物理的送信先のプロパティー値を一覧表示します
`metrics dst` `-t` `destType` `-n` `destName` [`-m` `metricType`] [`-int` `interval`] [`-msp` `numSamples`]	物理的送信先のメトリックスを表示します `-m` オプションでは、表示するメトリックスのタイプを指定します。 `ttl`: 送信先で送受信されているメッセージとパケットおよびメモリー内のメッセージとパケット `rts`: ブローカで送受信されているメッセージとパケットのフローレート (秒単位)、およびその他のレート情報 `con`: メッセージコンシューマに関するメトリックス `dsk`: ディスク使用率デフォルト値: `ttl`。 `-int` オプションでは、メトリックスを表示する間隔を秒単位で指定します。デフォルト値: `5`。 `-msp` オプションでは、表示するサンプル数を指定します。デフォルト値: 無制限 (無限)。

永続サブスクリプション管理

表 13–6 に、永続サブスクリプションを管理するための imqcmd サブコマンドを示します。

表 13–6 永続サブスクリプション管理のためのコマンドユーティリティーサブコマンド


構文	説明
`destroy dur` `-c` `clientID` `-n` `subscriberName`	永続サブスクリプションを破棄します [マスターブローカが一時的に使用できなくなっているブローカクラスタでは実行できません。]
`purge dur` `-c` `clientID` `-n` `subscriberName`	永続サブスクリプションのすべてのメッセージを消去します
`list dur` `-d` `topicName`	トピックの永続サブスクリプションを一覧表示します

トランザクション管理

表 13–7 に、トランザクションを管理するための imqcmd サブコマンドを示します。

表 13–7 トランザクション管理のためのコマンドユーティリティーサブコマンド


構文	説明
`commit txn` `-n` `transactionID`	トランザクションをコミットします
`rollback txn` `-n` `transactionID`	トランザクションをロールバックします
`list txn`	ブローカが追跡しているトランザクションを一覧表示します
`query txn` `-n` `transactionID`	トランザクション情報を表示します

一般的なコマンドユーティリティーオプション

表 13–8 に示す追加のオプションは、imqcmd コマンドのすべてのサブコマンドに適用できます。

表 13–8 一般的なコマンドユーティリティーオプション


オプション	説明
`-secure`	`ssladmin` 接続サービスによるブローカへの安全な接続を使用します
`-u` `userName`	認証のためのユーザー名このオプションを省略すると、コマンドユーティリティーによってインタラクティブに要求されます。
`-p` `password`	認証のためのパスワード [このオプションは異論が多く、最終的には削除される予定です。パスワードを省略して、ユーザーがインタラクティブにパスワードが要求されるようにするか、または `-passfile` オプションを使用して、パスワードが含まれるパスワードファイルを指定します。]
`-passfile` `path`	パスワードファイルの場所詳細については、「パスワードファイル」を参照してください。
`-rtm` `timeoutInterval`	初期タイムアウト間隔 (秒単位) これは、コマンドユーティリティーが要求を再試行するまでの、ブローカからの応答を待つ時間の初期値です。その後の各再試行では、タイムアウト間隔として、この初期間隔の倍数が使用されます。デフォルト値: `10`。
`-rtr` `numRetries`	ブローカ要求がタイムアウトになったあとの再試行の回数デフォルト値: `5`。
`-javahome` `path`	代替 Java ランタイムの場所デフォルトの動作: システムにインストールされているランタイム、または Message Queue にバンドルされているランタイムが使用されます。
`-f`	ユーザーの確認なしでアクションを実行します
`-s`	サイレントモード (出力の表示なし)
`-v`	バージョン情報を表示します [コマンド行に指定したその他のオプションはすべて無視されます。] ^, [ユーザー名とパスワードは必要ありません]
`-h`	使用方法に関するヘルプを表示します^,
`-H`	属性リストや例を含む、使用方法に関する詳細なヘルプを表示します^,

オブジェクトマネージャーユーティリティー

オブジェクトマネージャーユーティリティー (imqobjmgr) では、Message Queue 管理対象オブジェクトを作成および管理します。表 13–9 に、使用可能なサブコマンドを示します。

表 13–9 オブジェクトマネージャーのサブコマンド


サブコマンド	説明
`add`	管理対象オブジェクトをオブジェクトストアに追加します
`delete`	管理対象オブジェクトをオブジェクトストアから削除します
`list`	オブジェクトストア内の管理対象オブジェクトを一覧表示します
`query`	管理対象オブジェクトの情報を表示します
`update`	管理対象オブジェクトを変更します

表 13–10 に、imqobjmgr コマンドのオプションを示します。

表 13–10 オブジェクトマネージャーのオプション


オプション	説明
`-l` `lookupName`	管理対象オブジェクトの JNDI 検索名
`-j` `attribute=` `value`	JNDI オブジェクトストアの属性 (「オブジェクトストア」を参照)
`-t` `objectType`	管理対象オブジェクトのタイプ: `q`: キュー送信先 `t`: トピック送信先 `cf`: 接続ファクトリ `qf`: キュー接続ファクトリ `tf`: トピック接続ファクトリ `xcf`: 分散トランザクションの接続ファクトリ `xqf`: 分散トランザクションのキュー接続ファクトリ `xtf`: 分散トランザクションのトピック接続ファクトリ `e`: SOAP の端点 (『Message Queue Developer's Guide for Java Clients』を参照)
`-o` `attribute=` `value`	管理対象オブジェクトの属性 (「管理対象オブジェクトの属性」および第 16 章「管理対象オブジェクト属性のリファレンス」を参照)
`-r` `readOnlyState`	管理対象オブジェクトが読み取り専用かどうか `true` の場合、クライアントはオブジェクトの属性を変更できません。デフォルト値: `false`。
`-i` `fileName`	サブコマンド節の全体または一部を含むコマンドファイルの名前
`-pre`	コマンドを実行せずに結果のプレビューを表示しますこのオプションは、デフォルト属性の値を確認するときに便利です。
`-javahome` `path`	代替 Java ランタイムの場所デフォルトの動作: システムにインストールされているランタイム、または Message Queue にバンドルされているランタイムが使用されます。
`-f`	ユーザーの確認なしでアクションを実行します
`-s`	サイレントモード (出力の表示なし)
`-v`	バージョン情報を表示します [コマンド行に指定したその他のオプションはすべて無視されます。]
`-h`	使用方法に関するヘルプを表示します
`-H`	属性リストや例を含む、使用方法に関する詳細なヘルプを表示します

データベースマネージャーユーティリティー

データベースマネージャーユーティリティー (imqdbmgr) では、JDBC ベースの持続データストアのデータベーススキーマを設定します。また、破損した Message Queue データベーステーブルを削除したり、データストアを変更したりすることもできます。表 13–11 に、使用可能なサブコマンドを示します。

表 13–11 データベースマネージャーのサブコマンド


サブコマンド	説明
`create all`	新しいデータベースと持続ストアのスキーマを作成します組み込みデータベースシステムに使用します。ブローカプロパティー `imq.persist.jdbc.createdburl` を指定する必要があります。
`create tbl`	既存のデータベースの持続ストアのスキーマを作成します外部データベースシステムに使用します。
`delete tbl`	現在の持続ストアから Message Queue データベーステーブルを削除します
`delete oldtbl`	以前のバージョンの持続ストアから Message Queue データベーステーブルを削除します持続ストアが Message Queue の現在のバージョンへ自動的に移行されたあとに使用されます。
`recreate tbl`	持続ストアのスキーマを再作成します現在の持続ストアから既存の Message Queue データベースをすべて削除したあと、スキーマを再作成します。
`reset lck`	持続ストアのロックをリセットしますほかのプロセスが持続ストアデータベースを使用できるようにロックをリセットします。

表 13–12 に、imqdbmgr コマンドのオプションを示します。

表 13–12 データベースマネージャーのオプション


オプション	説明
`-b` `instanceName`	ブローカのインスタンス名
`-Dproperty=` `value`	ブローカ設定プロパティーを設定します持続に関連するブローカ設定プロパティーについては、「持続のプロパティー」を参照してください。注: このオプションを使用してプロパティーを設定するときは、スペルと形式をよく確認してください。誤りのある値は無視され、通知や警告は表示されません。
`-u` `name`	認証のためのユーザー名
`-p` `password`	認証のためのパスワード [このオプションは異論が多く、最終的には削除される予定です。パスワードを省略して、ユーザーがインタラクティブにパスワードが要求されるようにするか、または `-passfile` オプションを使用して、パスワードが含まれるパスワードファイルを指定します。]
`-passfile` `path`	パスワードファイルの場所詳細については、「パスワードファイル」を参照してください。
`-v`	バージョン情報を表示します [コマンド行に指定したその他のオプションはすべて無視されます。]
`-h`	使用方法に関するヘルプを表示します

ユーザーマネージャーユーティリティー

ユーザーマネージャーユーティリティー (imqusermgr) は、単層型ファイルユーザーリポジトリを設定または編集するために使用します。このユーティリティーは、対象のブローカがインストールされているホストで実行する必要があります。ブローカ固有のユーザーリポジトリがまだ存在しない場合は、最初に、対応するブローカインスタンスを起動してリポジトリを作成する必要があります。また、リポジトリに書き込むための適切なアクセス権が必要になります。つまり、Solaris および Linux プラットフォームでは、root ユーザーか、対象のブローカインスタンスを作成したユーザーである必要があります。

表 13–13 に、imqusermgr コマンドで使用可能なサブコマンドを示します。-i オプションでは常に、コマンドの適用対象となるユーザーリポジトリを持つブローカのインスタンス名を指定します。指定しない場合は、デフォルト名 imqbroker が使用されます。

表 13–13 ユーザーマネージャーのサブコマンド


構文	説明
`add` [`-i` `instanceName`] `-u` `userName` `-p` `password` [`-g` `group`]	ユーザーとパスワードをリポジトリに追加します任意指定の `-g` オプションでは、このユーザーを割り当てるグループを指定します。 `admin` `user` `anonymous`
`delete` [`-i` `instanceName`] `-u` `userName`	ユーザーをリポジトリから削除します
`update` [`-i` `instanceName`] `-u` `userName` `-p` `password` [`-a` `activeState`] `update` [`-i` `instanceName`] `-u` `userName` `-a` `activeState` [`-p` `password`]	ユーザーのパスワードまたはアクティブ状態 (あるいはその両方) を設定します `-a` オプションでは、ユーザーをアクティブにする (`true`) か非アクティブにする (`false`) かのブール値を指定します。デフォルト値: `true`。
`list` [`-i` `instanceName`] [`-u` `userName`]	ユーザー情報を表示しますユーザー名を指定しない場合は、リポジトリ内のすべてのユーザーが一覧表示されます。

また、表 13–14 に示すオプションは、imqusermgr コマンドのすべてのサブコマンドに適用できます。

表 13–14 一般的なユーザーマネージャーオプション


オプション	説明
`-f`	ユーザーの確認なしでアクションを実行します
`-s`	サイレントモード (出力の表示なし)
`-v`	バージョン情報を表示します [コマンド行に指定したその他のオプションはすべて無視されます。]
`-h`	使用方法に関するヘルプを表示します

サービス管理ユーティリティー

サービス管理ユーティリティー (imqsvcadmin) では、ブローカを Windows サービスとしてインストールします。表 13–15 に、使用可能なサブコマンドを示します。

表 13–15 サービス管理のサブコマンド


サブコマンド	説明
`install`	サービスをインストールします
`remove`	サービスを削除します
`query`	起動オプションを表示します起動オプションでは、サービスを手動または自動のどちらで起動するか、サービスの場所、Java ランタイムの場所、および起動時にブローカに渡す引数の値を指定できます (表 13–16 を参照)。

表 13–16 に、imqsvcadmin コマンドのオプションを示します。

表 13–16 サービス管理のオプション


オプション	説明
`-javahome` `path`	代替 Java ランタイムの場所デフォルトの動作: システムにインストールされているランタイム、または Message Queue にバンドルされているランタイムが使用されます。
`-jrehome` `path`	代替 Java Runtime Environment (JRE) の場所
`-vmargs` `arg1` [ [`arg2` ] … ]	ブローカサービスを実行する Java 仮想マシン (JVM) に渡す追加の引数 [これらの引数は、Windows の「管理ツール」コントロールパネルの「サービス」ツールで、サービスの「プロパティ」ウィンドウの「全般」タブにある「開始パラメータ」フィールドを使用して指定することもできます。] 例: `imqsvcadmin install -vmargs "-Xms16m -Xmx128m"`
`-args` `arg1` [ [`arg2`] … ]	ブローカサービスに渡す追加のコマンド行引数例: `imqsvcadmin install -args "-passfile` `d:\\imqpassfile"` ブローカのコマンド行引数については、「ブローカユーティリティー」を参照してください。
`-h`	使用方法に関するヘルプを表示します [コマンド行に指定したその他のオプションはすべて無視されます。]

-javahome、-vmargs、および -args オプションを使用して指定した情報は、Windows レジストリの次のパスにある JREHome、JVMArgs、および ServiceArgs キーに保存されます。

   HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\iMQ_Broker\Parameters

キーツールユーティリティー

キーツールユーティリティー (imqkeytool) では、ssljms、ssladmin、または cluster 接続サービスで使用できる、ブローカの自己署名型証明書を生成します。構文は次のとおりです。

   imqkeytool -broker

UNIX システムでは、superuser (root) アカウントからこのユーティリティーを実行する必要がある場合があります。

第 14 章ブローカのプロパティーのリファレンス

この章では、メッセージブローカの設定プロパティーに関する参照情報を提供します。この章は、次の節から構成されています。

接続のプロパティー

表 14–1 に、接続サービスに関するブローカプロパティーを示します。

表 14–1 接続に関するブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.service.activelist`	文字列	`jms,admin`	ブローカの起動時にアクティブにする接続サービスのリスト
`imq.hostname`	文字列	使用可能なすべての IP アドレス	すべての接続サービスのデフォルトのホスト名または IP アドレス
`imq.portmapper.hostname`	文字列	なし	ポートマッパーのホスト名または IP アドレス指定すると、`imq.hostname` が上書きされます
`imq.portmapper.port` [`imqcmd` `update` `bkr` コマンドで使用できます]	整数	`7676`	ポートマッパーのポート番号注 – 同じホスト上で複数のブローカインスタンスが実行されている場合は、それぞれに一意のポートマッパーポートを割り当てる必要があります。
`imq.serviceName` `.protocolType.hostname` [`jms`、`ssljms`、`admin`、および `ssladmin` サービスのみ。`httpjms` および `httpsjms` サービスの設定については、付録 C 「HTTP/HTTPS のサポート」を参照してください]	文字列	なし	接続サービスのホスト名または IP アドレス指定すると、指定した接続サービスについて `imq.hostname` が上書きされます
`imq.serviceName` `.protocolType.port`	整数	`0`	接続サービスのポート番号値 `0` は、ポート番号がポートマッパーによって動的に割り当てられることを示します。
`imq.portmapper.backlog`	整数	`50`	オペレーティングシステムのバックログに保留するポートマッパー要求の最大数
`imq.serviceName` `.threadpool_model` [`jms` および `admin` サービスのみ]	文字列	`dedicated`	スレッドプール管理のスレッドモデル `dedicated`: 接続ごとに、受信メッセージ用と送信メッセージ用の 2 つの専用スレッドを使用します `shared`: メッセージの送受信時に共有スレッドによって接続を処理します
			専用モデルでは、サポートできる接続数が制限されますが、プロバイダのパフォーマンスが向上します。共有モデルでは、サポートできる接続数が多くなりますが、スレッド管理のためのオーバーヘッドが加わるため、パフォーマンスが低下します。
`imq.serviceName` `.min_threads`	整数	`jms`: `10ssljms` : `10httpjms`: `10` `httpsjms`: `10` `admin`: `4ssladmin`: `4`	接続サービスのスレッドプールに保持するスレッドの最小数使用可能なスレッドの数がこのしきい値を超えると、スレッドは、最小数に達するまで、解放と同時にとシャットダウンされます。デフォルト値は、接続サービスによって異なります。
`imq.serviceName` `.max_threads`	整数	`jms`: `1000` `ssljms`: `500httpjms`: `500httpsjms` : `500` `admin`: `10ssladmin`: `10`	指定された接続サービスのスレッドプールに保持するスレッドの最大数。使用可能な新しいスレッドはこれ以上追加されません。この数は、`0` より大きく、`imq.serviceName.min_threads` の値よりも大きくする必要があります。デフォルト値は、接続サービスによって異なります。
`imq.shared.connectionMonitor_limit` [共有スレッドモデルのみ]	整数	Solaris: `512`Linux: `512`Windows: `64`	1 つのディストリビュータスレッドが監視する接続の最大数システムによって、すべての接続の監視に十分な数のディストリビュータスレッドが割り当てられます。このプロパティーの値が小さいほど、アクティブな接続へのスレッドの割り当てが高速になります。値 `-1` は、スレッドあたりの接続数が無制限であることを示します。デフォルト値は、オペレーティングシステムのプラットフォームによって異なります。
`imq.ping.interval`	整数	`120`	クライアントとブローカ間のテスト接続の間隔 (秒単位) 値 `0` または `-1` を指定すると、接続の定期的なテストが無効になります。

ルーティングのプロパティー

表 14–2 に、ルーティングサービスに関するブローカプロパティーを示します。送信先の自動作成を設定するプロパティーについては、表 14–3 を参照してください。

表 14–2 ルーティングに関するブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.system.max_count` [`imqcmd` `update` `bkr` コマンドで使用できます]	整数	`-1`	ブローカが保持するメッセージの最大数値 `-1` は、メッセージ数が無制限であることを示します。
`imq.system.max_size`	文字列	`-1`	ブローカが保持するメッセージの最大合計サイズ次の接尾辞を使用して、バイト、K バイト、または M バイトの単位で値を表すことができます。 `b`: バイト `k`: K バイト (1024 バイト) `m`: M バイト (1024 × 1024 = 1,048,576 バイト)
			接尾辞を付けない値は、バイト単位になります。値 `-1` は、メッセージ容量が無制限であることを示します。
			例: `1600`: 1600 バイト `1600b`: 1600 バイト `16k`: 16 K バイト (= 16,384 バイト) `16m`: 16 M バイト (= 16,777,216 バイト) `-1`: 無制限
`imq.message.max_size`	文字列	`70m`	単一メッセージの本文の最大サイズ構文は `imq.system.max_size` と同じです (前述の説明を参照)。
`imq.message.expiration.interval`	整数	`60`	期限切れのメッセージを再利用する間隔 (秒単位)
`imq.resourceState` `.threshold`	整数	`green`: `0` `yellow`: `80orange`: `90red`: `98`	メモリーリソースの状態をトリガーするしきい値となる使用率 (`resourceState` は `green`、`yellow`、`orange`、または `red`)
`imq.resourceState` `.count`	整数	`green`: `5000` `yellow`: `500orange`: `50red`: `0`	メモリーリソースの状態のしきい値に達したかどうかを確認するまでの、バッチで許容する受信メッセージの最大数 (`resourceState` は `green`、`yellow`、`orange`、または `red`) この制限は、システムメモリーがさらに不十分になると、メッセージプロデューサの処理速度を低下させます。
`imq.destination.DMQ.truncateBody`	ブール	`false`	デッドメッセージキューに保存する前にメッセージ本文を削除するかどうか `true` の場合は、メッセージヘッダーとプロパティーデータのみが保存されます。
`imq.transaction.autorollback`	ブール	`false`	ブローカの起動時に PREPARED 状態のままになっている分散トランザクションを自動的にロールバックするかどうか `false` の場合は、コマンドユーティリティー (`imqcmd`) を使用して、トランザクションを手動でコミットまたはロールバックする必要があります。

表 14–3 自動作成された送信先に関するブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.autocreate.queue` [`imqcmd` `update` `bkr` コマンドで使用できます] ^, [キュー送信先のみ]	ブール	`true`	キュー送信先の自動作成を許可するかどうか
`imq.autocreate.topic` [トピック送信先のみ]	ブール	`true`	トピック送信先の自動作成を許可するかどうか
`imq.autocreate.destination.maxNumMsgs`	整数	`100000`	消費されていないメッセージの最大数値 `-1` は、メッセージ数が無制限であることを示します。
`imq.autocreate.destination.maxBytesPerMsg`	文字列	`10k`	単一メッセージの最大サイズ (バイト単位) 次の接尾辞を使用して、バイト、K バイト、または M バイトの単位で値を表すことができます。 `b`: バイト `k`: K バイト (1024 バイト) `m`: M バイト (1024 × 1024 = 1,048,576 バイト)
			接尾辞を付けない値は、バイト単位になります。値 `-1` は、メッセージサイズが無制限であることを示します。
			例: `1600`: 1600 バイト `1600b`: 1600 バイト `16k`: 16 K バイト (= 16,384 バイト) `16m`: 16 M バイト (= 16,777,216 バイト) `-1`: 無制限
`imq.autocreate.destination.maxTotalMsgBytes`	文字列	`10m`	消費されていないメッセージの最大合計メモリー (バイト単位) 構文は `imq.autocreate.destination.maxBytesPerMsg` と同じです (前述の説明を参照)。
`imq.autocreate.destination.limitBehavior`	文字列	`REJECT_NEWEST`	メモリー制限のしきい値に達したときのブローカの動作 `FLOW_CONTROL`: プロデューサの処理速度を下げます `REMOVE_OLDEST`: もっとも古いメッセージを破棄します `REMOVE_LOW_PRIORITY`: メッセージの有効期間に従ってもっとも優先度の低いメッセージを破棄します。プロデューシングクライアントには通知しません `REJECT_NEWEST`: もっとも新しいメッセージを拒否します。持続メッセージの場合のみ、プロデューシングクライアントに例外を通知します
			値が `REMOVE_OLDEST` または `REMOVE_LOW_PRIORITY` で、`imq.autocreate.destination.useDMQ` プロパティーが `true` の場合、超過したメッセージはデッドメッセージキューに移動されます。
`imq.autocreate.destination.maxNumProducers`	整数	`100`	送信先のメッセージプロデューサの最大数この制限に達すると、新しいプロデューサを作成できません。値 `-1` は、プロデューサ数が無制限であることを示します。
`imq.autocreate.queue.maxNumActiveConsumers`	整数	`1`	キュー送信先からのロードバランスされた配信でアクティブにするメッセージコンシューマの最大数値 `-1` は、コンシューマ数が無制限であることを示します。
`imq.autocreate.queue.maxNumBackupConsumers`	整数	`0`	キュー送信先からのロードバランスされた配信でバックアップにするメッセージコンシューマの最大数値 `-1` は、コンシューマ数が無制限であることを示します。
`imq.autocreate.queue.consumerFlowLimit`	整数	`1000`	キューコンシューマに単一のバッチで配信するメッセージの最大数ロードバランスされたキュー配信では、ロードバランスが開始されるまでの、アクティブコンシューマにルーティングされるキュー内のメッセージの初期数になります。送信先コンシューマは、接続で低い値を指定することで、この制限を上書きできます。値 `-1` は、メッセージ数が無制限であることを示します。
`imq.autocreate.topic.consumerFlowLimit`	整数	`1000`	トピックコンシューマに単一のバッチで配信するメッセージの最大数値 `-1` は、コンシューマ数が無制限であることを示します。
`imq.autocreate.destination.isLocalOnly`	ブール	`false`	ローカル配信のみかどうかこのプロパティーは、ブローカクラスタ内の送信先のみに適用されます。送信先の作成後は変更できません。`true` の場合、送信先はほかのブローカに複製されず、ローカルコンシューマ (送信先が作成されたブローカに接続しているコンシューマ) だけにメッセージを配信するように制限されます。
`imq.autocreate.queue.localDeliveryPreferred`	ブール	`false`	ローカル配信優先かどうかこのプロパティーは、ブローカクラスタ内のロードバランスされたキュー配信のみに適用されます。`true` の場合、メッセージは、ローカルブローカにコンシューマがない場合にのみリモートコンシューマに配信されます。送信先をローカルのみの配信に制限しないでください。つまり、`imq.autocreate.destination.isLocalOnly` を `false` にする必要があります。
`imq.autocreate.destination.useDMQ`	ブール	`true`	デッドメッセージをデッドメッセージキューに送信するかどうか `false` の場合、デッドメッセージは単に破棄されます。

持続のプロパティー

Message Queue^TM は、持続データストレージにファイルベースモデルと JDBC ベースモデルの両方をサポートしています。ブローカプロパティー imq.persist.store (表 14–4) で、使用するモデルを指定します。以降の節では、2 つのモデルのブローカ設定プロパティーについて説明します。

表 14–4 持続に関するグローバルなブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.persist.store`	文字列	`file`	持続データストレージのモデル `file`: ファイルベースの持続 `jdbc`: JDBC ベースの持続

ファイルベースの持続

表 14–5 に、ファイルベースの持続に関するブローカプロパティーを示します。

表 14–5 ファイルベースの持続に関するブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.persist.file.message.max_record_size`	文字列	`1m`	メッセージストレージファイルに追加するメッセージの最大サイズこのサイズを超えるメッセージは、個別の専用ファイルに格納されます。次の接尾辞を使用して、バイト、K バイト、または M バイトの単位で値を表すことができます。 `b`: バイト `k`: K バイト (1024 バイト) `m`: M バイト (1024 × 1024 = 1,048,576 バイト) 接尾辞を付けない値は、バイト単位になります。例: `1600`: 1600 バイト `1600b`: 1600 バイト `16k`: 16 K バイト (= 16,384 バイト) `16m`: 16 M バイト (= 16,777,216 バイト)
`imq.persist.file.destination.message.filepool.limit`	整数	`100`	送信先ファイルプール内の再利用可能な空きファイルの最大数この制限を超える空きファイルは削除されます。ブローカは、必要に応じて、制限を超える追加ファイルを作成および削除します。この制限値が高いほど、ブローカが持続データを処理する速度が速くなります。
`imq.persist.file.message.filepool.cleanratio`	整数	`0`	空きファイルのプールにクリーン (空) の状態で保持するファイルの割合この値が高いほど、ファイルプールに必要なディスク容量が少なくなりますが、処理中にファイルを消去するためのオーバーヘッドが大きくなります。
`imq.persist.file.message.cleanup`	ブール	`false`	シャットダウン時に空きファイルのプール内のファイルを消去するかどうかこのプロパティーを `true` に設定すると、ファイルストア用のディスク容量を節約できますが、ブローカのシャットダウンに時間がかかります。
`imq.persist.file.sync.enabled`	ブール	`false`	メモリー内の状態を物理的なストレージデバイスと同期させるかどうかこのプロパティーを `true` に設定すると、システムクラッシュによるデータの損失は回避できますが、パフォーマンスが下がります。注 – Sun Cluster および Message Queue の Sun Cluster データサービスを実行している場合は、すべてのクラスタノードのブローカでこのプロパティーを `true` に設定してください。

JDBC ベースの持続

表 14–6 に、JDBC ベースの持続に関するブローカプロパティーを示します。示す例は、DataMirror Mobile Solutions, Inc の PointBase^® ファミリーのデータベース製品の例です。

表 14–6 JDBC ベースの持続に関するブローカプロパティー


プロパティー	例	説明
`imq.persist.jdbc.brokerid`	PointBase 組み込みバージョンの場合は不要です	(任意指定) ブローカインスタンスの識別子識別子には英数字を使用し、長さは `n` - 12 (`n` はデータベースで許可されるテーブル名の最大長) を超えないようにする必要があります。複数のブローカインスタンスが同じデータベースを持続データストアとして使用する場合、データベーステーブル名を一意にするために、この識別子がデータベーステーブル名に追加されます。この識別子は、通常、1 つのブローカインスタンスのみのデータを保存する組み込みデータベースでは必要ありません。
`imq.persist.jdbc.driver`	`com.pointbase.jdbc.jdbcUniversalDriver`	データベースに接続するための JDBC ドライバの Java クラス名
`imq.persist.jdbc.opendburl`	`jdbc:pointbase:embedded:dbName` `;` `database.home=` `.../instances/instance Name/dbstore`	既存のデータベースへの接続を開くための URL
`imq.persist.jdbc.createdburl`	`jdbc:pointbase:embedded:dbName` `;` `new,database.home=` `.../instances/` `instanceName/dbstore`	(任意指定) 新しいデータベースを作成するための URL Message Queue データベースマネージャーユーティリティー (`imqdbmgr`) を使用してデータベースを作成する場合にのみ必要です。
`imq.persist.jdbc.closedburl`	PointBase の場合は不要です	(任意指定) データベース接続を閉じるための URL
`imq.persist.jdbc.user`		(任意指定) 必要に応じて、データベース接続を開くためのユーザー名。セキュリティーを考慮する場合、代わりにコマンド行オプション `imqbrokerd -dbuser` と `imqdbmgr - u` を使用してこの値を指定できます。
`imq.persist.jdbc.needpassword`		(任意指定) データベースでブローカアクセス用のパスワードが必要かどうか `true` の場合、`imqbrokerd` および `imqdbmgr` コマンドでは、`-passfile` オプションを使用してパスワードを含むパスワードファイルを指定しないかぎり、パスワードが要求されます。
`imq.persist.jdbc.password` [パスワードファイルでのみ指定するようにしてください。]		(任意指定) データベース接続を開くためのパスワード
`imq.persist.jdbc.table.IMQSV35`	`CREATE TABLE ${name}` `(STOREVERSION INTEGER NOT NULL,` `BROKERID VARCHAR(100))`	バージョンテーブルを作成するための SQL コマンド
`imq.persist.jdbc.table.IMQCCREC35`	`CREATE TABLE ${name}` `(RECORDTIME BIGINT NOT NULL,` `RECORD BLOB (10k))`	設定変更レコードテーブルを作成するための SQL コマンド
`imq.persist.jdbc.table.IMQDEST35`	`CREATE TABLE ${name}` `(DID VARCHAR(100) NOT NULL,` `DEST BLOB (10k),` `primaryKey(DID))`	送信先テーブルを作成するための SQL コマンド
`imq.persist.jdbc.table.IMQINT35`	`CREATE TABLE ${name}` `(CUID BIGINT NOT NULL,` `INTEREST BLOB(10k) ,` `primaryKey(CUID))`	配信対象テーブルを作成するための SQL コマンド
`imq.persist.jdbc.table.IMQMSG35`	`CREATE TABLE ${name}` `(MID VARCHAR(100) NOT NULL,` `DID VARCHAR (100),` `MSGSIZE BIGINT,` `MSG BLOB(1m),` `primaryKey(MID))`	メッセージテーブルを作成するための SQL コマンド `MSG` 列のデフォルトの最大長は、1M バイト (`1m`) です。メッセージがこれより長くなると予想される場合は、必要に応じて長さを設定します。テーブルがすでに作成されている場合、メッセージの最大長を変更するには、テーブルを作成し直す必要があります。
`imq.persist.jdbc.table.IMQPROPS35`	`CREATE TABLE ${name}` `(PROPNAME VARCHAR(100) NOT NULL,` `PROPVALUE BLOB(10k),` `primaryKey` `(PROPNAME))`	プロパティーテーブルを作成するための SQL コマンド
`imq.persist.jdbc.table.IMQILIST35`	`CREATE TABLE ${name}` `(MID VARCHAR(100) NOT NULL,` `CUID BIGINT,` `DID VARCHAR(100),` `STATE INTEGER,` `primaryKey(MID, CUID))`	配信対象の状態テーブルを作成するための SQL コマンド
`imq.persist.jdbc.table.IMQTXN35`	`CREATE TABLE ${name}` `(TUID BIGINT NOT NULL,` `STATE INTEGER,` `TSTATEOBJ BLOB(10K),` `primaryKey(TUID))`	トランザクションテーブルを作成するための SQL コマンド
`imq.persist.jdbc.table.IMQTACK35`	`CREATE TABLE ${name}` `(TUID BIGINT NOT NULL,` `TXNACK BLOB(10k))`	トランザクション通知テーブルを作成するための SQL コマンド

セキュリティーのプロパティー

表 14–7 に、セキュリティーサービスに関するブローカプロパティーを示します。

表 14–7 セキュリティーに関するブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.accesscontrol.enabled`	ブール	`true`	アクセス制御を使用するかどうか `true` の場合、アクセス制御プロパティーファイルが確認され、認証されたユーザーについて、接続サービスの使用または特定の送信先に対する特定の操作の実行が承認されているかどうかが検証されます。
`imq.serviceName.accesscontrol.enabled`	ブール	なし	接続サービスのアクセス制御を使用するかどうか指定すると、指定した接続サービスの `imq.accesscontrol.enabled` が上書きされます。 `true` の場合、アクセス制御プロパティーファイルが確認され、認証されたユーザーについて、指定した接続サービスの使用または特定の送信先に対する特定の操作の実行が承認されているかどうかが検証されます。
`imq.accesscontrol.file.filename`	文字列	`accesscontrol.properties`	アクセス制御プロパティーファイルの名前ファイル名は、アクセス制御ディレクトリへの相対パスで指定します (付録 A 「プラットフォームごとの Message Queue^TM データの場所」を参照)。
`imq.serviceName` `.accesscontrol.file.filename`	文字列	なし	接続サービスのアクセス制御プロパティーファイルの名前指定すると、指定した接続サービスの `imq.accesscontrol.file.filename` が上書きされます。ファイル名は、アクセス制御ディレクトリへの相対パスで指定します (付録 A 「プラットフォームごとの Message Queue^TM データの場所」を参照)。
`imq.authentication.type`	文字列	`digest`	パスワードの符号化方法 `basic`: Base-64 `digest`: MD5
`imq.serviceName` `.authentication.type`	文字列	なし	接続サービスのパスワードの符号化方法 `basic`: Base-64 `digest`: MD5 指定すると、指定した接続サービスの `imq.authentication.type` が上書きされます。
`imq.authentication.basic.user_repository`	文字列	`file`	Base-64 認証のユーザーリポジトリのタイプ `file`: ファイルベース `ldap`: LDAP
`imq.authentication.client.response.timeout`	整数	`180`	認証要求に対するクライアントの応答を待機する間隔 (秒単位)
`imq.passfile.enabled`	ブール	`false`	パスワードをパスワードファイルから取得するかどうか
`imq.passfile.dirpath`	文字列	付録 A 「プラットフォームごとの Message Queue^TM データの場所」を参照	パスワードファイルを含むディレクトリへのパス
`imq.passfile.name`	文字列	`passfile`	パスワードファイルの名前
`imq.imqcmd.password`	文字列	なし	管理ユーザーのパスワードコマンドユーティリティー (`imqcmd`) では、コマンドの実行前に、このパスワードを使用してユーザーが認証されます。
`imq.user_repository.ldap.server`	文字列	なし	LDAP サーバーのホスト名とポート番号値は次の形式になります。 `hostName:` `port` `hostName` は、LDAP サーバーを実行するホストの完全修飾 DNS 名で、`port` は、サーバーが使用するポート番号です。
			フェイルオーバーサーバーのリストを指定するには、次の構文を使用します。 `host1:` `port1` `ldap://host2` `:` `port2` `ldap://host3` `:port3` …
			リスト内のエントリはスペースで区切ります。各フェールオーバーサーバーのアドレスの先頭には `ldap://` を付けます。SSL を使用し、プロパティー `imq.user_repository.ldap.ssl.enabled` を `true` に設定している場合でも、この形式を使用します。このアドレスでは `ldaps` を指定する必要はありません。
`imq.user_repository.ldap.principal`	文字列	なし	LDAP ユーザーリポジトリにバインドするための識別名 LDAP サーバーで匿名検索が許可されている場合は必要ありません。
`imq.user_repository.ldap.password` [パスワードファイルでのみ指定するようにしてください。]	文字列	なし	LDAP ユーザーリポジトリにバインドするためのパスワード LDAP サーバーで匿名検索が許可されている場合は必要ありません。
`imq.user_repository.ldap.propertyName`	今後追加される予定	今後追加される予定	今後追加される予定
`imq.user_repository.ldap.base`	文字列	なし	LDAP ユーザーエントリのディレクトリベース
`imq.user_repository.ldap.uidattr`	文字列	なし	LDAP ユーザー名のプロバイダ固有の属性識別子
`imq.user_repository.ldap.usrfilter`	文字列	なし	(任意指定) LDAP ユーザー検索のJNDI フィルタ
`imq.user_repository.ldap.grpsearch`	ブール	`false`	LDAP グループ検索を有効にするかどうか注 – Message Queue は、入れ子にされたグループをサポートしていません。
`imq.user_repository.ldap.grpbase`	文字列	なし	LDAP グループエントリのディレクトリベース
`imq.user_repository.ldap.gidattr`	文字列	なし	LDAP グループ名のプロバイダ固有の属性識別子
`imq.user_repository.ldap.memattr`	文字列	なし	LDAP グループ内のユーザー名のプロバイダ固有の属性識別子
`imq.user_repository.ldap.grpfilter`	文字列	なし	(任意指定) LDAP グループ検索のJNDI フィルタ
`imq.user_repository.ldap.timeout`	整数	`280`	LDAP 検索の制限時間 (秒単位)
`imq.user_repository.ldap.ssl.enabled`	ブール	`false`	LDAP サーバーとの通信に SSL を使用するかどうか
`imq.keystore.file.dirpath`	文字列	付録 A 「プラットフォームごとの Message Queue^TM データの場所」を参照	キーストアファイルを含むディレクトリへのパス
`imq.keystore.file.name`	文字列	`keystore`	キーストアファイルの名前
`imq.keystore.password`	文字列	なし	キーストアファイルのパスワード
`imq.audit.enabled` [Message Queue Enterprise Edition のみ]	ブール	`false`	ブローカログファイルへの監査ロギングを開始するかどうか

監視のプロパティー

表 14–8 に、監視サービスに関するブローカプロパティーを示します。

表 14–8 監視に関するブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.log.level` [`imqcmd` `update` `bkr` コマンドで使用できます]	文字列	`INFO`	ロギングレベル出力チャネルに書き込むことのできるロギング情報のカテゴリを指定します。使用可能な値には、レベルの高い順に次のものがあります。 `ERROR` `WARNING` `INFO` 各レベルには、その上位のレベルが含まれます。たとえば、`WARNING` には `ERROR` が含まれます。
`imq.destination.logDeadMsgs`	ブール	`false`	デッドメッセージに関する情報をログに書き込むかどうか `true` の場合、次のイベントがログに書き込まれます。送信先が最大サイズまたは最大メッセージ数に達していっぱいになった。管理コマンドか配信通知以外の理由でブローカがメッセージを破棄した。ブローカがデッドメッセージキューにメッセージを移動した。
`imq.log.console.stream`	文字列	`ERR`	コンソール出力の送信先 `OUT`: `stdout` `ERR`: `stderr`
`imq.log.console.output`	文字列	`ERROR\|WARNING`	コンソールに書き込むロギング情報のカテゴリ `NONE` `ERROR` `WARNING` `INFO` `ALL` `ERROR`、`WARNING`、および `INFO` カテゴリには、それぞれの上位のカテゴリは含まれません。したがって、必要に応じて各カテゴリを明示的に指定する必要があります。カテゴリの組み合わせは、縦線 (`\|`) で区切って指定できます。
`imq.log.file.dirpath`	文字列	付録 A 「プラットフォームごとの Message Queue^TM データの場所」を参照	ログファイルを含むディレクトリへのパス
`imq.log.file.filename`	文字列	`log.txt`	ログファイルの名前
`imq.log.file.output`	文字列	`ALL`	ログファイルに書き込むロギング情報のカテゴリ `NONE` `ERROR` `WARNING` `INFO` `ALL` `ERROR`、`WARNING`、および `INFO` カテゴリには、それぞれの上位のカテゴリは含まれません。したがって、必要に応じて各カテゴリを明示的に指定する必要があります。カテゴリの組み合わせは、縦線 (`\|`) で区切って指定できます。
`imq.log.file.rolloverbytes`	整数	`-1`	出力を新しいログファイルにロールオーバーするファイル長 (バイト単位) 値 `-1` は、バイト数が無制限である、つまりファイル長に基づくロールオーバーは行わないことを示します。
`imq.log.file.rolloversecs`	整数	`604800` (1 週間)	出力を新しいログファイルにロールオーバーするファイルの有効期間 (秒単位) 値 `-1` は、秒数が無制限である、つまりファイルの有効期間に基づくロールオーバーは行わないことを示します。
`imq.log.syslog.output` [Solaris プラットフォームのみ]	文字列	`ERROR`	`syslogd(1M)` に書き込むロギング情報のカテゴリ `NONE` `ERROR` `WARNING` `INFO` `ALL` `ERROR`、`WARNING`、および `INFO` カテゴリには、それぞれの上位のカテゴリは含まれません。したがって、必要に応じて各カテゴリを明示的に指定する必要があります。カテゴリの組み合わせは、縦線 (`\|`) で区切って指定できます。
`imq.log.syslog.facility`	文字列	`LOG_DAEMON`	メッセージのロギングのための `syslog` 機能使用可能な値は、`syslog(3C)` のマニュアルページに示される値を反映しています。Message Queue で使用するための適切な値は次のとおりです。 `LOG_USER` `LOG_DAEMON` `LOG_LOCAL0` `LOG_LOCAL1` `LOG_LOCAL2` `LOG_LOCAL3` `LOG_LOCAL4` `LOG_LOCAL5` `LOG_LOCAL6` `LOG_LOCAL7`
`imq.log.syslog.identity`	文字列	`imqbrokerd_${imq.instanceName` `}`	`syslog` にログとして書き込まれるすべてのメッセージの先頭に付ける識別文字列
`imq.log.syslog.logpid`	ブール	`true`	メッセージとともにブローカのプロセス ID をログに書き込むかどうか
`imq.log.syslog.logconsole`	ブール	`false`	メッセージを `syslog` に送信できなかった場合にシステムコンソールに書き込むかどうか
`imq.log.timezone`	文字列	該当地域のタイムゾーン	ログのタイムスタンプのタイムゾーン使用可能な値は、メソッド `java.util.TimeZone.getTimeZone` で使用される値と同じです。例: `GMT` `GMT-8:00` `America/LosAngeles` `Europe/Rome` `Asia/Tokyo`
`imq.metrics.enabled`	ブール	`true`	ロガーへのメトリックス情報の書き込みを有効にするかどうか `imq.metrics.topic.enabled` で制御するメトリックスメッセージの生成には影響しません。
`imq.metrics.interval`	整数	`-1`	ロガーにメトリックス情報を書き込む間隔 (秒単位) `imq.metrics.topic.interval` で制御するメトリックスメッセージの生成間隔には影響しません。値 `-1` は、無期限の間隔、つまりロガーにメトリックス情報を書き込まないことを示します。
`imq.metrics.topic.enabled`	ブール	`true`	メトリックストピック送信先へのメトリックスメッセージの生成を有効にするかどうか `false` の場合、メトリックストピック送信先へサブスクライブしようとすると、クライアント側の例外がスローされます。
`imq.metrics.topic.interval`	整数	`60`	メトリックストピック送信先へのメトリックスメッセージを生成する間隔 (秒単位)
`imq.metrics.topic.persist`	ブール	`false`	メトリックストピック送信先に送信されるメトリックスメッセージが持続的かどうか
`imq.metrics.topic.timetolive`	整数	`300`	メトリックストピック送信先に送信されるメトリックスメッセージの有効期間 (秒単位)

クラスタ設定プロパティー

表 14–9 に、ブローカクラスタに関する設定プロパティーを示します。

表 14–9 クラスタ設定に関するブローカプロパティー


プロパティー	データ型	デフォルト値	説明
`imq.cluster.brokerlist` [クラスタ内のすべてのブローカで同じ値にする必要があります]	文字列	なし	ブローカのアドレスのリストリストは、コンマ区切りの複数のアドレスで構成します。各アドレスでは、クラスタ内のブローカのホスト名とポートマッパーのポート番号を、`hostName:` `portNumber` の形式で指定します。例: `host1:3000,host2:8000,ctrlhost`
`imq.cluster.hostname` [クラスタ内のブローカごとに個別に指定できます]	文字列	なし	`cluster` 接続サービスのホスト名または IP アドレス指定すると、`cluster` 接続サービスについて `imq.hostname` (表 14–1 を参照) が上書きされます
`imq.cluster.port`	整数	`0`	`cluster` 接続サービスのポート番号値 `0` は、ポート番号がポートマッパーによって動的に割り当てられることを示します。
`imq.cluster.transport`	文字列	`tcp`	`cluster` 接続サービスのネットワークトランスポートプロトコルブローカ間の安全で暗号化されたメッセージ配信を実現するためには、このプロパティーを `ssl` に設定します。
`imq.cluster.url`^, [`imqcmd update bkr` コマンドで使用できます]	文字列	なし	`cluster` 設定ファイルがある場合のファイルの URL 例: `http://webserver/imq/cluster.properties` (Web サーバー上のファイルの場合) `file:/net/mfsserver/imq/cluster.properties` (共有ドライブ上のファイルの場合)
`imq.cluster.masterbroker`	文字列	なし	クラスタのマスターブローカがある場合の、そのホスト名とポート番号値は `hostName:` `portNumber` の形式になります。`hostName` はマスターブローカのホスト名で、`portNumber` はマスターブローカのポートマッパーのポート番号です。例: `ctrlhost:7676`

ブローカプロパティーのアルファベット順の一覧

「ブローカプロパティーのアルファベット順の一覧」に、ブローカ設定プロパティーのアルファベット順の一覧と、この章内の関連する表への相互参照を示します。

表 14–10 ブローカプロパティーのアルファベット順の一覧


プロパティー	表
`imq.accesscontrol.enabled`	表 14–7
`imq.accesscontrol.file.filename`	表 14–7
`imq.audit.enabled`	表 14–7
`imq.authentication.basic.user_repository`	表 14–7
`imq.authentication.client.response.timeout`	表 14–7
`imq.authentication.type`	表 14–7
`imq.autocreate.destination.isLocalOnly`	表 14–3
`imq.autocreate.destination.limitBehavior`	表 14–3
`imq.autocreate.destination.maxBytesPerMsg`	表 14–3
`imq.autocreate.destination.maxNumMsgs`	表 14–3
`imq.autocreate.destination.maxNumProducers`	表 14–3
`imq.autocreate.destination.maxTotalMsgBytes`	表 14–3
`imq.autocreate.destination.useDMQ`	表 14–3
`imq.autocreate.queue`	表 14–3
`imq.autocreate.queue.consumerFlowLimit`	表 14–3
`imq.autocreate.queue.localDeliveryPreferred`	表 14–3
`imq.autocreate.queue.maxNumActiveConsumers`	表 14–3
`imq.autocreate.queue.maxNumBackupConsumers`	表 14–3
`imq.autocreate.topic`	表 14–3
`imq.autocreate.topic.consumerFlowLimit`	表 14–3
`imq.cluster.brokerlist`	表 14–9
`imq.cluster.hostname`	表 14–9
`imq.cluster.masterbroker`	表 14–9
`imq.cluster.port`	表 14–9
`imq.cluster.transport`	表 14–9
`imq.cluster.url`	表 14–9
`imq.destination.DMQ.truncateBody`	表 14–2
`imq.destination.logDeadMsgs`	表 14–8
`imq.hostname`	表 14–1
`imq.imqcmd.password`	表 14–7
`imq.keystore.file.dirpath`	表 14–7
`imq.keystore.file.name`	表 14–7
`imq.keystore.password`	表 14–7
`imq.keystore.propertyName`	表 14–7
`imq.log.console.output`	表 14–8
`imq.log.console.stream`	表 14–8
`imq.log.file.dirpath`	表 14–8
`imq.log.file.filename`	表 14–8
`imq.log.file.output`	表 14–8
`imq.log.file.rolloverbytes`	表 14–8
`imq.log.file.rolloversecs`	表 14–8
`imq.log.level`	表 14–8
`imq.log.syslog.facility`	表 14–8
`imq.log.syslog.identity`	表 14–8
`imq.log.syslog.logconsole`	表 14–8
`imq.log.syslog.logpid`	表 14–8
`imq.log.syslog.output`	表 14–8
`imq.log.timezone`	表 14–8
`imq.message.expiration.interval`	表 14–2
`imq.message.max_size`	表 14–2
`imq.metrics.enabled`	表 14–8
`imq.metrics.interval`	表 14–8
`imq.metrics.topic.enabled`	表 14–8
`imq.metrics.topic.interval`	表 14–8
`imq.metrics.topic.persist`	表 14–8
`imq.metrics.topic.timetolive`	表 14–8
`imq.passfile.dirpath`	表 14–7
`imq.passfile.enabled`	表 14–7
`imq.passfile.name`	表 14–7
`imq.persist.file.destination.message.filepool.limit`	表 14–5
`imq.persist.file.message.cleanup`	表 14–5
`imq.persist.file.message.filepool.cleanratio`	表 14–5
`imq.persist.file.message.max_record_size`	表 14–5
`imq.persist.file.sync.enabled`	表 14–5
`imq.persist.jdbc.brokerid`	表 14–6
`imq.persist.jdbc.closedburl`	表 14–6
`imq.persist.jdbc.createdburl`	表 14–6
`imq.persist.jdbc.driver`	表 14–6
`imq.persist.jdbc.needpassword`	表 14–6
`imq.persist.jdbc.opendburl`	表 14–6
`imq.persist.jdbc.password`	表 14–6
`imq.persist.jdbc.table.IMQCCREC35`	表 14–6
`imq.persist.jdbc.table.IMQDEST35`	表 14–6
`imq.persist.jdbc.table.IMQILIST35`	表 14–6
`imq.persist.jdbc.table.IMQINT35`	表 14–6
`imq.persist.jdbc.table.IMQMSG35`	表 14–6
`imq.persist.jdbc.table.IMQPROPS35`	表 14–6
`imq.persist.jdbc.table.IMQSV35`	表 14–6
`imq.persist.jdbc.table.IMQTACK35`	表 14–6
`imq.persist.jdbc.table.IMQTXN35`	表 14–6
`imq.persist.jdbc.user`	表 14–6
`imq.persist.store`	表 14–4
`imq.ping.interval`	表 14–1
`imq.portmapper.backlog`	表 14–1
`imq.portmapper.hostname`	表 14–1
`imq.portmapper.port`	表 14–1
`imq.resourceState` `.count`	表 14–2
`imq.resourceState` `.threshold`	表 14–2
`imq.service.activelist`	表 14–1
`imq.serviceName` `.accesscontrol.enabled`	表 14–7
`imq.serviceName` `.accesscontrol.file.filename`	表 14–7
`imq.serviceName` `.authentication.type`	表 14–7
`imq.serviceName` `.max_threads`	表 14–1
`imq.serviceName` `.min_threads`	表 14–1
`imq.serviceName` `.protocolType.hostname`	表 14–1
`imq.serviceName` `.protocolType.port`	表 14–1
`imq.serviceName` `.threadpool_model`	表 14–1
`imq.shared.connectionMonitor_limit`	表 14–1
`imq.system.max_count`	表 14–2
`imq.system.max_size`	表 14–2
`imq.transaction.autorollback`	表 14–2
`imq.user_repository.ldap.base`	表 14–7
`imq.user_repository.ldap.gidattr`	表 14–7
`imq.user_repository.ldap.grpbase`	表 14–7
`imq.user_repository.ldap.grpfilter`	表 14–7
`imq.user_repository.ldap.grpsearch`	表 14–7
`imq.user_repository.ldap.memattr`	表 14–7
`imq.user_repository.ldap.password`	表 14–7
`imq.user_repository.ldap.principal`	表 14–7
`imq.user_repository.ldap.propertyName`	表 14–7
`imq.user_repository.ldap.server`	表 14–7
`imq.user_repository.ldap.ssl.enabled`	表 14–7
`imq.user_repository.ldap.timeout`	表 14–7
`imq.user_repository.ldap.uidattr`	表 14–7
`imq.user_repository.ldap.usrfilter`	表 14–7

第 15 章物理的送信先のプロパティーのリファレンス

この章では、物理的送信先の設定プロパティーに関する参照情報を提供します。これらのプロパティーは、物理的送信先の作成時または更新時に設定できます。自動作成される送信先の場合は、ブローカのインスタンス設定ファイルにデフォルト値を設定します (表 14–3 を参照)。

物理的送信先のプロパティー

表 15–1 物理的送信先のプロパティー


プロパティー	データ型	デフォルト値	説明
`maxNumMsgs` [クラスタ環境では、クラスタ内のすべての送信先のインスタンスに一括ではなく、各インスタンスに個別に適用されます]	整数	`-1`	消費されていないメッセージの最大数値 `-1` は、メッセージ数が無制限であることを示します。デッドメッセージキューの場合、デフォルト値は `1000` です。
`maxBytesPerMsg`	文字列	`-1`	単一メッセージの最大サイズ (バイト単位) 持続メッセージの拒否は、プロデューシングクライアントに例外として報告されます。持続性のないメッセージの場合は、通知は送信されません。
			次の接尾辞を使用して、バイト、K バイト、または M バイトの単位で値を表すことができます。 `b`: バイト `k`: K バイト (1024 バイト) `m`: M バイト (1024 x 1024 = 1,048,576 バイト)
			接尾辞を付けない値は、バイト単位になります。値 `-1` は、メッセージサイズが無制限であることを示します。
			例: `1600`: 1600 バイト `1600b`: 1600 バイト `16k`: 16K バイト (= 16,384 バイト) `16m`: 16M バイト (= 16,777,216 バイト) `-1`: 無制限
`maxTotalMsgBytes`	文字列	`-1`	消費されていないメッセージの最大合計メモリー (バイト単位) 構文は `maxBytesPerMsg` と同じです (前述の説明を参照)。デッドメッセージキューの場合、デフォルト値は `10m` です。
`limitBehavior`	文字列	`REJECT_NEWEST`	メモリー制限のしきい値に達したときのブローカの動作 `FLOW_CONTROL`: プロデューサの処理速度を下げます `REMOVE_OLDEST`: もっとも古いメッセージを破棄します `REMOVE_LOW_PRIORITY`: 有効期限に従ってもっとも優先度の低いメッセージを破棄します。プロデューシングクライアントには通知しません `REJECT_NEWEST`: もっとも新しいメッセージを拒否します。持続メッセージの場合のみ、プロデューシングクライアントに例外を通知します
			値が `REMOVE_OLDEST` または `REMOVE_LOW_PRIORITY` で、`useDMQ` プロパティーが `true` の場合、超過したメッセージはデッドメッセージキューに移動されます。デッドメッセージキューは、デフォルトの制限動作が `REMOVE_OLDEST` であり、`FLOW_CONTROL` には設定できません。
`maxNumProducers` [デッドメッセージキューには設定できません]	整数	`-1`	送信先のメッセージプロデューサの最大数この制限に達すると、新しいプロデューサを作成できません。値 `-1` は、プロデューサ数が無制限であることを示します。
`maxNumActiveConsumers` [キュー送信先のみ。]	整数	`1`	キュー送信先からのロードバランスされた配信でアクティブにするメッセージコンシューマの最大数値 `-1` は、コンシューマ数が無制限であることを示します。Sun Java System Message Queue^TM Platform Edition では、この値は `2` に制限されます。
`maxNumBackupConsumers`	整数	`0`	キュー送信先からのロードバランスされた配信でバックアップにするメッセージコンシューマの最大数値 `-1` は、コンシューマ数が無制限であることを示します。Sun Java System Message Queue Platform Edition では、この値は `1` に制限されます。
`consumerFlowLimit`	整数	`1000`	コンシューマに単一のバッチで配信するメッセージの最大数ロードバランスされたキュー配信では、ロードバランスが開始されるまでの、アクティブコンシューマにルーティングされるキュー内のメッセージの初期数になります。送信先コンシューマは、接続で低い値を指定することで、この制限を上書きできます。値 `-1` は、メッセージ数が無制限であることを示します。
`isLocalOnly`	ブール	`false`	ローカル配信のみかどうかこのプロパティーは、ブローカクラスタ内の送信先のみに適用されます。送信先の作成後は変更できません。`true` の場合、送信先はほかのブローカに複製されず、ローカルコンシューマ (送信先が作成されたブローカに接続しているコンシューマ) だけにメッセージを配信するように制限されます。
`localDeliveryPreferred` ^,	ブール	`false`	ローカル配信優先かどうかこのプロパティーは、ブローカクラスタ内のロードバランスされたキュー配信のみに適用されます。`true` の場合、メッセージは、ローカルブローカにコンシューマがない場合にのみリモートコンシューマに配信されます。送信先をローカルのみの配信に制限しないでください。つまり、`isLocalOnly` を `false` にする必要があります。
`useDMQ`	ブール	`true`	デッドメッセージをデッドメッセージキューに送信するかどうか `false` の場合、デッドメッセージは単に破棄されます。

第 16 章管理対象オブジェクト属性のリファレンス

この章では、管理対象オブジェクトの属性に関する参照情報を提供します。この章は、次の節から構成されています。

接続ファクトリの属性

接続ファクトリオブジェクトの属性は、以下の節で説明する次のカテゴリに分けられます。

接続の処理

表 16–1 に、接続処理に関する接続ファクトリ属性を示します。

表 16–1 接続の処理に関する接続ファクトリ属性


属性	データ型	デフォルト値	説明
`imqAddressList`	文字列	既存の Message Queue^TM 3.0 アドレス、またはそれがない場合は表 16–2 の最初のエントリ	ブローカのアドレスのリストリストは、コンマ区切りの 1 つ以上のブローカアドレスから構成されます。各アドレスでは、クライアントが接続できるブローカインスタンスのホスト名、ポート番号、および接続サービスを明示的または暗黙的に指定します。アドレスの構文は、接続サービスとポートの割り当て方法によって異なります。詳細については、後述の説明を参照してください。
`imqAddressListBehavior`	文字列	`PRIORITY`	ブローカアドレスに接続を試行する順序 `PRIORITY`: アドレスリストに指定されている順序 `RANDOM`: ランダムな順序注 – 多数のクライアントが同じ接続ファクトリを共有する場合は、すべてのクライアントが同じアドレスに接続を試行するのを避けるために、ランダムな接続順序を指定してください。
`imqAddressListIterations`	整数	`5`	接続の確立または再確立を試行する際にアドレスリストを繰り返す回数値 `-1` は、繰り返し回数が無制限であることを示します。
`imqPingInterval`	整数	`30`	クライアントとブローカ間のテスト接続の間隔 (秒単位) 値 `0` または `-1` を指定すると、接続の定期的なテストが無効になります。
`imqReconnectEnabled`	ブール	`false`	失われた接続の再確立を試行するかどうか
`imqReconnectAttempts`	整数	`0`	アドレスリスト内の次のアドレスに移る前に、各アドレスに接続または再接続を試行する回数値 `-1` は、接続の試行回数が無制限であることを示します。この場合、成功するまで、最初のアドレスに繰り返し接続が試行されます。
`imqReconnectInterval`	倍長整数	`3000`	再接続を試行する間隔 (ミリ秒単位) この値は、特定のアドレスに対する連続する試行と、リスト内の連続するアドレスに対する試行の両方に適用されます。注 – 値が小さすぎると、ブローカが回復するのに十分な時間が与えられない可能性があります。値が大きすぎると、許容できない接続遅延が発生する可能性があります。
`imqSSLIsHostTrusted`	ブール	`true`	ブローカが提示する証明書を信頼するかどうか `false` の場合、Message Queue クライアントランタイムは提示された証明書をすべて検証します。証明書の署名者がクライアントのトラストストアに存在しない場合、検証は失敗します。 `true` の場合、証明書の検証はスキップされます。これは、自己署名付きの証明書を使用するソフトウェアテストなどに便利です。注:認証局からの署名付き証明書を使用するには、この属性を `false` に設定します。

imqAddressList 属性の値は、接続先のブローカのアドレスを 1 つ以上指定するコンマ区切りの文字列です。各アドレスの一般的な構文は、次のようになります。

   
scheme://address

scheme には、表 16–2 に示すアドレススキーマのいずれかを指定し、address には、ブローカのアドレス自体を指定します。アドレスを指定するための正確な構文は、表の最後の列に示すように、アドレススキーマによって異なります。

表 16–2 メッセージブローカのアドレススキーマ


スキーマ	サービス	構文	説明
`mq`	`jms` または `ssljms`	[`hostName`][`:portNumber` ][`/serviceName`]	`jms` または `ssljms` 接続サービスで、ポートを動的に割り当てます。アドレスリストのエントリには、Message Queue ポートマッパーのホスト名とポート番号を指定します。ポートマッパー自体が、接続に使用するポートを動的に割り当てます。デフォルト値: `hostName` = `localhost` `portNumber` = `7676` `serviceName` = `jms` `ssljms` 接続サービスでは、すべての変数を明示的に指定する必要があります。
`mqtcp`	`jms`	`hostName:portNumber` `/jms`	`jms` 接続サービスを使用して、指定されたポートに接続します。ポートマッパーをバイパスし、指定されたホスト名とポート番号に対して直接、TCP 接続を作成します。
`mqssl`	`ssljms`	`hostName:portNumber` `/ssljms`	`ssljms` 接続サービスを使用して、指定されたポートに接続します。ポートマッパーをバイパスし、指定されたホスト名とポート番号に対して直接、安全な SSL 接続を作成します。
`http`	`httpjms`	`http://hostName:` `portNumber/contextRoot` `/tunnel` 複数のブローカインスタンスが同じトンネルサーブレットを使用する場合、次の構文では、ランダムに選択されたブローカインスタンスではなく、特定のブローカインスタンスに接続します。 `http://hostName:` `portNumber/contextRoot` `/tunnel?` `ServerName=hostName` `:instanceName`	`httpjms` 接続サービスを使用して、指定されたポートに接続します。指定された URL の Message Queue トンネルサーブレットに対して、HTTP 接続を作成します。HTTP トンネルサーブレットにアクセスするように、ブローカを設定する必要があります。
`https`	`httpsjms`	`https://hostName:` `portNumber/contextRoot` `/tunnel` 複数のブローカインスタンスが同じトンネルサーブレットを使用する場合、次の構文では、ランダムに選択されたブローカインスタンスではなく、特定のブローカインスタンスに接続します。 `https://hostName:` `portNumber/contextRoot` `/tunnel?` `ServerName=hostName` `:instanceName`	`httpsjms` 接続サービスを使用して、指定されたポートに接続します。指定された URL の Message Queue トンネルサーブレットに対して、安全な HTTPS 接続を作成します。HTTPS トンネルサーブレットにアクセスするように、ブローカを設定する必要があります。

表 16–3 メッセージブローカアドレスの例


サービス	ブローカホスト	ポート	アドレス例
未指定	未指定	未指定	アドレスなし (`mq://localHost:7676/jms`)
未指定	指定したホスト	未指定	`myBkrHost` (`mq://myBkrHost:7676/jms`)
未指定	未指定	指定したポートマッパーポート	`1012` (`mq://localHost:1012/jms`)
`ssljms`	ローカルホスト	標準のポートマッパーポート	`mq://localHost:7676/ssljms`
`ssljms`	指定したホスト	標準のポートマッパーポート	`mq://myBkrHost:7676/ssljms`
`ssljms`	指定したホスト	指定したポートマッパーポート	`mq://myBkrHost:1012/ssljms`
`jms`	ローカルホスト	指定したサービスポート	`mqtcp://localhost:1032/jms`
`ssljms`	指定したホスト	指定したサービスポート	`mqssl://myBkrHost:1034/ssljms`
`httpjms`	該当なし	該当なし	`http://websrvr1:8085/imq/tunnel`
`httpsjms`	該当なし	該当なし	`https://websrvr2:8090/imq/tunnel`

クライアントの識別

表 16–4 に、クライアント識別に関する接続ファクトリ属性を示します。

表 16–4 クライアントの識別に関する接続ファクトリ属性


属性	データ型	デフォルト値	説明
`imqDefaultUsername`	文字列	`guest`	ブローカで認証するデフォルトユーザー名
`imqDefaultPassword`	文字列	`guest`	ブローカで認証するデフォルトパスワード
`imqConfiguredClientID`	文字列	`null`	管理用に設定したクライアント識別子
`imqDisableSetClientID`	ブール	`false`	クライアントが `setClientID`メソッドを使用してクライアント識別子を変更できないようにするかどうか

信頼性およびフロー制御

表 16–5 に、信頼性とフロー制御に関する接続ファクトリ属性を示します。

表 16–5 信頼性とフロー制御に関する接続ファクトリ属性


属性	データ型	デフォルト値	説明
`imqAckTimeout`	文字列	`0`	例外をスローするまでのブローカ通知の最大待ち時間 (ミリ秒単位) 値 `0` は、タイムアウトがない、つまり無期限に待つことを示します。注 – 状況によっては、値が低すぎると、タイムアウトが必要以上に早くなる可能性があります。たとえば、安全な (SSL) 接続を使用するときの LDAP ユーザーリポジトリに対する最初のユーザー認証には、30 秒以上かかることがあります。
`imqConnectionFlowCount`	整数	`100`	測定対象のバッチのペイロードメッセージ数クライアントにこの数のペイロードメッセージを配信したあと、配信を一時停止します。これにより、累積された制御メッセージがある場合は、それを配信できます。ペイロードメッセージの配信は、クライアントランタイムから通知があったときに再開され、ふたたびこの数に達するまで続けられます。値 `0` では、メッセージ配信の測定が無効になります。この場合、ペイロードメッセージのトラフィックが多いと、Message Queue 制御メッセージがブロックされる可能性があります。
`imqConnectionFlowLimitEnabled`	ブール	`false`	接続レベルでメッセージフローを制限するかどうか
`imqConnectionFlowLimit`	整数	`1000`	接続単位での、消費のために配信およびバッファリングするメッセージの最大数 `imqConnectionFlowCount` で制御されるフロー測定によって保留中の消費されていないペイロードメッセージ数がこの制限を越えたときに、特定の接続のメッセージ配信を停止します。保留中のメッセージの数が制限を下回ったときにのみ、配信を再開します。これにより、クライアントが、保留中のメッセージの処理で過負荷になってメモリー不足になるのを回避できます。 `imqConnectionFlowLimitEnabled` が `false` の場合、この属性は無視されます。
`imqConsumerFlowLimit`	整数	`100`	コンシューマ単位での、消費のために配信およびバッファリングするメッセージの最大数特定のコンシューマに対して保留中の消費されていないペイロードメッセージ数がこの制限を超えたときに、そのコンシューマへのメッセージ配信を停止します。そのコンシューマに対する保留中のメッセージの数が、`imqConsumerFlowThreshold` で指定される割合を下回ったときにのみ、配信を再開します。これを使用して、複数のコンシューマ間のロードバランスを向上させ、同じ接続上で 1 つのコンシューマがほかのコンシューマの通信を妨げるのを回避できます。キュー独自の `consumerFlowLimit` 属性 (第 15 章「物理的送信先のプロパティーのリファレンス」を参照) に低い値を設定することで、この制限を上書きできます。また、特定の接続上のすべてのコンシューマへのメッセージ配信は、`imqConnectionFlowLimit` で指定する全体の制限に従います。
`imqConsumerFlowThreshold`	整数	`50`	コンシューマ単位での、クライアントランタイムでバッファリングされるメッセージ数。`imqConsumerFlowLimit` に対する割合で指定し、その数を下回るとメッセージ配信を再開します

キューブラウザとサーバーセッション

表 16–6 に、キュー検索とサーバーセッションに関する接続ファクトリ属性を示します。

表 16–6 キューブラウザとサーバーセッションに関する接続ファクトリ属性


属性	データ型	デフォルト値	説明
`imqQueueBrowserMaxMessagesPerRetrieve`	整数	`1000`	キュー送信先の内容を検索するときに一度に取得できるメッセージの最大数注 – この属性は、参照されるメッセージの総数には影響せず、クライアントランタイムに配信するためにチャンクされる方法だけに影響します。つまり、サイズの大きいチャンクを少数にするか、サイズの小さいチャンクを多数にするか、です。クライアントアプリケーションは、キュー内のすべてのメッセージを常に受信します。属性の値の変更は、パフォーマンスに影響することがありますが、受信するデータの総量には影響しません。
`imqQueueBrowserRetrieveTimeout`	倍長整数	`60000`	キュー送信先の内容を検索するときに例外をスローするまでのメッセージ取得の最大待ち時間 (ミリ秒単位)
`imqLoadMaxToServerSession`	ブール	`true`	サーバーセッションに対して最大数までのメッセージを読み込むかどうか `false` に設定すると、クライアントは、1 回に 1 つのメッセージのみを読み込みます。この属性は、JMS アプリケーションサーバー機能のみに適用されます。

標準メッセージプロパティー

表 16–7 に示す接続ファクトリ属性は、『Java Message Service Specification』で定義されているいくつかの標準メッセージプロパティーを、Message Queue クライアントランタイムが設定するかどうかを制御します。

表 16–7 標準メッセージプロパティーに関する接続ファクトリ属性


プロパティー	データ型	デフォルト値	説明
`imqSetJMSXUserID`	ブール	`false`	生成されたメッセージに、メッセージを送信するユーザーの識別情報を示す `JMSXUserID` プロパティーを設定するかどうか
`imqSetJMSXAppID`	ブール	`false`	生成されたメッセージに、メッセージを送信するアプリケーションの識別情報を示す `JMSXAppID` プロパティーを設定するかどうか
`imqSetJMSXProducerTXID`	ブール	`false`	生成されたメッセージに、メッセージが生成されたトランザクションのトランザクション識別子を示す `JMSXProducerTXID` プロパティーを設定するかどうか
`imqSetJMSXConsumerTXID`	ブール	`false`	消費されたメッセージに、メッセージが消費されたトランザクションのトランザクション識別子を示す `JMSXConsumerTXID` プロパティーを設定するかどうか
`imqSetJMSXRcvTimestamp`	ブール	`false`	消費されたメッセージに、メッセージがコンシューマに配信された時刻を示す `JMSXRcvTimestamp` プロパティーを設定するかどうか

メッセージヘッダーの上書き

表 16–8 に、JMS メッセージヘッダーフィールドの上書きに関する接続ファクトリ属性を示します。

表 16–8 メッセージヘッダーの上書きに関する接続ファクトリ属性


属性	データ型	デフォルト値	説明
`imqOverrideJMSDeliveryMode`	ブール	`false`	クライアントが設定した配信モードの上書きを許可するかどうか
`imqJMSDeliveryMode`	整数	`2`	配信モードの上書きの値 `1` 持続性なし `2` 持続的
`imqOverrideJMSExpiration`	ブール	`false`	クライアントが設定した有効期限の上書きを許可するかどうか
`imqJMSExpiration`	倍長整数	`0`	有効期限の上書きの値 (ミリ秒単位) 値 `0` は、有効期限が無制限である、つまりメッセージが期限切れにならないことを示します。
`imqOverrideJMSPriority`	ブール	`false`	クライアントが設定した優先度のレベルの上書きを許可するかどうか
`imqJMSPriority`	整数	`4` (標準)	優先度のレベルの上書きの値 (`0` 〜 `9`)
`imqOverrideJMSHeadersToTemporaryDestinations`	ブール	`false`	上書きを一時的送信先に適用するかどうか

送信先の属性

表 16–9 に、送信先管理対象オブジェクトに設定できる属性を示します。

表 16–9 送信先の属性


属性	データ型	デフォルト値	説明
`imqDestinationName`	文字列	`Untitled_Destination_Object`	物理的送信先の名前送信先名は、スペースを含まない英数字だけを使用でき、英字、下線 (`_`)、またはドル記号 (`$`) 文字で始める必要があります。文字列 `mq` で始めることはできません。
`imqDestinationDescription`	文字列	なし	送信先の説明文字列

SOAP の端点 (endpoint) の属性

表 16–10 に、SOAP (Simple Object Access Protocol) を使用するアプリケーションの端点の URL を設定するために使用する属性を示します。詳細については、『Message Queue Developer's Guide for Java Clients』を参照してください。

表 16–10 SOAP の端点 (endpoint) の属性


属性	データ型	デフォルト値	説明
`imqSOAPEndpointList`	文字列	なし	メッセージ送信先の SOAP の端点を表す 1 つ以上の URL のスペース区切りのリストそれぞれの URL は、SOAP メッセージを受信および処理できるサーブレットに関連付けられている必要があります。例: `http://www.serv1/ http://www.serv2/` リストで複数の URL を指定すると、メッセージはそれらすべてにブロードキャストされます。
`imqEndpointName`	文字列	`Untitled_Endpoint_Object`	SOAP の端点の名前
`imqEndpointDescription`	文字列	なし	SOAP の端点の説明文字列例: `My endpoints for broadcast`

第 17 章 JMS リソースアダプタのプロパティーのリファレンス

この章では、Message Queue^TM の JMS リソースアダプタ (JMS RA) の設定プロパティーについて説明します。この JMS リソースアダプタを使用すると、標準的な J2EE コネクタアーキテクチャー (JCA) により、Sun Java System^TM Message Queue を任意の J2EE 1.4 アプリケーションサーバーと統合できます。リソースアダプタをプリケーションサーバーに組み込むと、そのアプリケーションサーバーに配備したアプリケーションが、Message Queue を使用して JMS メッセージを送受信できるようになります。

Message Queue の JMS リソースアダプタでは、次の 3 つの JavaBean コンポーネントを介して設定プロパティーが公開されます。

ResourceAdapter JavaBean (「ResourceAdapter JavaBean」): リソースアダプタ全体の動作に影響します。
ManagedConnectionFactory JavaBean (「ManagedConnectionFactory JavaBean」): メッセージ駆動型 Bean (MDB) が使用するためにリソースアダプタが作成した接続に影響します。
ActivationSpec JavaBean (「ActivationSpec JavaBean」): メッセージングシステムとのやり取りの中で MDB を表すメッセージの終端に影響します。

これらのエンティティーのプロパティー値を設定するには、リソースアダプタの設定用と配備用、および MDB の配備用にアプリケーションサーバーによって提供されるツールを使用します。

この章では、Message Queue の JMS リソースアダプタの設定プロパティーを一覧表示して説明します。この章は、次の節から構成されています。

ResourceAdapter JavaBean

ResourceAdapter 設定では、JMS リソースアダプタのデフォルト動作を設定します。表 17–1 で、この JavaBean を設定するためのプロパティーを一覧表示して説明します。

表 17–1 リソースアダプタのプロパティー


プロパティー	データ型	デフォルト値	説明
`addressList`	文字列	`mq://localhost:7676/jms`	(必須) Message Queue サービスに接続するためのメッセージサービスのアドレス次に示す `connectionURL` と同じものです。いずれか一方を設定する必要があります。
`connectionURL`	文字列	`mq://localhost:7676/jms`	Message Queue サービスに接続するためのメッセージサービスのアドレス上記の `addressList` と同じものです。いずれか一方を設定する必要があります。
`userName`	文字列	`guest`	(必須) Message Queue サービスに接続するためのデフォルトユーザー名
`password`	文字列	`guest`	(必須) Message Queue サービスに接続するためのデフォルトパスワード
`addressListBehavior`	文字列	`PRIORITY`	Message Queue サービスに接続を試行する順序。 `PRIORITY`: アドレスリストに指定されている順序 `RANDOM`: ランダムな順序注 – 接続障害後の再接続の試行は、接続がエラーになったブローカから始まり、このプロパティーに設定された値にかかわらず、アドレスリストを順番に処理します。
`addressListIterations`	整数	`1`	接続の確立または再確立を試行する際にアドレスリストを繰り返す回数
`reconnectEnabled`	ブール	`false`	失われた接続の再確立を試行するかどうか
`reconnectAttempts`	整数	`6`	アドレスリスト内の次のアドレスに移る前に、各アドレスに再接続を試行する回数
`reconnectInterval`	倍長整数	`30000`	再接続を試行する間隔 (ミリ秒単位)

ManagedConnectionFactory JavaBean

管理対象接続ファクトリでは、リソースアダプタがメッセージ駆動型 Bean に提供する接続の定義を行います。表 17–2 では、ManagedConnectionFactory JavaBean のプロパティーを示します。これらのプロパティーが設定された場合、ResourceAdapter JavaBean の対応するプロパティーは上書きされます。

表 17–2 管理対象接続ファクトリのプロパティー


プロパティー	データ型	デフォルト値	説明
`addressList`	文字列	`ResourceAdapter` JavaBean (表 17–1 を参照) から継承	Message Queue サービスに接続するためのメッセージサービスのアドレスのリスト
`userName`	文字列	`guest`	(任意指定) Message Queue サービスに接続するためのユーザー名
`password`	文字列	`guest`	(任意指定) Message Queue サービスに接続するためのパスワード
`clientID`	文字列	なし	Message Queue サービスに接続するためのクライアント識別子
`addressListBehavior`	文字列	`PRIORITY`	Message Queue サービスに接続を試行する順序。 `PRIORITY`: アドレスリストに指定されている順序 `RANDOM`: ランダムな順序注 – 接続障害後の再接続の試行は、接続がエラーになったブローカから始まり、このプロパティーに設定された値にかかわらず、アドレスリストを順番に処理します。
`addressListIterations`	整数	`1`	接続の確立または再確立を試行する際にアドレスリストを繰り返す回数
`reconnectEnabled`	ブール	`false`	失われた接続の再確立を試行するかどうか
`reconnectAttempts`	整数	`6`	アドレスリスト内の次のアドレスに移る前に、各アドレスに再接続を試行する回数
`reconnectInterval`	倍長整数	`30000`	再接続を試行する間隔 (ミリ秒単位)

ActivationSpec JavaBean

表 17–3に、ActivationSpec JavaBean の設定可能なプロパティーを示します。アプリケーションサーバーは、これらのプロパティーを使用してメッセージ終端をアクティブにし、それらとメッセージ駆動型 Bean を関連付けるようにリソースアダプタに命令します。

表 17–3 アクティブ化仕様のプロパティー


プロパティー	データ型	デフォルト値	説明
`addressList` [Message Queue JMS リソースアダプタに固有のプロパティー]	文字列	`ResourceAdapter` JavaBean から継承	(任意指定) Message Queue サービスに接続するためのメッセージサービスのアドレス
`destination` [標準的な Enterprise JavaBean (EJB) および J2EE コネクタアーキテクチャー (CA) のプロパティー]	文字列	なし	(必須) メッセージを消費する送信先の名前値は、Message Queue の送信先管理対象オブジェクトの `destinationName` プロパティーの値にする必要があります。
`destinationType`	文字列	なし	(必須) `destination` プロパティーで指定した次のいずれかの送信先のタイプ。 `javax.jms.Queue`: キュー送信先 `javax.jms.Topic`: トピック送信先
`messageSelector`	文字列	なし	(任意指定) コンシューマに配信されるメッセージのフィルタリングに使用するメッセージセレクタ
`subscriptionName`	文字列	なし	永続サブスクリプションの名前 `subscriptionDurability` が `Durable` に設定されている場合は、このプロパティーを設定する必要があります。
`subscriptionDurability`	文字列	`NonDurable`	トピック送信先のコンシューマが永続的であるかどうか。 `Durable`: 永続コンシューマ `NonDurable`: 永続的でないコンシューマこのプロパティーは、`destinationType` を`javax.jms.Topic` に設定した場合にのみ有効です。また、永続的でないサブスクリプションでは任意指定であり、永続サブスクリプションでは必須です。`Durable` に設定した場合は、`clientID` プロパティーと `subscriptionName` プロパティーも設定する必要があります。
`clientId`	文字列	なし	Message Queue サービスに接続するためのクライアント ID `subscriptionDurability` を `Durable` に設定した場合は、このプロパティーを設定する必要があります。
`acknowledgeMode`	文字列	`Auto-acknowledge`	(任意指定) 次のいずれかの通知モード。 `Auto-acknowledge`: Auto-acknowledge モード `Dups-ok-acknowledge`: Dups-OK-acknowledge モード
`customAcknowledgeMode`	文字列	なし	MDB メッセージの消費に使用する通知モード有効な値は、`No_acknowledge` または NULL です。 no-acknowledge モードは、処理済みでも永続的でもないトピックサブスクリプションのみに使用できます。処理済みサブスクリプションか永続サブスクリプションでこの設定を使用すると、サブスクリプションのアクティブ化はエラーになります。
`endpointExceptionRedeliveryAttempts`	整数	`6`	メッセージ配信中に MDB で例外がスローされたとき、メッセージを再配信する回数
`sendUndeliverableMsgsToDMQ`	ブール	`true`	MDB で実行時例外がスローされ、再配信回数が `endpointExceptionRedeliveryAttempts` の値を超えたとき、デッドメッセージキューにメッセージを配置するかどうか `false` に設定した場合、Message Queue ブローカは、同一 MDB も含めた有効なコンシューマにメッセージを再配信しようとします。

第 18 章メトリックスのリファレンス

この章では、監視、調整、および診断用に、Message Queue^TM メッセージブローカが提供できるメトリックス情報について説明します。この情報は、次のようなさまざまな方法で入手できます。

ログファイル (「ログファイルへのメトリックスデータの送信」を参照)
コマンドユーティリティーの metrics bkr コマンドを使用 (「ブローカ管理」を参照)
メトリックストピック送信先に送信されるメトリックスメッセージ (「ブローカを監視するアプリケーションの作成」を参照)

この章に記載されている表は、入手可能なメトリックス情報の種類とそれらを提供できる形式を一覧表示しています。コマンドユーティリティーの metrics bkr コマンドによって提供されるメトリックスの場合、表には、要求の応答に使用できるメトリックスタイプが一覧表示されています。また、メトリックスメッセージで提供されるメトリックスの場合、表には、それらが配信されるメトリックストピック送信先が一覧表示されています。この章は、次の節から構成されています。

JVM メトリックス

表 18–1 では、ブローカプロセスの JVM (Java 仮想マシン) ヒープについてブローカが報告するメトリックス情報を一覧表示します。

表 18–1 JVM メトリックス


メトリックス量	説明	ログファイル	`metrics` `bkr` メトリックスタイプ	メトリックストピック
JVM heap: total memory	現在の合計メモリー (バイト単位)	あり	`cxn`	`mq.metrics.jvm`
JVM heap: free memory	現在使用可能なメモリー量 (バイト単位)	あり	`cxn`	`mq.metrics.jvm`
JVM heap: max memory	許容可能な最大ヒープサイズ (バイト単位)	あり	なし	`mq.metrics.jvm`

ブローカ全体のメトリックス

表 18–2 では、ブローカが報告するブローカ全体のメトリックス情報を示します。

表 18–2 ブローカ全体のメトリックス


メトリックス量	説明	ログファイル	`metrics` `bkr` メトリックスタイプ	メトリックストピック
接続
Num connections	すべての接続サービスの現在の合計接続数	あり	`cxn`	`mq.metrics.broker`
Num threads	すべての接続サービスの現在の合計スレッド数	あり	`cxn`	なし
Min threads	すべての接続サービスの最小合計スレッド数	あり	`cxn`	なし
Max threads	すべての接続サービスの最大合計スレッド数	あり	`cxn`	なし
格納済みメッセージ
Num messages	メモリーと持続ストアに格納されているペイロードメッセージの現在の数	なし	なし [代わりに `query` `bkr` コマンドを使用]	`mq.metrics.broker`
Total message bytes	現在、メモリーと持続ストアに格納されているペイロードメッセージの合計サイズ (バイト単位)	なし	なし	`mq.metrics.broker`
メッセージフロー
Num messages in	ブローカの起動後に受信したペイロードメッセージの累積数	あり	`ttl`	`mq.metrics.broker`
Num messages out	ブローカの起動後に送信したペイロードメッセージの累積数	あり	`ttl`	`mq.metrics.broker`
Rate messages in	ブローカで受信するペイロードメッセージの現在のフローレート	あり	`rts`	なし
Rate messages out	ブローカから送信するペイロードメッセージの現在のフローレート	あり	`rts`	なし
Message bytes in	ブローカの起動後に受信したペイロードメッセージの累積サイズ (バイト単位)	あり	`ttl`	`mq.metrics.broker`
Message bytes out	ブローカの起動後に送信したペイロードメッセージの累積サイズ (バイト単位)	あり	`ttl`	`mq.metrics.broker`
Rate message bytes in	ブローカで受信するペイロードメッセージバイト数の現在のフローレート	あり	`rts`	なし
Rate message bytes out	ブローカから送信するペイロードメッセージバイト数の現在のフローレート	あり	`rts`	なし
Num packets in	ブローカの起動後に受信したペイロードと制御パケットの累積数	あり	`ttl`	`mq.metrics.broker`
Num packets out	ブローカの起動後に送信したペイロードと制御パケットの累積数	あり	`ttl`	`mq.metrics.broker`
Rate packets in	ブローカで受信するペイロードと制御パケットの現在のフローレート	あり	`rts`	なし
Rate packets out	ブローカから送信するペイロードと制御パケットの現在のフローレート	あり	`rts`	なし
Packet bytes in	ブローカの起動後に受信したペイロードと制御パケットの累積サイズ (バイト単位)	あり	`ttl`	`mq.metrics.broker`
Packet bytes out	ブローカの起動後に送信したペイロードと制御パケットの累積サイズ (バイト単位)	あり	`ttl`	`mq.metrics.broker`
Rate packet bytes in	ブローカで受信するペイロードと制御パケットのバイト数の現在のフローレート	あり	`rts`	なし
Rate packet bytes out	ブローカから送信するペイロードと制御パケットのバイト数の現在のフローレート	あり	`rts`	なし
送信先
Num destinations	物理的送信先の現在の数	なし	なし	`mq.metrics.broker`

接続サービスのメトリックス

表 18–3 では、個々の接続サービスについてブローカが報告するメトリックス情報を示します。

表 18–3 接続サービスのメトリックス


メトリックス量	説明	ログファイル	`metrics` `svc` メトリックスタイプ	メトリックストピック
接続
Num connections	現在の接続数	なし	`cxn` [`query` `svc` コマンドでも入手可能]	なし
Num threads	現在のスレッド数	なし	`cxn`	なし
Min threads	サービスに割り当てられるスレッドの最小数	なし	`cxn`	なし
Max threads	サービスに割り当てられるスレッドの最大数	なし	`cxn`	なし
メッセージフロー
Num messages in	ブローカの起動後に接続サービス経由で受信したペイロードメッセージの累積数	なし	`ttl`	なし
Num messages out	ブローカの起動後に接続サービス経由で送信したペイロードメッセージの累積数	なし	`ttl`	なし
Rate messages in	接続サービス経由でブローカが受信するペイロードメッセージの現在のフローレート	なし	`rts`	なし
Rate messages out	接続サービス経由でブローカから送信するペイロードメッセージの現在のフローレート	なし	`rts`	なし
Message bytes in	ブローカの起動後に接続サービス経由で受信したペイロードメッセージの累積サイズ (バイト単位)	なし	`ttl`	なし
Message bytes out	ブローカの起動後に接続サービス経由で送信したペイロードメッセージの累積サイズ (バイト単位)	なし	`ttl`	なし
Rate message bytes in	接続サービス経由でブローカが受信するペイロードメッセージバイト数の現在のフローレート	なし	`rts`	なし
Rate message bytes out	接続サービス経由でブローカから送信するペイロードメッセージバイト数の現在のフローレート	なし	`rts`	なし
Num packets in	ブローカの起動後に接続サービス経由で受信したペイロードと制御パケットの累積数	なし	`ttl`	なし
Num packets out	ブローカの起動後に接続サービス経由で送信したペイロードと制御パケットの累積数	なし	`ttl`	なし
Rate packets in	接続サービス経由でブローカが受信するペイロードと制御パケットの現在のフローレート	なし	`rts`	なし
Rate packets out	接続サービス経由でブローカから送信するペイロードと制御パケットの現在のフローレート	なし	`rts`	なし
Packet bytes in	ブローカの起動後に接続サービス経由で受信したペイロードと制御パケットの累積サイズ (バイト単位)	なし	`ttl`	なし
Packet bytes out	ブローカの起動後に接続サービス経由で送信したペイロードと制御パケットの累積サイズ (バイト単位)	なし	`ttl`	なし
Rate packet bytes in	接続サービス経由でブローカが受信するペイロードと制御パケットのバイト数の現在のフローレート	なし	`rts`	なし
Rate packet bytes out	接続サービス経由でブローカから送信するペイロードと制御パケットのバイト数の現在のフローレート	なし	`rts`	なし

送信先メトリックス

表 18–4 では、個々の送信先についてブローカが報告するメトリックス情報を示します。

表 18–4 送信先メトリックス


メトリックス量	説明	ログファイル	`metrics` `dst` メトリックスタイプ	メトリックストピック
メッセージコンシューマ
Num consumers	関連付けられているメッセージコンシューマの現在の数キュー送信先の場合、この属性には、アクティブなコンシューマとバックアップコンシューマの両方が含まれます。トピック送信先の場合、これには、永続的でないサブスクライバ (アクティブおよび非アクティブ) と永続サブスクライバの両方が含まれます。これは、「Num active consumers」と同じです。	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Peak num consumers	ブローカの起動後の、関連付けられているメッセージコンシューマのピーク時の数キュー送信先の場合、この属性には、アクティブなコンシューマとバックアップコンシューマの両方が含まれます。トピック送信先の場合、これには、永続的でないサブスクライバ (アクティブおよび非アクティブ) と永続サブスクライバの両方が含まれます。これは、「Peak num active consumers」と同じです。	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Avg num consumers	ブローカの起動後の、関連付けられているメッセージコンシューマの数の平均キュー送信先の場合、この属性には、アクティブなコンシューマとバックアップコンシューマの両方が含まれます。トピック送信先の場合、これには、永続的でないサブスクライバ (アクティブおよび非アクティブ) と永続サブスクライバの両方が含まれます。これは、「Avg num active consumers」と同じです。	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Num active consumers	関連付けられているアクティブなメッセージコンシューマの現在の数トピック送信先の場合、この属性には、永続的でないサブスクライバ (アクティブおよび非アクティブ) と永続サブスクライバの両方が含まれます。これは、「Num consumers」と同じです。	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Peak num active consumers	ブローカの起動後の、関連付けられているアクティブなメッセージコンシューマのピーク時の数トピック送信先の場合、この属性には、永続的でないサブスクライバ (アクティブおよび非アクティブ) と永続サブスクライバの両方が含まれます。これは、「Peak num consumers」と同じです。	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Avg num active consumers	ブローカの起動後の、関連付けられているアクティブなメッセージコンシューマの数の平均トピック送信先の場合、この属性には、永続的でないサブスクライバ (アクティブおよび非アクティブ) と永続サブスクライバの両方が含まれます。これは、「Avg num consumers」と同じです。	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Num backup consumers [キュー送信先のみ]	関連付けられているバックアップメッセージコンシューマの現在の数	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Peak num backup consumers	ブローカの起動後の、関連付けられているバックアップメッセージコンシューマのピーク時の数	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Avg num backup consumers	ブローカの起動後の、関連付けられているバックアップメッセージコンシューマの数の平均	なし	`con`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
格納済みメッセージ
Num messages	メモリーと持続ストアに格納されているメッセージの現在の数	なし	`conttlrts` [`query` `dst` コマンドでも入手可能]	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Peak num messages	ブローカの起動後に、メモリーと持続ストアに格納されたメッセージのピーク時の数	なし	`conttlrts`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Avg num messages	ブローカの起動後に、メモリーと持続ストアに格納されたメッセージの数の平均	なし	`conttlrts`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Total message bytes	メモリーと持続ストアに格納されているメッセージの現在の合計サイズ (バイト単位)	なし	`ttlrts`	`mq.metrics.destination.queue.queueName` `mq.metrics.destination.topic.topicName`
Peak total message bytes	ブローカの起動後に、メモリーと持続ストアに格納されたメッセージの合計サイズ (バイト単位) のピーク	なし	`ttlrts`	`mq.metrics.destination.queue.queueName` `mq.metrics.destination.topic.topicName`
Avg total message bytes	ブローカの起動後に、メモリーと持続ストアに格納されたメッセージの合計サイズ (バイト単位) の平均	なし	`ttlrts`	`mq.metrics.destination.queue.queueName` `mq.metrics.destination.topic.topicName`
メッセージフロー
Num messages in	ブローカの起動後に受信したメッセージの累積数	なし	`ttl`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Num messages out	ブローカの起動後に送信したメッセージの累積数	なし	`ttl`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Msg bytes in	ブローカの起動後に受信したメッセージの累積サイズ (バイト単位)	なし	`ttl`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Msg bytes out	ブローカの起動後に送信したメッセージの累積サイズ (バイト単位)	なし	`ttl`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Peak message bytes	ブローカの起動後に受信した最大の単一メッセージのサイズ (バイト単位)	なし	`ttlrts`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Rate num messages in	受信したメッセージの現在のフローレート	なし	`rts`	なし
Rate num messages out	送信したメッセージの現在のフローレート	なし	`rts`	なし
Rate msg bytes in	受信したメッセージバイト数の現在のフローレート	なし	`rts`	なし
Rate msg bytes out	送信したメッセージバイト数の現在のフローレート	なし	`rts`	なし
ディスク利用率
Disk reserved [ファイルベースの持続のみ]	送信先用に予約されているディスク容量 (バイト単位)	なし	`dsk`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Disk used	送信先によって現在使用されているディスク容量 (バイト単位)	なし	`dsk`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`
Disk utilization ratio	送信先用に予約されているディスク容量に対する、使用されているディスク容量の割合	なし	`dsk`	`mq.metrics.destination.queue.` `queueNamemq.metrics.destination.topic.` `topicName`