3.2.3 FTPインバウンドアダプタをセットアップする
FTPインバウンドアダプタをセットアップするには,HCSCサーバが起動している必要があります。
HCSCサーバの状態の確認方法については,「5.3.15 HCSCサーバの情報を確認する」を参照してください。
FTPインバウンドアダプタのセットアップの流れを次に示します。
(1) FTPインバウンドアダプタのインポート
FTPインバウンドアダプタをインポートする場合の実行形式を次に示します。
<サービスプラットフォームのインストールディレクトリ>\CC\admin\bin\cjimportres <J2EEサーバ名> -type rar -f "<サービスプラットフォームのインストールディレクトリ>\CSC\inbound-adapter\ftp\rar\ftp_inbound_adapter.rar"
cjimportresコマンドの詳細は,マニュアル「アプリケーションサーバ リファレンス コマンド編」の「2.4 J2EEサーバで使用するリソース操作コマンド」を参照してください。
(2) FTPインバウンドアダプタのデプロイ
FTPインバウンドアダプタをデプロイする場合の実行形式を次に示します。
<サービスプラットフォームのインストールディレクトリ>\CC\admin\bin\cjdeployrar <J2EEサーバ名> -resname FTP_Inbound_Resource_Adapter
cjdeployrarコマンドの詳細は,マニュアル「アプリケーションサーバ リファレンス コマンド編」の「2.4 J2EEサーバで使用するリソース操作コマンド」を参照してください。
(3) FTPインバウンドアダプタの設定
FTPインバウンドアダプタを設定する手順,およびプロパティファイルの内容を次に示します。
- 参考
-
初期状態の設定のままでFTP連携システムを運用する場合,ここでの設定は省略できます。
(a) 設定手順
-
FTPインバウンドアダプタのRARファイルから属性を取得して,属性ファイルを作成します。
FTPインバウンドアダプタのRARファイルから属性ファイルを作成する場合の実行形式を次に示します。
<サービスプラットフォームのインストールディレクトリ>\CC\admin\bin\cjgetrarprop <J2EEサーバ名> -resname FTP_Inbound_Resource_Adapter -c <属性ファイルのファイルパス>
cjgetrarpropコマンドの詳細は,マニュアル「アプリケーションサーバ リファレンス コマンド編」の「2.4 J2EEサーバで使用するリソース操作コマンド」を参照してください。
-
属性ファイルを編集します。
属性ファイルの詳細は,「(b) プロパティの内容」を参照してください。
-
定義項目を編集した属性ファイルに指定された値を,FTPインバウンドアダプタのRARファイルへ反映します。
属性ファイルをFTPインバウンドアダプタへ反映する場合の実行形式を次に示します。
<サービスプラットフォームのインストールディレクトリ>\CC\admin\bin\cjsetrarprop <J2EEサーバ名> -resname FTP_Inbound_Resource_Adapter -c <属性ファイルのファイルパス>
cjsetrarpropコマンドの詳細は,マニュアル「アプリケーションサーバ リファレンス コマンド編」の「2.4 J2EEサーバで使用するリソース操作コマンド」を参照してください。
(b) プロパティの内容
- 属性ファイルの定義
-
属性ファイルにある定義のタグを次に示します。
<hitachi-connector-property> <resourceadapter> <config-property> <config-property-name> :定義の名称 <config-property-type> :定義の型 <config-property-value> :定義の値 </config-property> <config-property> <config-property-name> :定義の名称 <config-property-type> :定義の型 <config-property-value> :定義の値 </config-property> : (以降,定義の数分,繰り返される) :
定義を編集する場合は,編集する「定義の名称」を検索して,対応する「定義の値」を書き替えます。編集できる項目については,「属性ファイルの定義項目」を参照してください。
属性ファイルを編集する際の注意事項を次に示します。
-
「定義項目」に示している定義項目の値だけを書き替えてください。ほかの項目や値を変更しないでください。
-
属性ファイルの内容を,アプリケーション属性ファイル(cosminexus.xml)には記載しないでください。
-
属性ファイル内にある<display-name>タグのリソースアダプタの名称を変更しないでください。
-
ログ出力に関する設定で,各ログのログファイル1面当たりのファイルサイズ,およびログファイルのバックアップファイルの面数を変更した場合は,FTPインバウンドアダプタを起動する前に,ログファイルをバックアップしておいてください。
-
- 属性ファイルの定義個所
-
次に,属性ファイルの定義個所を示します。
図3‒8 属性ファイルの内容および定義の設定個所 - 属性ファイルの定義項目
-
属性ファイルの定義項目を設定内容ごとに表で示します。
表3‒22 属性ファイルの定義項目一覧(転送制御に関する設定) 定義項目
定義名
値の範囲
デフォルト値
補足
最大同時接続数
server_maxLogins
1〜1024
10
−
文字セットUTF-8の使用
server_charset_UTF8
ONまたはOFF
ON
ONを指定した場合は,文字コードにUTF-8を使用します。
OFFを指定した場合は,文字コードにMS932を使用します。
なお,FTPコマンドで文字セットを指定した場合は,その設定が有効になります。
FTPレスポンスの終端文字の互換性
server_endOfLineCompatible
trueまたはfalse
false
(CRLFが標準の終端コードとなります)
trueを指定した場合は,FTPレスポンスの終端文字にOS依存の改行コード(Windowsの場合:CRLF,UNIXの場合:LF)を使用します。
falseを指定した場合は,FTPレスポンスの終端文字にCRLFを使用します。
ローカルIPアドレス
nioListener_localAddress
0.0.0.0〜255.255.255.255
0:0:0:0:0:0:0:0〜FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF
All available
(FTPインバウンドアダプタを実行するホストにIPアドレスが複数ある場合,すべてのIPアドレスでFTPクライアントからの要求を受け付けます)
−
ポート番号
nioListener_port
1〜65535
21
−
データコネクション確立時のローカルIPアドレス
nioListener_dataConnection_active_localAddress
0.0.0.0〜255.255.255.255
0:0:0:0:0:0:0:0〜FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF
Any available
(FTPインバウンドアダプタを実行するホストにIPアドレスが複数ある場合,同一セッション内で使用している制御コネクションと同じIPアドレスが割り当てられます)
PASVモードの場合はこのプロパティの設定にかかわらず,同一セッション内で使用している制御コネクションと同じIPアドレスがデータコネクションに割り当てられます。
データコネクション確立時のポート番号
nioListener_dataConnection_active_localPort
1〜65535
Any available
(FTPインバウンドアダプタを実行するホストで空いているポート番号が割り当てられます)
すでに使用されているポート番号は指定しないでください。指定した場合はデータコネクションの確立に失敗します。
Listenバックログ数
nioListener_listenBacklog
1〜2147483647
50
−
データコネクションのバッファサイズ
nioListener_dataConnection_socketBufferSize
1〜65536
16384
(単位:バイト)
表3‒23 属性ファイルの定義項目一覧(タイムアウトに関する設定) 定義項目
定義名
値の範囲
デフォルト値
補足
アイドルタイムアウト
nioListener_idleTimeout
0〜7200
300
0を指定した場合はタイムアウト監視をしません。
(単位:秒)
データコネクション接続のリトライ回数
nioListener_dataConnection_active_connectRetryCount
0〜50
5
0を指定した場合はリトライしません。
データコネクション接続の監視時間
nioListener_dataConnection_active_connectRetryInterval
0〜1800
10
0を指定した場合はタイムアウト監視をしません。
(単位:秒)
データ送信およびデータ受信のタイムアウト
nioListener_dataConnection_idleTimeout
0〜1800
10
0を指定した場合はタイムアウト監視をしません。
(単位:秒)
属性ファイルの定義項目で,FTPSに関する設定項目については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「付録H.3 セットアップ時の属性ファイルの定義項目(FTPインバウンドアダプタ)」を参照してください。
表3‒24 属性ファイルの定義項目一覧(ログ出力に関する設定) 分類
定義項目
定義名
値の範囲
デフォルト値
補足
メッセージログ
出力レベル
server_message_logLevel
debug,またはinfo
info
info:
通常の運用時に使用し,運用時に必要な情報を出力します。
debug:
テストや障害が発生した場合の調査時に使用し,infoの情報に加えて,デバッグ用の情報を出力します。
ログファイル1面当たりのファイルサイズ
server_message_maxFileSize
1MB〜2048MB
10MB
単位の文字列も指定してください。
(単位:MB)
ログファイルのバックアップファイルの面数
server_message_maxBackupIndex
1〜16
4
−
保守用ログ
ログ出力レベル
server_maintenance_logLevel
debug,またはinfo
info
「info」および「debug」の意味は,メッセージログの「ログ出力レベル」と同じです。
ログファイル1面当たりのファイルサイズ
server_maintenance_maxFileSize
1MB〜2048MB
5MB
単位の文字列も指定してください。
(単位:MB)
ログファイルのバックアップファイルの面数
server_maintenance_maxBackupIndex
1〜16
4
−
プロトコルトレースログ
ログ出力レベル
server_protocol_logLevel
debug,またはinfo
info
「info」および「debug」の意味は,メッセージログの「ログ出力レベル」と同じです。
ログファイル1面当たりのファイルサイズ
server_protocol_maxFileSize
1MB〜2048MB
20MB
単位の文字列も指定してください。
(単位:MB)
ログファイルのバックアップファイルの面数
server_protocol_maxBackupIndex
1〜16
4
−
転送履歴ログ
ログ出力レベル
server_history_logLevel
debug,またはinfo
info
「info」および「debug」の意味は,メッセージログの「ログ出力レベル」と同じです。
ログファイル1面当たりのファイルサイズ
server_history_maxFileSize
1MB〜2048MB
12MB
単位の文字列も指定してください。
(単位:MB)
ログファイルのバックアップファイルの面数
server_history_maxBackupIndex
1
1
−
リソースアダプタ間共通ログ
ログ出力レベル
server_common_logLevel
debug,またはinfo
info
「info」および「debug」の意味は,メッセージログの「ログ出力レベル」と同じです。
ログファイル1面当たりのファイルサイズ
server_common_maxFileSize
1MB〜2048MB
5MB
単位の文字列も指定してください。
(単位:MB)
ログファイルのバックアップファイルの面数
server_common_maxBackupIndex
1〜16
4
−
(4) ユーザ情報の設定
ユーザ情報は,FTPインバウンドアダプタによって,ファイルとして管理されます。認証情報のファイルは,管理者権限を持っている管理者が運用コマンドを実行することによって,登録,更新,削除,および表示できます。
(a) 認証情報の運用コマンド
認証情報の運用コマンドを次の表に示します。
運用コマンド |
内容 |
---|---|
csmftpaddusr(FTPインバウンドアダプタのユーザの登録・更新コマンド) |
ユーザを新規に登録します。また,すでに登録されているユーザのパスワードを更新します。 |
csmftpdelusr(FTPインバウンドアダプタのユーザの削除コマンド) |
登録されているユーザの認証情報を削除します。 |
csmftplsusr(FTPインバウンドアダプタのユーザの表示コマンド) |
登録されているユーザの認証情報を表示します。 |
運用コマンドの詳細は,マニュアル「サービスプラットフォーム リファレンス」の「5. コマンド(運用環境・実行環境)」の説明を参照してください。
運用コマンドを実行するときの注意事項を次に示します。
-
FTPインバウンドアダプタが停止している状態で,運用コマンドを実行してください。
-
運用コマンドの実行中に,別の運用コマンドは実行できません。先に実行した運用コマンドが終了してから,別の運用コマンドを実行してください。
運用コマンドの実行形式を次に示します。
-
FTPインバウンドアダプタのユーザの登録・更新
FTPインバウンドアダプタのユーザを登録および更新する場合の実行形式を次に示します。
csmftpaddusr -usr <ユーザ名> -pass <ユーザのパスワード>
詳細は,マニュアル「サービスプラットフォーム リファレンス」の「csmftpaddusr(FTPインバウンドアダプタのユーザの登録・更新)」を参照してください。
-
FTPインバウンドアダプタのユーザの削除
FTPインバウンドアダプタのユーザを削除する場合の実行形式を次に示します。
csmftpdelusr -usr <ユーザ名>
詳細は,マニュアル「サービスプラットフォーム リファレンス」の「csmftpdelusr(FTPインバウンドアダプタのユーザの削除)」を参照してください。
-
FTPインバウンドアダプタのユーザの表示
FTPインバウンドアダプタのユーザを表示する場合の実行形式を次に示します。
csmftplsusr
詳細は,マニュアル「サービスプラットフォーム リファレンス」の「csmftplsusr(FTPインバウンドアダプタのユーザの表示)」を参照してください。
(b) 認証情報へのアクセス制限
認証情報にアクセス制限をするには,運用者が運用開始前に,認証情報のファイルに対して,運用コマンドを実行する管理者だけに更新・参照のアクセス権を設定する必要があります。
なお,管理者にアクセス権を設定すると,認証情報のファイルの所有者は管理者となります。