FTPアダプタ実行環境プロパティファイル

形式

 ftpadp.host-ipaddr=接続するFTPサーバのIPアドレスまたはホスト名
[ftpadp.host-con-port=接続するFTPサーバの制御コネクション用のポート番号]
[ftpadp.file-name.charset={UTF-8|MS932}]

[ftpadp.ftps.enable={TRUE|FALSE}]
[ftpadp.ftps.protocol-name={TLS|SSL}]
[ftpadp.ftps.implicit-mode={TRUE|FALSE}]
[ftpadp.ftps.data-con-secure={TRUE|FALSE}]
[ftpadp.ftps.server-authentication={TRUE|FALSE}]

[ftpadp.client-ipaddr=FTPクライアントのIPアドレス]
[ftpadp.client-con-port.min=FTPクライアントの制御コネクションポート番号の範囲の最小値]
[ftpadp.client-con-port.max=FTPクライアントの制御コネクションポート番号の範囲の最大値]
[ftpadp.client-pasv-port.min=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値]
[ftpadp.client-pasv-port.max=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値]
[ftpadp.listen-port.min=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値]
[ftpadp.listen-port.max=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値]

[ftpadp.ftp-user=接続するFTPサーバのログインユーザ名]
[ftpadp.ftp-type={A|a|I|i}]
[ftpadp.ftp-mode={S|s|C|c}]
[ftpadp.pasvport={PASV|pasv|PORT|port}]

[ftpadp.file-size-check={TRUE|FALSE}]

[ftpadp.methodtrace.level={1|2|3|4|5}]
[ftpadp.methodtrace.filepath=保守ログの出力先ディレクトリの絶対パス]
[ftpadp.methodtrace.filenum=保守ログの面数]
[ftpadp.methodtrace.filesize=保守ログの1面当たりの最大サイズ]

[ftpadp.ftpprotocoltrace.filenum=プロトコルトレースファイルの面数]
[ftpadp.ftpprotocoltrace.filesize=プロトコルトレースファイルの1面当たりの最大サイズ]

[ftpadp.messagelog.level={0|10|20}]

 ftpadp.account-inf-filepath=アカウント定義ファイルの絶対パス
[ftpadp.cscthrough-filepath=FTPコマンド許可リスト定義ファイル(FTPアダプタ用)の絶対パス]

[ftpadp.control-con.retry.count=制御コネクションを確立できなかったときのリトライ回数]
[ftpadp.control-con.retry.interval=制御コネクションを確立できなかったときのリトライ間隔]
[ftpadp.control-con.connect.timeout=制御コネクションの接続タイムアウト時間]

[ftpadp.data-con.retry.count=PASVモードでデータコネクションを確立できなかったときのリトライ回数]
[ftpadp.data-con.retry.interval=PASVモードでデータコネクションを確立できなかったときのリトライ間隔]
[ftpadp.data-con.connect.timeout=データコネクションの接続タイムアウト時間]

[ftpadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数]
[ftpadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔]
[ftpadp.write-lock.retry.count=共通フォルダのファイルの占有ロック失敗時のリトライ回数]
[ftpadp.write-lock.retry.interval=共通フォルダのファイルの占有ロック失敗時のリトライ間隔]

[ftpadp.data-con-put.timeout=データ転送時タイムアウト時間]
[ftpadp.data-con-get.timeout=データ取得時タイムアウト時間]

[ftpadp.ftp-command-reply.timeout=リプライタイムアウト時間]

[ftpadp.listen.timeout=Listenタイムアウト時間]

[ftpadp.put-client-buffer.size=ファイル伝送(送信)するときのクライアントバッファサイズ]
[ftpadp.get-client-buffer.size=ファイル伝送(受信)するときのクライアントバッファサイズ]

機能

FTPアダプタごとの構成情報を設定します。

FTPアダプタ実行環境プロパティファイルは「<サービスID>.properties」というファイル名で作成します。

ファイルの格納先

