基本的な BatchFTP OTD メソッド

フィールド要素に加えて、BatchFTP OTD の Client ノードには、アダプタのクライアントインタフェース機能を拡張するメソッドが含まれます。これらのメソッドは、OTD の適切な使用に不可欠であるため、ここで詳しく説明します。次のメソッドがあります。

• get(): リモート FTP サーバーからファイルを取得し、その内容をデータペイロードとして格納します。このメソッドは、Target Directory Name および Target File Name パラメータに基づいて一致する最初のファイルを取得し、その内容をデータペイロード (バイト配列) として格納します。次にすべての転送後コマンドを実行します。

  ---

  注 –

  このメソッドを呼び出したあとに、メソッド getPayload() を介してペイロードの内容を取得できます。

  ---

  取得対象のファイルがない場合、入れ子にされた例外として java.io.FTPFileException を含む例外を受け取ります。

• put(): ペイロードのデータを FTP サーバーに配置します。つまり、Payload ノードからリモート FTP サーバーに追加アクション、つまり出力アクションを実行し、次にすべての転送後コマンドを実行します。

  送信対象のファイルがない場合、入れ子にされた例外として java.io.FTPFileException を含む例外を受け取ります。

  ---

  注 –

  アダプタのデータストリーミング機能を使用している場合、get() と put() メソッドは異なる処理をします。この処理の詳細は、「Batch Adapter によるコンポーネント間のデータストリーミング」セクションを参照してください。

  ---

• reset(): Client ノードを前に実行した初期設定の直後の状態に戻します。

  ---

  注 –

  reset() メソッドは、Batch FTP OTD と BatchLocalFile OTD の両方で使用できます。reset メソッドは、同一の executeBusinessRules() の実行中に別の転送用に OTD を再使用しなければならない場合に呼び出してください (たとえば、動的構成機能を使用しているとき)。reset() メソッドは、OTD 全体をリセットせずに、Client ノードの内容をリセットします。まず reset() を呼び出さずに別の転送を試みると、システムは例外をスローし、アダプタのエラーログファイルにエントリを作成します。

  ---

• restoreConfigValues(): 設定パラメータのデフォルトを関連アダプタ設定に復元できます。

• connect()、disconnect()、および isConnected(): FTP サーバーに関する接続関連の処理を実行します。