6.19.1 gRPCアダプタ実行環境プロパティファイル
- 〈この項の構成〉
(1) 形式
adpgrpc.request.target=接続するgRPCサーバ
［adpgrpc.request.use-plaintext={true｜false}］
［adpgrpc.config.messagelog.level={0｜10｜20}］
［adpgrpc.config.methodtrace.level={1｜2｜3｜4｜5}］
［adpgrpc.config.methodtrace.filenum=メソッドトレースのファイル面数］
［adpgrpc.config.methodtrace.filesize=メソッドトレースのファイルサイズ］
［adpgrpc.config.exptrace.filenum=例外ログのファイル面数］
［adpgrpc.config.exptrace.filesize=例外ログのファイルサイズ］
［adpgrpc.config.datatrace.enabled={true｜false}］
［adpgrpc.config.datatrace.filenum=データトレースのファイル面数］
［adpgrpc.config.datatrace.filesize=データトレースのファイルサイズ］
［adpgrpc.security.tls.certificate-chain=証明書チェーンのファイルパス］
［adpgrpc.security.tls.client.certificate-chain=クライアントの証明書チェーンのファイルパス］
［adpgrpc.security.tls.client.private-key=クライアントの秘密鍵のファイルパス］
［adpgrpc.security.tls.client.private-key-password=クライアントの秘密鍵のパスワード］
［adpgrpc.security.token-based-auth.scope=OAuth 2.0スコープ］
［adpgrpc.security.token-based-auth.credentials=サービスアカウントキーファイル］
(2) 機能
gRPCアダプタごとの構成情報を設定します。
(a) ファイルの種類
gRPCアダプタ実行環境プロパティファイルは，次に示す2種類があります。
-
gRPCアダプタ実行環境プロパティファイル
有効範囲：特定のgRPCアダプタ
-
gRPCアダプタ実行環境共通プロパティファイル
有効範囲：すべてのgRPCアダプタ
作成手順については「6.19.2 gRPCアダプタ実行環境共通プロパティファイル」を参照してください。
これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。
また，1つのマシンに複数のHCSCサーバをセットアップした場合，gRPCアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。
同じ内容がgRPCアダプタ実行環境プロパティファイルとgRPCアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。
|
指定個所 |
重複時の優先度 |
|---|---|
|
gRPCアダプタ実行環境プロパティファイル （HCSCサーバ単位の指定：あり） |
高 |
|
gRPCアダプタ実行環境共通プロパティファイル （HCSCサーバ単位の指定：あり） |
｜ |
|
gRPCアダプタ実行環境プロパティファイル （HCSCサーバ単位の指定：なし） |
｜ |
|
gRPCアダプタ実行環境共通プロパティファイル （HCSCサーバ単位の指定：なし） |
低 |
(b) 作成手順
gRPCアダプタ実行環境プロパティファイルは次の手順で作成してください。gRPCアダプタ実行環境共通プロパティファイルの作成手順は，「6.19.2 gRPCアダプタ実行環境共通プロパティファイル」を参照してください。
-
次のテンプレートファイルを基に，gRPCアダプタ実行環境プロパティファイルを定義します。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\gRPC\config\templates\serviceid.properties
-
編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。
- 全HCSCサーバ共通の定義の場合
-
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\gRPC\config
- 特定のHCSCサーバ用の定義の場合
-
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\gRPC\config\<HCSCサーバ名>
サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。
サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。
(3) 設定できるプロパティ
(a) プロトコル動作指定
adpgrpc.request.target=接続するgRPCサーバ 〜＜文字列＞
接続するgRPCサーバを次の形式で指定します。「:」は半角のコロンです。
IPアドレスまたはホスト名:ポート番号
このプロパティが定義されていない場合や，不正な値が設定されている場合は，gRPCアダプタの起動でエラーとなります。
adpgrpc.request.use-plaintext={true｜false} 〜<<false>>
gRPCサーバへのプレーンテキスト接続の有無を設定します。大文字と小文字は区別されます。
-
true
gRPCサーバへプレーンテキスト接続します。
-
false
TLSによるgRPCサーバとの接続を実施します。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
(b) ロギング
adpgrpc.config.messagelog.level={0｜10｜20} 〜<<10>>
メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。
|
情報種別 |
出力レベル |
||
|---|---|---|---|
|
0 |
10 |
20 |
|
|
エラー情報 |
○ |
○ |
○ |
|
警告情報 |
△ |
○ |
○ |
|
インフォメーション |
△ |
△ |
○ |
- （凡例）
-
○：出力されます。
△：重要なメッセージログだけ出力されます。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.methodtrace.level={1｜2｜3｜4｜5} 〜<<3>>
メソッドトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。
|
情報種別 |
出力レベル |
||||
|---|---|---|---|---|---|
|
1 |
2 |
3 |
4 |
5 |
|
|
メソッド内のエラー |
○ |
○ |
○ |
○ |
○ |
|
外部から呼び出されるメソッド情報およびファイル入出力メソッドの開始・終了情報 |
× |
○ |
○ |
○ |
○ |
|
ほかのHCSCコンポーネントから参照するpublicメソッドの開始・終了情報 |
× |
× |
○ |
○ |
○ |
|
ほかのHCSCコンポーネントから参照しない内部メソッド（public以外のメソッド）の開始・終了情報 |
× |
× |
× |
○ |
○ |
|
デバッグ情報 |
× |
× |
× |
× |
○ |
- （凡例）
-
○：出力されます。
×：出力されません。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.methodtrace.filenum=メソッドトレースのファイル面数 〜＜数字＞((1−16))<<8>>
メソッドトレースのファイル面数を指定します。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.methodtrace.filesize=メソッドトレースのファイルサイズ 〜＜数字＞((4096−2147483647))<<2097152>>
メソッドトレースのファイルサイズをバイト単位で指定します。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.exptrace.filenum=例外ログのファイル面数 〜＜数字＞((1−16))<<8>>
例外ログのファイル面数を指定します。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.exptrace.filesize=例外ログのファイルサイズ 〜＜数字＞((4096−2147483647))<<2097152>>
例外ログのファイルサイズをバイト単位で指定します。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.datatrace.enabled={true｜false} 〜<<false>>
データトレースの出力有無を指定します。大文字と小文字は区別されます。
-
true
データトレースを出力します。
-
false
データトレースを出力しません。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.datatrace.filenum=データトレースのファイル面数 〜＜数字＞((1−16))<<8>>
データトレースのファイル面数を指定します。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.config.datatrace.filesize=データトレースのファイルサイズ 〜＜数字＞((4096−2147483647))<<2097152>>
データトレースのファイルサイズをバイト単位で指定します。
範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。
(c) セキュリティ
adpgrpc.security.tls.certificate-chain=証明書チェーンのファイルパス
証明書チェーンのファイルパスを指定します。
存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。
証明書チェーンはPEMエンコードとする必要があります。PEMエンコードでない場合は動作を保証しません。
指定を省略した場合は，信頼できる証明書を格納したキーストア（トラストストア）が使用されます。詳細については，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「付録K.1 キーストアに関する設定」を参照してください。
adpgrpc.security.tls.client.certificate-chain=クライアントの証明書チェーンのファイルパス
クライアントの証明書チェーンのファイルパスを指定します。
存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。
証明書チェーンはPEMエンコードとする必要があります。PEMエンコードでない場合は動作を保証しません。
adpgrpc.security.tls.client.private-key=クライアントの秘密鍵のファイルパス
クライアントの秘密鍵のファイルパスを指定します。
存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。
秘密鍵はPKCS#8形式とする必要があります。PKCS#8形式でない場合は動作を保証しません。
adpgrpc.security.tls.client.private-key-password=クライアントの秘密鍵のパスワード
クライアントの秘密鍵のパスワードを指定します。
不正なパスワードを指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.security.token-based-auth.scope=OAuth 2.0スコープ
Google APIへのアクセスに必要となるOAuth 2.0スコープを「コンマ（,）」区切りで指定します。認証されたユーザを承認するか判定するために使用されます。
不正な値を指定した場合，gRPCアダプタの起動でエラーとなります。
adpgrpc.security.token-based-auth.credentials=サービスアカウントキーファイル
サービスアカウントキーファイルのファイルパスを指定します。指定されたファイルがJSON形式でない場合の動作は保証しません。
存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。