<FTPアダプタのインストールディレクトリ>¥config¥<サービスID>.properties

設定できるプロパティ

(1)サーバ情報関連

ftpadp.host-ipaddr=接続するFTPサーバのIPアドレスまたはホスト名

接続するFTPサーバのIPアドレスまたはホスト名を指定します。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合,要求電文の値が有効になります。

ftpadp.host-con-port=接続するFTPサーバの制御コネクション用のポート番号 ~<数字>((1-65535))<<21>>

接続するFTPサーバの制御コネクション用のポート番号を指定します。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合,要求電文の値が有効になります。

ftpadp.file-name.charset={UTF-8|MS932} ~<<UTF-8>>

FTPサーバとの間で次の情報を送受信する際に使用する,文字セットの名称を指定します。

指定できる値は次のとおりです。大文字と小文字は区別されません。

(2)FTPS関連

ftpadp.ftps.enable={TRUE|FALSE} ~<<FALSE>>

FTPサーバとの接続にFTPSを使用するかどうかを指定します。

TRUEを選択すると,制御コネクションおよびデータコネクションの通信は暗号化されます(データコネクションの通信の暗号化を抑止する設定となっている場合は,暗号化されません)。ただし,接続先のFTPサーバがFTPSによる接続をサポートしている必要があります。

FALSEを選択すると,制御コネクションおよびデータコネクションの通信は暗号化されません。

接続先のFTPサーバがFTPSのImplicitモードで動作している場合にFALSEを指定すると,FTPサーバに接続してからタイムアウトが発生するまで待ち状態となるときがあります。タイムアウト発生までの時間は,次の二つのタイムアウト時間のうち短い方の時間が適用されます。

ftpadp.ftps.protocol-name={TLS|SSL} ~<<TLS>>

FTPサーバとの接続でFTPSを使用する場合に使用する,セキュリティ通信用のプロトコルを指定します。この指定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。

ftpadp.ftps.implicit-mode={TRUE|FALSE} ~<<FALSE>>

FTPサーバとの接続にFTPSを使用する場合に,FTPSのImplicitモードを使用するかどうかを指定します。この指定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。

接続先のFTPサーバがFTPSのImplicitモードで動作している場合にFALSEを指定すると,FTPサーバに接続してからタイムアウトが発生するまで待ち状態となるときがあります。タイムアウト発生までの時間は,次の二つのタイムアウト時間のうち短い方の時間が適用されます。

ftpadp.ftps.data-con-secure={TRUE|FALSE} ~<<TRUE>>

FTPサーバとの接続にFTPSを使用する場合に,データコネクションの通信を暗号化するかどうかを指定します。この指定は,FTPサーバとの接続にFTPSを使用するときだけ有効となります。

ftpadp.ftps.server-authentication={TRUE|FALSE} ~<<FALSE>>

FTPサーバとの接続にFTPSを使用する場合に,FTPサーバのサーバ認証をするかどうかを指定します。この指定は,FTPサーバとの接続にFTPSを使用するときだけ有効となります。

(3)クライアント情報関連

ftpadp.client-ipaddr=FTPクライアントのIPアドレス

FTPクライアントのIPアドレスを指定します。ここで指定したIPアドレスが制御コネクションおよびデータコネクションで使用されます。

このプロパティの指定を省略した場合,システムによって自動的に任意のIPアドレスが割り当てられます。

ftpadp.client-con-port.min=FTPクライアントの制御コネクションポート番号の範囲の最小値 ~<数字>((1024-65535))

FTPクライアントの制御コネクションポート番号の範囲の最小値を指定します。

指定できる値を次に示します。

上記以外の値を指定した場合,FTPアダプタの起動時にエラーとなります。

注意
ftpadp.client-con-port.maxプロパティ(FTPクライアントの制御コネクションポート番号の範囲の最大値)を省略した場合はこのプロパティも省略してください。省略しない場合は,FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合,システムによって自動的に任意のポート番号が設定されます。

