4.2.2 DB Connectorのプロパティ定義
DB Connectorのプロパティを定義します。DB Connectorをデプロイしたあとでも実行できます。なお，デプロイ済みのDB Connectorのプロパティを変更する場合は，該当するDB Connectorを停止した状態で実行してください。
プロパティの設定手順については，「3.5 属性ファイルによるプロパティの設定」を参照してください。次にDB Connectorのプロパティ定義について説明します。
(1) 編集する属性ファイル
Connector属性ファイル
(2) 編集する属性ファイルの取得と属性の設定
-
属性ファイルの取得
次に示すコマンドを実行して，DB ConnectorのConnector属性ファイルを取得します。
- 実行形式
cjgetresprop ＜サーバ名称＞ ［-nameserver ＜プロバイダURL＞］ -type rar -resname ＜DB Connectorの表示名＞ -c ＜Connector属性ファイルパス＞
- 実行例
cjgetresprop MyServer -type rar -resname account-rar -c AccountProp.xml
-
属性の設定
次に示すコマンドを実行して，Connector属性ファイルの値を反映します。
- 実行形式
cjsetresprop ＜サーバ名称＞ ［-nameserver ＜プロバイダURL＞］ -type rar -resname ＜DB Connectorの表示名＞ -c ＜Connector属性ファイルパス＞
- 実行例
cjsetresprop MyServer -type rar -resname account-rar -c AccountProp.xml
- 注意事項
-
リソースアダプタをデプロイしたあとでプロパティを定義する場合は，cjgetrarpropコマンドとcjsetrarpropコマンドを使用してください。cjgetrarpropコマンドの詳細については，マニュアル「アプリケーションサーバ リファレンス コマンド編」の「cjgetrarprop（RARファイルの属性の取得）」を参照してください。cjsetrarpropコマンドの詳細については，マニュアル「アプリケーションサーバ リファレンス コマンド編」の「cjsetrarprop（RAR属性設定）」を参照してください。
(3) 編集する属性設定項目
DB Connectorのプロパティ設定項目を次に示します。
-
DB Connectorの一般情報
-
コンフィグレーションプロパティ
-
実行時プロパティ
-
別名情報
(a) DB Connectorの一般情報
設定できるDB Connectorの一般情報属性（<outbound-resourceadapter>タグ）の設定項目を次に示します。
|
項目 |
必須 |
対応するタグ |
|---|---|---|
|
トランザクションサポートのレベル |
○ |
<transaction-support> |
|
再認証のサポート有無 |
○ |
<reauthentication-support> |
（凡例） ○：必須
プロパティの設定項目については，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」の「4.1.1 Connector属性ファイルの指定内容」を参照してください。
(b) コンフィグレーションプロパティ
DB Connectorのコンフィグレーションプロパティ（<outbound-resourceadapter> - <connection-definition> - <config-property>タグ）の設定項目を次に示します。
|
項目 |
対応するタグ |
|---|---|
|
コンフィグレーションプロパティ名 |
<config-property-name> |
|
コンフィグレーションプロパティのデータ型 |
<config-property-type> |
|
コンフィグレーションプロパティの値 |
<config-property-value>※ |
- 注※
-
コンフィグレーションプロパティの値をクリアする場合，空タグ（<config-property-value></config-property-value>）を指定します。
<config-property-value>タグ自体がない場合は，コンフィグレーションプロパティの値は変更されません。
定義するコンフィグレーションプロパティの数だけ，<config-property>タグ下の設定を繰り返してください。
設定する必要がある項目は，インポートしたDB Connectorの種類によって一部異なります。<config-property>タグに設定できるプロパティについては，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」の「4.1.10 DB Connectorに設定する<config-property>タグに指定できるプロパティ」を参照してください。
なお，<config-property-name>タグに「XAOpenString」が設定されている場合，cjgetrespropコマンドを実行すると，コンフィグレーションプロパティの値（<config-property-value>）は次のように表示されます。
-
プロパティの値が設定されている場合
コンフィグレーションプロパティの値（<config-property-value>）は取得されないで，「<!-- The config-property-value has already been set. -->」と表示されます。
「XAOpenString」の値を変更する場合には，<config-property-value>タグを追加して，変更後の値を設定してください。
-
プロパティの値が設定されていない場合
空タグ（<config-property-value></config-property-value>）が表示されます。
「XAOpenString」の値を設定する場合には，<config-property-value>タグに値を追加してください。
ステートメントプーリング機能を使用する場合の，ステートメントプーリングの動作，および注意事項については，マニュアル「アプリケーションサーバ 機能解説 基本・開発編(コンテナ共通機能)」の「3.14.4 ステートメントプーリング」を参照してください。
使用するDB Connectorのコンフィグレーションプロパティの設定例については，「(4) コンフィグレーションプロパティの設定例」を参照してください。
(c) 実行時プロパティ
DB Connectorの実行時プロパティ（<outbound-resourceadapter> - <connection-definition> - <connector-runtime>タグ）の設定項目を次に示します。
|
項目 |
対応するタグ |
|---|---|
|
プロパティ名 |
<property-name> |
|
プロパティのデータ型 |
<property-type> |
|
プロパティの値 |
<property-value>※ |
- 注※
-
プロパティの値をクリアする場合，空タグ（<property-value></property-value>）を指定します。
<property-value>タグ自体がない場合は，プロパティの値は変更されません。
定義するプロパティの数だけ，上記の設定を繰り返してください。
プロパティの値（<property-value>）を設定した場合，プロパティ値のデフォルト（<property-default-value>）で設定されている値は無効となります。
プロパティ名（<property-name>）には，次の項目を設定します。
|
プロパティ項目 |
プロパティ名（<property-name>）の項目名 |
|---|---|
|
ユーザ名※ |
User |
|
パスワード※ |
Password |
|
コネクションプールにプールするコネクションの最小値 |
MinPoolSize |
|
コネクションプールにプールするコネクションの最大値 |
MaxPoolSize |
|
プール内のコネクションに障害が発生しているかどうかをチェックする方法の選択 |
ValidationType |
|
プール内のコネクションに障害が発生しているかどうかのチェックを定期的に実行する場合の間隔 |
ValidationInterval |
|
コネクションの取得に失敗した場合の，再取得する回数 |
RetryCount |
|
コネクションの取得に失敗した場合の，再取得する間隔 |
RetryInterval |
|
ログを出力するかどうかの選択 |
LogEnabled |
|
コネクションの最終利用時刻から，コネクションを自動破棄（コネクションスイーパ）するかを判定するまでの時間 |
ConnectionTimeout |
|
コネクションの自動破棄（コネクションスイーパ）が動作する間隔 |
SweeperInterval |
|
コネクション枯渇時にコネクション取得要求をキューで管理するかどうかの選択 |
RequestQueueEnable |
|
コネクション枯渇時のコネクション取得要求をキューで管理する場合の待ち時間の最大値 |
RequestQueueTimeout |
|
コネクションプール監視のアラート出力を有効にするかどうかの選択 |
WatchEnabled |
|
コネクションプールを監視する間隔 |
WatchInterval |
|
コネクションプール使用状態を監視するしきい値 |
WatchThreshold |
|
コネクションプール監視結果のファイルを出力するかどうかの選択 |
WatchWriteFileEnabled |
|
コネクション数調節機能が動作する間隔 |
ConnectionPoolAdjustmentInterval |
|
コネクションプールのウォーミングアップ機能を有効にするかどうかの選択 |
Warmup |
|
ネットワーク障害検知機能のタイムアウトを有効にするかどうかの選択 |
NetworkFailureTimeout |
- 注※
-
<property-name>タグに「User」，「Password」が設定されている場合，cjgetrespropコマンドを実行すると，プロパティの値（<property-value>）は次のように表示されます。
-
プロパティの値が設定されている場合
プロパティの値（<property-value>）は取得されないで，「<!-- The property-value has already been set. -->」と表示されます。
「User」および「Password」の値を変更する場合には，<property-value>タグを追加して，変更後の値を設定してください。
-
プロパティの値が設定されていない場合
空タグ（<property-value></property-value>）が表示されます。
「User」および「Password」の値を設定する場合には，<property-value>タグに値を追加してください。
-
プロパティの設定項目については，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」の「4.1.1 Connector属性ファイルの指定内容」を参照してください。
コネクションプーリング機能を使用する場合のコネクションプールの動作，および注意事項については，マニュアル「アプリケーションサーバ 機能解説 基本・開発編(コンテナ共通機能)」の「3.14.1 コネクションプーリング」を参照してください。
(d) 別名情報
DB Connectorの別名情報（<outbound-resourceadapter> - <connection-definition> - <connector-runtime> - <resource-external-property>タグ）の設定項目を次に示します。
|
項目 |
必須 |
対応するタグ |
|---|---|---|
|
リソースの別名 |
○ |
<optional-name> |
|
リソース認証方式 |
△ |
<res-auth> |
|
リソース共有の有無 |
△ |
<res-sharing-scope> |
（凡例） ○：必須 △：任意
プロパティの設定項目については，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」の「4.1.1 Connector属性ファイルの指定内容」を参照してください。
DB Connectorの別名の使用法については，「4.7 JNDI名前空間に登録されるリソースアダプタ名の参照と変更」を参照してください。
(4) コンフィグレーションプロパティの設定例
次のDB Connectorについて，コンフィグレーションプロパティの設定例を示します。
-
DBConnector_HiRDB_Type4_CP.rarで，HiRDB，またはXDM/RD E2を使用する場合
-
DBConnector_HiRDB_Type4_XA.rarで，HiRDBを使用する場合
-
DBConnector_Oracle_CP.rarで，Oracleを使用する場合
-
DBConnector_Oracle_XA.rarで，Oracleを使用する場合
-
DBConnector_SQLServer_CP.rarで，SQL Serverを使用する場合
(a) DBConnector_HiRDB_Type4_CP.rarで，HiRDBまたはXDM/RD E2を使用する場合
DBConnector_HiRDB_Type4_CP.rarで，HiRDBまたはXDM/RD E2を使用する場合の，コンフィグレーションプロパティの設定例を次の表に示します。
|
項目名 |
HiRDBの場合の設定例 |
XDM/RD E2の場合の設定例 |
|---|---|---|
|
description |
＜HiRDBポート番号＞※ |
＜データベースコネクションサーバのサーバスケジュール番号＞※ |
|
DBHostName |
＜HiRDBホスト名＞ |
＜XDM/RD E2ホスト名＞ |
|
environmentVariables |
＜HiRDBクライアント環境変数名＞ |
＜HiRDBクライアント環境変数名＞ |
|
loginTimeout |
8 |
8 |
|
encodeLang |
− |
− |
|
JDBC_IF_TRC |
false |
false |
|
TRC_NO |
500 |
500 |
|
uapName |
− |
− |
|
LONGVARBINARY_Access |
REAL |
REAL |
|
SQLInNum |
300 |
300 |
|
SQLOutNum |
300 |
300 |
|
SQLWarningLevel |
SQLWARN |
SQLWARN |
|
SQLWarningIgnore |
false |
false |
|
HiRDBCursorMode |
false |
false |
|
maxBinarySize |
0 |
0 |
|
LONGVARBINARY_AccessSize |
0 |
0 |
|
LONGVARBINARY_TruncError |
true |
true |
|
PreparedStatementPoolSize |
10 |
10 |
|
CallableStatementPoolSize |
10 |
10 |
|
CancelStatement |
true |
true |
|
logLevel |
ERROR |
ERROR |
（凡例） −：設定は不要
注※ HiRDBクライアントの環境変数グループ名（Windowsの場合）または環境変数グループの設定ファイルのパス（UNIXの場合）も指定できます。
(b) DBConnector_HiRDB_Type4_XA.rarで，HiRDBを使用する場合
DBConnector_HiRDB_Type4_XA.rarで，HiRDBを使用する場合の，コンフィグレーションプロパティの設定例を次の表に示します。
|
項目名 |
HiRDBの場合の設定例 |
|---|---|
|
description |
＜環境変数グループ識別子＞ |
|
DBHostName |
＜HiRDBホスト名＞ |
|
environmentVariables |
＜HiRDBクライアント環境変数名＞ |
|
XAOpenString |
＜環境変数グループ識別子※1＞＋＜環境変数グループの設定ファイルのパス※2＞ |
|
loginTimeout |
8 |
|
encodeLang |
− |
|
JDBC_IF_TRC |
false |
|
TRC_NO |
500 |
|
uapName |
− |
|
LONGVARBINARY_Access |
REAL |
|
SQLInNum |
300 |
|
SQLOutNum |
300 |
|
SQLWarningLevel |
SQLWARN |
|
SQLWarningIgnore |
false |
|
HiRDBCursorMode |
false |
|
maxBinarySize |
0 |
|
LONGVARBINARY_AccessSize |
0 |
|
LONGVARBINARY_TruncError |
true |
|
XACloseString |
− |
|
XALocalCommitMode |
true |
|
PreparedStatementPoolSize |
10 |
|
CallableStatementPoolSize |
10 |
|
CancelStatement |
true |
|
logLevel |
ERROR |
（凡例） −：設定は不要
注※1 ［Description］フィールドに入力した値を指定します。
注※2 HiRDBの環境変数グループの設定ファイルのパスを指定します。詳細については，マニュアル「アプリケーションサーバ システム構築・運用ガイド」の「4.1.6 データベース接続環境を設定する（HiRDBの設定）」を参照してください。
(c) DBConnector_Oracle_CP.rarで，Oracleを使用する場合
DBConnector_Oracle_CP.rarで，Oracleを使用する場合の，コンフィグレーションプロパティの設定例を次の表に示します。
|
項目名 |
urlで設定しない場合の例 |
urlで設定する場合の例 |
|---|---|---|
|
databaseName |
＜Oracle SID＞ |
− |
|
serverName |
＜Oracleのホスト名称，またはIPアドレス＞ |
− |
|
portNumber |
1521 |
− |
|
url |
− |
jdbc:oracle:thin:@//＜Oracleのホスト名称，またはIPアドレス＞:1521/＜Oracle SID＞ |
|
loginTimeout |
8000 |
|
|
PreparedStatementPoolSize |
10 |
|
|
CallableStatementPoolSize |
10 |
|
|
CancelStatement |
true |
|
|
ConnectionIDUpdate |
false |
|
|
logLevel |
ERROR |
|
（凡例） −：設定は不要
(d) DBConnector_Oracle_XA.rarで，Oracleを使用する場合
DBConnector_Oracle_XA.rarで，Oracleを使用する場合の，コンフィグレーションプロパティの設定例を次の表に示します。
|
項目名 |
urlで設定しない場合の例 |
urlで設定する場合の例 |
|---|---|---|
|
databaseName |
＜Oracle SID＞ |
− |
|
serverName |
＜Oracleのホスト名称，またはIPアドレス＞ |
− |
|
portNumber |
1521 |
− |
|
url |
− |
jdbc:oracle:thin:@//＜Oracleのホスト名称，またはIPアドレス＞:1521/＜Oracle SID＞ |
|
loginTimeout |
8000 |
|
|
sessionTimeout |
300 |
|
|
PreparedStatementPoolSize |
10 |
|
|
CallableStatementPoolSize |
10 |
|
|
CancelStatement |
true |
|
|
ConnectionIDUpdate |
false |
|
|
logLevel |
ERROR |
|
（凡例） −：設定は不要
(e) DBConnector_SQLServer_CP.rarで，SQL Serverを使用する場合
DBConnector_SQLServer_CP.rarで，SQL Serverを使用する場合のコンフィグレーションプロパティの設定例を次の表に示します。
|
項目名 |
SQL Serverの場合の設定例 |
|---|---|
|
databaseName |
＜SQL Serverのデータベース名＞ |
|
serverName |
＜SQL Serverのホスト名またはIPアドレス＞ |
|
applicationName |
＜SQL Serverに接続するアプリケーション名＞ |
|
instanceName |
＜接続するSQL Serverのインスタンス名＞ |
|
lastUpdateCount |
true |
|
lockTimeout |
-1 |
|
loginTimeout |
8 |
|
portNumber |
1433 |
|
selectMethod |
cursor |
|
sendStringParametersAsUnicode |
true |
|
workstationID |
＜アプリケーションサーバのホスト名＞ |
|
xopenStates |
false |
|
failoverPartner |
＜データベースミラーリング構成で使用されるフェイルオーバサーバ名＞ |
|
integratedSecurity |
false |
|
packetSize |
4096 |
|
PreparedStatementPoolSize |
10 |
|
CallableStatementPoolSize |
10 |
|
CancelStatement |
true |
|
logLevel |
ERROR |
|
applicationIntent |
ReadWrite |
|
multiSubnetFailover |
false |