HTTPアダプタの動作情報を設定します。

HTTPアダプタ定義ファイルは「cscadphttp.properties」というファイル名で作成します。

HTTPアダプタの開始時に，HTTPアダプタ定義ファイルに設定した内容が有効になります。

 
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\HTTP\config\templates\cscadphttp.properties
 

注意

ここに格納されているファイルはテンプレートファイルです。このテンプレートファイルを任意のディレクトリにコピーしたあとファイルを編集し，定義ファイルを作成してください。

(1)プロトコル動作指定関連

adphttp.protocol.encoding-type=エンコーディング形式　〜((gzip))

送受信するHTTPボディのエンコーディング形式を指定します。指定できるエンコーディング形式は「gzip」だけです。大文字と小文字は区別されません。デフォルトではエンコーディング形式は定義されません。

• gzip
  HTTPボディが自動でエンコードされます。
  

gzip形式でHTTPボディを送受信する場合だけ指定してください。gzip形式でHTTPボディを送受信しない場合は，プロパティをコメントアウトまたは削除してください。

adphttp.protocol.connect-timeout=接続タイムアウト時間　〜＜数字＞((0または1−2147483647))<<60000>>

接続タイムアウト時間をミリ秒単位で指定します。値に0を指定した場合はタイムアウトしません。

adphttp.protocol.read-timeout=読み込みタイムアウト時間　〜＜数字＞((0または1−2147483647))<<300000>>

読み込みタイムアウト時間をミリ秒単位で指定します。値に0を指定した場合はタイムアウトしません。

adphttp.protocol.chunked-encoding-size=チャンクサイズ　〜＜数字＞((0または1−2147483647))<<0>>

java.net.HttpURLConnection#setChunkedStreamingMode(Integer)に設定する値を指定します。ただし指定した値でチャンク送信されるかはJDKの動作に依存します。値を設定しない（チャンク送信しない）場合は0を指定するか，またはコメントアウトしてください。

チャンクサイズは通常は「4096」を指定し，必要に応じて値を増減してください。任意の値を指定する場合は，使用する環境に合わせて次の点に注意してください。

• チャンクサイズに極端に小さな値（1桁の数字など）を設定した場合は，チャンク送信されない場合があります。
• チャンクサイズを小さくし過ぎると，チャンクエンコーディングに伴うオーバーヘッドが大きくなります。
• チャンクサイズを大きくし過ぎると，メモリが不足しエラーが発生します。

adphttp.protocol.https-server-authentication={true｜false}　〜<<true>>

HTTPS通信時にサーバ認証をするかどうかを指定します。大文字と小文字は区別されません。

• true
  HTTPS通信時にサーバ認証をします。
  
• false
  HTTPS通信時にサーバ認証をしません。
  

adphttp.protocol.https-hostname-verification={true｜false}　〜<<true>>

HTTPS通信時にホスト名を検証するかどうかを指定します。大文字と小文字は区別されません。

• true
  HTTPS通信時にホスト名を検証します。
  
• false
  HTTPS通信時にホスト名を検証しません。
  

(2)ファイルアクセス排他取得関連

adphttp.file.read-lock.retry.count=共有ロック取得失敗時のロックリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダの共有ロック取得失敗時のロックリトライ回数を指定します。

adphttp.file.read-lock.retry.interval=共有ロック取得失敗時のロックリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダの共有ロック取得失敗時のロックリトライ間隔を秒単位で指定します。

(3)データサイズ制限関連

adphttp.data-size-limit.body-message=HTTPレスポンスボディの最大サイズ　〜＜数字＞((-1−2147483647))<<-1>>

HTTPレスポンスを応答電文（ボディ）に設定する際に許容するデータの最大サイズをバイト単位で指定します。値に-1を指定した場合はサイズが制限されません。

adphttp.data-size-limit.file=ファイルの最大サイズ　〜＜数字＞((-1−2147483647))<<-1>>

HTTPレスポンスをファイルに書き出す際に許容するデータの最大サイズをバイト単位で指定します。値に-1を指定した場合はサイズが制限されません。

(4)レスポンスコード関連

adphttp.response-code.normal=正常処理として扱うステータスコード　〜＜3桁のステータスコード＞<<200>>

正常処理として扱う3桁のステータスコードを指定します。指定したステータスコードのHTTPレスポンスがHTTPアダプタに返ると応答電文で処理されます。

ステータスコードは判定基準に従って，正常処理，フォルト処理，システム例外として扱われます。判定基準については，マニュアル「サービスプラットフォーム 解説」の「2.14.4　HTTPレスポンスと応答電文の関係」の，ステータスコードの正常処理またはフォルト処理の設定に関する説明を参照してください。