ftpadp.client-con-port.max=FTPクライアントの制御コネクションポート番号の範囲の最大値 ~<数字>((1024-65535))

FTPクライアントの制御コネクションポート番号の範囲の最大値を指定します。

指定できる値を次に示します。

上記以外の値を指定した場合,FTPアダプタの起動時にエラーとなります。

注意
ftpadp.client-con-port.minプロパティ(FTPクライアントの制御コネクションポート番号の範囲の最小値)を省略した場合はこのプロパティも省略してください。省略しない場合は,FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合,システムによって自動的に任意のポート番号が設定されます。

ftpadp.client-pasv-port.min=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値 ~<数字>((1024-65535))

データコネクションがPASVモードの場合の,FTPアダプタがデータコネクション確立するポート番号の範囲の最小値を指定します。このプロパティはデータコネクションがPASVモードの場合だけ有効になります。

指定できる値を次に示します。

上記以外の値を指定した場合,FTPアダプタの起動時にエラーとなります。

注意
ftpadp.client-pasv-port.max(データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値)を省略した場合はこのプロパティも省略してください。省略しない場合は,FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合,システムによって自動的に任意のポート番号が設定されます。

ftpadp.client-pasv-port.max=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値 ~<数字>((1024-65535))

データコネクションがPASVモードの場合の,FTPアダプタがデータコネクション確立するポート番号の範囲の最大値を指定します。このプロパティはデータコネクションがPASVモードの場合だけ有効になります。

指定できる値を次に示します。

上記以外の値を指定した場合,FTPアダプタの起動時にエラーとなります。

次の場合,このプロパティを省略してください。省略しない場合は,FTPアダプタの起動時にエラーとなります。

注意
ftpadp.client-pasv-port.minプロパティ(データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値)を省略した場合はこのプロパティも省略してください。省略しない場合は,FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合,システムによって自動的に任意のポート番号が設定されます。

ftpadp.listen-port.min=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値 ~<数字>((1024-65535))

データコネクションがPORTモードの場合の,FTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値を指定します。データコネクションがPORTモードの場合はこのプロパティを必ず指定してください。指定しない場合は,FTPアダプタの起動時にエラーとなります。

このプロパティはデータコネクションがPORTモードの場合だけ有効になります。PASVモードの場合,設定は不要です。

指定できる値を次に示します。

上記以外の値を指定した場合,FTPアダプタの起動時にエラーとなります。

ftpadp.listen-port.max=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値 ~<数字>((1024-65535))

データコネクションがPORTモードの場合の,FTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値を指定します。データコネクションがPORTモードの場合はこのプロパティを必ず指定してください。指定しない場合は,FTPアダプタの起動時にエラーとなります。

このプロパティはデータコネクションがPORTモードの場合だけ有効になります。PASVモードの場合,設定は不要です。

指定できる値を次に示します。

上記以外の値を指定した場合,FTPアダプタの起動時にエラーとなります。

(4)FTP設定関連

ftpadp.ftp-user=接続するFTPサーバのログインユーザ名 ~<文字列>((1-80文字))

接続するFTPサーバのログインユーザ名を指定します。使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」~「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

指定するログインユーザ名はファイル操作の実行権限が与えられている必要があります。ここで指定した値はUSERコマンドの引数として使用されます。

また,FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合,要求電文の値が有効になります。

ftpadp.ftp-type={A|a|I|i}

転送するデータのタイプとして,次のどちらかを指定します。ここで指定した値はTYPEコマンドの引数として使用されます。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合,要求電文の値が有効になります。

指定が省略された場合は,FTPプロトコルの仕様(RFC959)に従ってASCII形式で転送されます。

ftpadp.ftp-mode={S|s|C|c} ~<<S>>

転送するデータを圧縮するかどうかを指定します。ここで指定した値はMODEコマンドの引数として使用されます。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合,要求電文の値が有効になります。

