BatchFTPOverSSL OTD のノードの機能 (通信アダプタ用 OTD の開発)

通信アダプタ用 OTD の開発

BatchFTPOverSSL OTD のノードの機能

次のリストは、BatchFTPOverSSL OTD の各ノードについて、主要機能などを説明しています。

BatchFTPOverSSL: OTD のルートノードを表します。

Configuration ノード

Configuration ノードの下にある BatchFTPOverSSL のサブノードは、BatchFTPOverSSL アダプタの接続マップ設定パラメータおよび環境設定パラメータに対応します。

BatchFTPOverSSL Client ノード

Client ノードには、OTD にアダプタのクライアントインタフェースを実装するサブノードが含まれます。BatchFTPOverSSL Client ノードには、次のメソッドが含まれます。

append(): 追加モードでデータをリモートに転送します。データの転送元は、設定パラメータ Local Directory および Local File で決まります。両方とも空の場合、ペイロードのデータが転送されます。
connect(): FTP サーバーに接続し、設定どおりに認証を行います。
deleteDir(String dir): 引数で指定されたとおりにリモートディレクトリを削除します。
deleteFile(String path): 引数で指定されたとおりにリモートファイルを削除します。
disconnect(): FTP サーバーから接続を切り離します。
doRawCommands(String commands): raw コマンドを指定します。
download(): データをリモート (設定パラメータ Remote Directory および Remote File に指定) からローカル (設定パラメータ Local Directory および Local File に指定) へダウンロードします。
get(): 設定パラメータ Remote Directory および Remote File で指定されたファイルまたはディレクトリを、設定パラメータ Local Directory および Local File で指定されたローカルにコピーします。設定パラメータ、Is Copy Recursive を Yes に設定すると、コピーは再帰的に行われます。
getEntry(): 現在のエントリリスト内のインデックスエントリを取得します。
getEntryCount(): listDir または listDirLong を呼び出した結果としてディレクトリエントリの数を返します。
getLastReply(): FTP 応答コードを文字列として取得します。
getPayload(): ペイロードを返します。
hasEntry(): ディレクトリリストの結果リストのエントリよりも多い場合 (結果リストが空になったとき) は false を返し、ふたたび結果リストを反復するために resetEntries を呼び出します。
getResolvedLocalDirectory(): 解決されたローカルディレクトリ名を返します。
getResolvedLocalFile(): 解決されたローカルファイル名を返します。
getResolvedRemoteDirectory(): 解決されたリモートディレクトリ名を返します。
getResolvedRemoteFile(): 解決されたリモートファイル名を返します。
hasEntry(): 現在のエントリリストにエントリがあるかどうかを返します。
isConnected(): Java Integration Suite が FTP サーバーに接続されているかどうかを判断します。
listDir(): リモートディレクトリ (設定パラメータ Remote Directory および Remote File に指定) の下のエントリを返します。エントリには名前のみが含まれます。このメソッドを呼び出した後、エントリ情報を反復するには、hasEntry、nextEntry、getEntry、getEntryCount などのメソッドを使用します。
listDirLong(): リモートディレクトリ (設定パラメータ Remote Directory および Remote File で指定) の下のエントリを返します。エントリには、name、size、time stamp、is directory or not などの詳細が含まれます。このメソッドを呼び出した後、エントリ情報を反復するには、hasEntry、nextEntry、getEntry、getEntryCount などのメソッドを使用します。
mkdir(String dir): リモート上にディレクトリを作成します。ディレクトリの名前は、設定パラメータに指定します。
nextEntry(): 結果リスト内の次のエントリを返します。
put(): get と同じですが、データ転送の方向はローカルからリモートに向けてです。
renameFile(String newName): 設定パラメータ Remote Directory および Remote File で指定されたファイルの名前を新しい名前 (引数) に変更します。
reset(): ペイロードバッファーの破棄などの内部ライフサイクルメソッドをリセットします。
resetEntries(): 結果リストの反復子をふたたび反復できるようにリセットします。
resolveLocalAsDestination(): ローカルディレクトリ名およびローカルファイル名がパターン (データ転送先の実際のディレクトリ名およびファイル名を生成するために使用) の場合に、名前を解決します。生成は解決の成功時に行われます。
resolveLocalAsSource(): ローカルディレクトリおよびローカルファイルが正規表現 (データ転送元に対するフィルタ) の場合に、名前を解決します。フィルタは解決の成功時に行われます。
resolveRemoteAsDestination(): リモートディレクトリ名およびリモートファイル名がパターン (データ転送先の実際のディレクトリ名およびファイル名を生成するために使用) の場合に、名前を解決します。生成は解決の成功時に行われます。
resolveRemoteAsSource(): リモートディレクトリおよびリモートファイルが正規表現 (データ転送元に対するフィルタ) の場合に、名前を解決します。フィルタは解決の成功時に行われます。
setpayload(byte[] newPayload): 引数で指定されたとおりにペイロードを設定します。
setResolvedLocalDirectory(String s): 解決されたローカルディレクトリ名を設定します。
setResolvedLocalFile(String s): 解決されたローカルファイル名を設定します。
setResolvedRemoteDirectory(String s): 解決されたリモートディレクトリ名を設定します。
setResolvedRemoteFile(String s): 解決されたリモートファイル名を設定します。
upload(): データをローカル (設定パラメータ Local Directory および Local File に指定) からリモート (設定パラメータ Remote Directory および Remote File に指定) へアップロードします。

注 –
公開されたすべての FTPOverSSLClient メソッドのリストについては、バッチアダプタの Javadoc を参照してください。