複数のステータスコードを指定する場合は，正規表現で指定します。200番台のステータスコードを正常処理として扱う場合の設定例を次に示します。

 
adphttp.response-code.normal=2[0-9][0-9]
 

正常処理またはフォルト処理のどちらにも設定していないステータスコードがHTTPアダプタに渡された場合はシステム例外となります。項目が省略された場合，または値が省略された場合は，デフォルト値で動作します。

adphttp.response-code.fault=フォルト処理として扱うステータスコード　〜＜3桁のステータスコード＞

フォルト処理として扱う3桁のステータスコードを指定します。ここで指定したステータスコードのHTTPレスポンスがHTTPアダプタに返ると，フォルト電文で処理されます。指定を省略した場合，ステータスコードは設定されません。

ステータスコードは判定基準に従って，正常処理，フォルト処理，システム例外として扱われます。判定基準については，マニュアル「サービスプラットフォーム 解説」の「2.14.4　HTTPレスポンスと応答電文の関係」の，ステータスコードの正常処理またはフォルト処理の設定に関する説明を参照してください。

複数のステータスコードを指定する場合は，正規表現で指定します。adphttp.response-code.normalプロパティで指定したステータスコード以外のすべてのステータスコードをフォルト応答にする場合の設定例を次に示します。

 
adphttp.response-code.fault=[1-9][0-9][0-9]
 

正常処理またはフォルト処理のどちらにも設定していないステータスコードがHTTPアダプタに渡された場合は，システム例外となります。

(5)拡張機能関連

adphttp.auto-delete-incomplete-file={true｜false}　〜<<true>>

ネットワーク障害やI/Oエラー，データサイズ制限の超過などの理由で共通フォルダや作業フォルダに不完全な受信ファイルが生成された場合に，受信ファイルを自動的に削除するか指定します。大文字と小文字は区別されません。

• true
  不完全な受信ファイルを自動的に削除します。
  
• false
  不完全な受信ファイルを自動的に削除しません。
  

不完全な受信ファイルによるストレージの消費を防止する場合はtrue，障害発生時の状態の保存（保持）を優先する場合はfalseを選択してください。

不完全な受信ファイルを自動的に削除しない場合は，ストレージの空き容量が枯渇しないように，必要に応じて手動で不要なファイルを削除してください。削除方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.20　作業フォルダを削除する」，および「5.4.22　共通フォルダ内のファイルを削除する」を参照してください。

(6)JSON-XML変換関連

adphttp.request.switchover.json-transfer.mode={true｜false}　〜<<false>>

HTTPアダプタのリクエスト処理時にJSON-XML変換をするかどうかを指定します。

• true
  HTTPアダプタのリクエスト処理時にJSON-XML変換をします。
  
• false
  HTTPアダプタのリクエスト処理時にJSON-XML変換をしません。
  

adphttp.response.switchover.json-transfer.mode={true｜false}　〜<<false>>

HTTPアダプタのレスポンス処理時にJSON-XML変換をするかどうかを指定します。

• true
  HTTPアダプタのレスポンス処理時にJSON-XML変換をします。
  
• false
  HTTPアダプタのレスポンス処理時にJSON-XML変換をしません。
  

(7)OAuth 2.0認証関連

adphttp.oauth.authentication={true｜false}　〜<<false>>

HTTPアダプタ実行時にOAuth 2.0の認証フローを使用するかどうかを指定します。

• true
  HTTPアダプタ実行時にOAuth 2.0の認証フローを使用します。
  
• false
  HTTPアダプタ実行時にOAuth 2.0の認証フローを使用しません。
  

注意事項

OAuth 2.0の認証フローを使用する場合は，trueを指定しないと認証情報が不正になります。認証情報が不正な場合，HTTPリクエストがエラー応答したり，応答電文（ヘッダ）にアクセストークンが格納されなかったりすることがあります。

記述例を次に示します。

 
adphttp.protocol.encoding-type=gzip
adphttp.protocol.connect-timeout=60000
adphttp.protocol.read-timeout=300000
adphttp.protocol.chunked-encoding-size=0
adphttp.protocol.https-server-authentication=true
adphttp.protocol.https-hostname-verification=true
adphttp.file.read-lock.retry.count=0
adphttp.file.read-lock.retry.interval=1
adphttp.data-size-limit.body-message=-1
adphttp.data-size-limit.file=-1
adphttp.response-code.normal=200
adphttp.response-code.fault=500
adphttp.auto-delete-incomplete-file=true
adphttp.request.switchover.json-transfer.mode=true
adphttp.response.switchover.json-transfer.mode=true
 

プロパティファイルは文字コードをUTF-8にして保存してください。UTF-8以外の文字コードを使用した場合，設定値を正しく解釈できない場合があります。