ftpadp.pasvport={PASV|pasv|PORT|port} ~<<PASV>>

データコネクションの接続モードを次のどちらかに指定します。

(5)ファイルサイズチェック関連

ftpadp.file-size-check={TRUE|FALSE} ~<<FALSE>>

送信側と受信側で,転送されたファイルのサイズが正しいかどうかを確認する機能を,実行するかどうかを指定します。

(6)保守ログ関連

ftpadp.methodtrace.level={1|2|3|4|5} ~<<3>>

保守ログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報出力レベル
12345
エラー情報(例外発生原因)
リクエスタサービスメソッドの入口/出口情報(クラス名,メソッド名,引数,戻り値)×
外部(BPなど)のインターフェースの入口/出口情報(クラス名,メソッド名,引数,戻り値)××
コンポーネント内インターフェースの入口/出口情報(クラス名,メソッド名,引数,戻り値)×××
デバッグ情報(処理の分岐などの情報)××××
(凡例)
○:出力されます。
×:出力されません。

ftpadp.methodtrace.filepath=保守ログの出力先ディレクトリの絶対パス ~<文字列(2バイト文字含む)および空白><<<Cosminexusログ出力ディレクトリ>¥csc¥maintenance>>

保守ログの出力先ディレクトリを絶対パスで指定します。存在しないディレクトリを指定した場合は,省略値が使用されます。省略値はCosminexusの設定値に依存します。

なお,保守ログは「cscftpadpmtd_<HCSCサーバ名>_<面数>.log」という名で作成されます。

ftpadp.methodtrace.filenum=保守ログの面数 ~<数字>((1-16))<<8>>

保守ログの面数を指定します。

ftpadp.methodtrace.filesize=保守ログの1面当たりの最大サイズ ~<数字>((4096-2147483647))<<2097152>>

保守ログの1面当たりの最大サイズをバイト単位で指定します。

(7)FTPプロトコルトレース関連

ftpadp.ftpprotocoltrace.filenum=プロトコルトレースファイルの面数 ~<数字>((1-16)) <<8>>

プロトコルトレースファイルの面数を指定します。

ftpadp.ftpprotocoltrace.filesize=プロトコルトレースファイルの1面当たりの最大サイズ ~<数字>((4096-2147483647)) <<2097152>>

プロトコルトレースファイルの1面当たりの最大サイズ数をバイト単位で指定します。

(8)メッセージログ関連

ftpadp.messagelog.level={0|10|20} ~<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報出力レベル
01020
エラー情報
  • 例外または障害の発生原因
警告情報
  • 発生した問題など
×
インフォメーション
  • 電文や引数の内容
  • HCSC-Messagingの状態の変更(起動時や終了時)
  • コマンド受付時と実行完了時
  • イベントの通知
××
(凡例)
○:出力されます。
×:出力されません。

(9)パス関連

ftpadp.account-inf-filepath=アカウント定義ファイルの絶対パス ~<文字列(2バイト文字含む)および空白>

アカウント定義ファイルのパスを絶対パスで指定します。

ftpadp.cscthrough-filepath=FTPコマンド許可リスト定義ファイル(FTPアダプタ用)の絶対パス ~<文字列(2バイト文字含む)および空白>

FTPコマンド許可リスト定義ファイル(FTPアダプタ用)のパスを絶対パスで指定します。指定を省略した場合,ユーザ指定のFTPコマンドは,転送前,転送後,リストコマンド実行前,およびリストコマンド実行後には実行できません。

(10)制御コネクションの接続タイムアウト関連

ftpadp.control-con.retry.count=制御コネクションを確立できなかったときのリトライ回数 ~<数字>((0-10000))<<5>>

制御コネクションを確立できなかったときのリトライ回数を指定します。0を指定した場合,リトライしません。

ftpadp.control-con.retry.interval=制御コネクションを確立できなかったときのリトライ間隔 ~<数字>((0-86400))<<2>>

