BatchSFTP OTD (通信アダプタ用 OTD の開発)

通信アダプタ用 OTD の開発

BatchSFTP OTD

セキュリティー保護されたバッチ SFTP OTD (BatchSFTP) は、SSH ファイル転送プロトコル、つまり SFTP を使用して、セキュリティー保護されたデータ転送を提供します。SFTP には、中断された転送の再開、ディレクトリリスト、リモートファイルの削除など、リモートファイルに対するさまざまな処理が備わっています。

SFTP は、Secure Shell (SSH) プロトコルを使用して、ローカルとリモートホスト間、または 2 つのリモートホスト間でコンピュータファイルをセキュリティーで保護しながら転送する手段の 1 つです。BatchSFTP OTD は、SFTP を使用して、ファイルをリモートホストにコピーするか、またはリモートホストからコピーします。

BatchSFTP OTD の構造

BatchSFTP OTD には、Client と Configuration という 2 つの上位レベルノードが含まれます (次の図を参照)。これらのノードを展開すると、サブノードが表示されます。

図 1–8 BatchSFTP OTD の構造

BatchSFTP OTD のノードの機能

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

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

Configuration ノード

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

BatchSFTP の Client ノード

BatchSFTP OTD の Client ノードには、次のメソッドが含まれます。

cd(String dir): リモートのカレントディレクトリを指定されたパスに変更します。
connect(): リモートの SSH サーバーに接続し、設定どおりに認証を行います。
delete(): 設定パラメータ RemoteDirectory および RemoteFile で指定されたリモートファイルを削除します。
delete(String file): ファイルで指定されたリモートファイルを削除します。
disconnect(): クライアントをリモートの SSH サーバーから切り離します。
get(): データをリモートの SSH サーバー (設定パラメータ RemoteDirectory および RemoteFile で指定) からローカルマシンにコピーします。現在の設定の状態に応じて、リモートデータは、(メモリーバッファー内の) ペイロードに、または設定パラメータ LocalDirectory および LocalFile で指定したローカルファイルに格納できます。

注 –
フォルダもリモートとして許可されます。この場合、設定パラメータ Recursive が「Yes」の場合、フォルダ階層がローカルの転送先にコピーされます。
getEntry(int index): 現在のエントリリスト内のインデックスエントリを取得します。
getEntryCount(): 現在のエントリリスト内のエントリ数を返します。
getPayload(): ペイロードを返します。

注 –
BatchSFTP OTD を使用している場合に getPayload() を呼び出し、Local Directory および Local Filename を設定していると、getPayload() は、ファイルが取得された場合も null を返します。
getResolvedLocalDirectory(): 解決されたローカルディレクトリ名を返します。
getResolvedLocalFile(): 解決されたローカルファイル名を返します。
getResolvedRemoteDirectory(): 解決されたリモートディレクトリ名を返します。
getResolvedRemoteFile(): 解決されたリモートファイル名を返します。
hasEntry(): 現在のエントリリストにエントリがあるかどうかを返します。
isConnected(): Java Integration Suite が SSH サーバーに接続されているかを判断します。
lcd(String dir): ローカルのカレントディレクトリを変更します。
listDir(): リモートのカレントディレクトリの下にあるすべてのエントリを一覧表示します。
lpwd(): ローカルの現在のパスを返します。
mkdir(): リモート上にディレクトリを作成します。ディレクトリの名前は、プロパティーに指定します。
mkdir(String dir): 設定パラメータ、Remote Directory および Remote File に指定された名前を使用して、リモート上にディレクトリを作成します。
nextEntry(): 現在のエントリリスト内の次のエントリを返します。
put(): ローカルデータ (設定パラメータ LocalDirectory および LocalFile で指定) をリモートの SSH サーバー (設定パラメータ RemoteDirectory および RemoteFile で指定) にコピーします。現在の設定の状態に応じて、ペイロードまたはローカルファイルのローカルデータをコピー元にすることができます。

注 –
フォルダもローカルとして許可されます。この場合、設定パラメータ Recursive が「Yes」の場合、フォルダ階層がリモートの転送先にコピーされます。
pwd(): リモートの現在のパスを返します。
rename(String newPath): 古い名前 (最初の引数) で指定されたファイルまたはディレクトリの名前を、新しい名前 (2 番目の引数) に変更します。
rename(String oldPath, String newPath): 設定パラメータ、Remote Directory および Remote File で指定されたファイルまたはディレクトリの名前を新しい名前 (引数) に変更します。
reset(): ペイロードバッファーの破棄などの内部ライフサイクルメソッドをリセットします。
resetEntries(): 現在のエントリリストをリセットして、次回 nextEntry() を呼び出すとリスト内の最初のエントリが返されるようにします。
resolveLocalAsDestination(): ローカルディレクトリ名およびローカルファイル名がパターン (データ転送先の実際のディレクトリ名およびファイル名を生成するために使用) の場合に、名前を解決します。生成は解決の成功時に行われます。
resolveLocalAsSource(): ローカルディレクトリおよびローカルファイルが正規表現 (データ転送元に対するフィルタ) の場合に、名前を解決します。フィルタは解決の成功時に行われます。
resolveRemoteAsDestination(): リモートディレクトリ名およびリモートファイル名がパターン (データ転送先の実際のディレクトリ名およびファイル名を生成するために使用) の場合に、名前を解決します。生成は解決の成功時に行われます。
resolveRemoteAsSource(): リモートディレクトリおよびリモートファイルが正規表現 (データ転送元に対するフィルタ) の場合に、名前を解決します。フィルタは解決の成功時に行われます。
setpayload(byte[] newPayload): ペイロードを設定します。
setResolvedLocalDirectory(String s): 現在の解決されたローカルディレクトリ名を設定します。
setResolvedLocalFile(String s): 現在のローカルファイル名を s に設定します。ユーザーのコラボレーションから直接呼び出さないでください。
setResolvedRemoteDirectory(String s): 現在の解決されたリモートディレクトリ名を設定します。
setResolvedRemoteFile(String s): 現在の解決されたリモートファイル名を設定します。

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