制御コネクションを確立できなかったときのリトライ間隔を秒単位で指定します。0を指定した場合,間隔を空けないでリトライします。

ftpadp.control-con.connect.timeout=制御コネクションの接続タイムアウト時間 ~<数字>((1-3600))<<10>>

制御コネクションの接続のタイムアウト時間を秒単位で指定します。

(11)データコネクションの接続タイムアウト関連

ftpadp.data-con.retry.count=PASVモードでデータコネクションを確立できなかったときのリトライ回数 ~<数字>((0-10000))<<5>>

PASVモードでデータコネクションを確立できなかったときのリトライ回数を指定します。0を指定した場合,リトライしません。

ftpadp.data-con.retry.interval=PASVモードでデータコネクションを確立できなかったときのリトライ間隔 ~<数字>((0-86400))<<2>>

パッシブモードでデータコネクションを確立できなかったときのリトライ間隔を秒単位で指定します。0を指定した場合,間隔を空けないでリトライします。

ftpadp.data-con.connect.timeout=データコネクションの接続タイムアウト時間 ~<数字>((1-3600))<<10>>

パッシブモードでの,データコネクション接続のタイムアウト時間を秒単位で指定します。

(12)排他取得タイムアウト関連

ftpadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数 ~<数字>((0-1024))<<0>>

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

ftpadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔 ~<数字>((1-1024))<<1>>

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

ftpadp.write-lock.retry.count=共通フォルダのファイルの占有ロック失敗時のリトライ回数 ~<数字>((0-1024))<<0>>

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

ftpadp.write-lock.retry.interval=共通フォルダのファイルの占有ロック失敗時のリトライ間隔 ~<数字>((1-1024))<<1>>

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

(13)データ転送取得タイムアウト関連

ftpadp.data-con-put.timeout=データ転送時タイムアウト時間 ~<数字>((1-86400))<<60>>

データ送信時に,パケットを送信し,送信バッファが空くまでの監視時間を秒単位で指定します。指定した時間を経過してもバッファが空かない場合は例外(エラー)が発生します。

ftpadp.data-con-get.timeout=データ取得時タイムアウト時間 ~<数字>((1-86400))<<60>>

データ受信時に,パケットを受信する(転送相手がパケットを送信してくる)までの監視時間を秒単位で指定します。指定した時間を経過してもデータの受信がない場合は例外(エラー)が発生します。

(14)FTPコマンドリプライタイムアウト関連

ftpadp.ftp-command-reply.timeout=リプライタイムアウト時間 ~<数字>((1-3600))<<60>>

FTPコマンドを発行して,リプライされるまでの監視時間を秒単位で指定します。指定した時間を経過してもサーバからデータコネクションの接続要求がなかった場合は例外(エラー)が発生します。

(15)Listenタイムアウト関連

ftpadp.listen.timeout=Listenタイムアウト時間 ~<数字>((1-3600))<<60>>

PORTモードの場合,PORTコマンドのリプライを受けたあと,Listen状態での監視時間を秒単位で指定します。指定した時間を経過してもサーバからデータコネクションの接続要求がなかった場合は例外(エラー)が発生します。

(16)バッファサイズ関連

ftpadp.put-client-buffer.size=ファイル転送(送信)するときのクライアントバッファサイズ ~<数字>((512-262144))<<40960>>

ファイル転送(送信)するときのクライアントバッファのメモリのサイズを,バイト単位で指定します。

この値は,メモリが制限されるときや転送効率を上げたいときなどに変更してください。なお,転送効率は回線の速度や利用状況,CPUの性能などによって変動します。

ftpadp.get-client-buffer.size=ファイル転送(受信)するときのクライアントバッファサイズ ~<数字>((512-262144))<<40960>>

ファイル転送(受信)するときのクライアントバッファのメモリのサイズを,バイト単位で指定します。

この値は,メモリが制限されるときや転送効率を上げたいときなどに変更してください。なお,転送効率は回線の速度や利用状況,CPUの性能などによって変動します。