SFTP クライアント

注: これは GeneXus SFTP Module の一部であり、SFTP プロトコルの制限付きクライアントを実装します。

Connect

SDT SftpOptions で定義されている認証方法を使用して、サーバーへの SSH 接続を確立します。

Connect(SftpOptions)

入力 SftpOptions: 認証設定が事前ロードされた SDT SftpOtptions。
戻り値: 接続が成功した場合はブール値 True。

例:

&success = &SftpClient.Connect(&SftpOptions)

Get

既に開いている接続を使用して、リモート SFTP サーバーからクライアントマシンにファイルをダウンロードします。

Get(remoteFilePath, localDirectory)

入力 remoteFilePath: VarChar(256)。ファイル名および拡張子を含む、作業ディレクトリー (pwd) への相対パス。
入力 localDirectory: VarChar(256)。ダウンロードするファイルの保存先となるローカルの絶対パス。
戻り値: 操作が成功した場合はブール値 True。

例:

&success = &SftpClient.Get("/sftpfolder/samplefile.txt", "C:\Temp\")

Put

既に開いている接続を使用して、ローカルのクライアントマシンから SFTP サーバーにファイルをアップロードします。

Put(localFilePath, remoteDirectory)

入力 localFilePath - VarChar(256)。ファイル名および拡張子を含む、ファイルへのローカルの絶対パス。
入力 remoteDirectory - VarChar(256)。作業ディレクトリー (pwd) への相対パス。
戻り値: 操作が成功した場合はブール値 True。

例:

&success = &SftpClient.Put("C:\Temp\samplefile.txt", "/sftpfolder")

GetWorkingDirectory

既定のリモートサーバーの作業ディレクトリーを返します (pwd コマンド)。

GetWorkingDirectory()

戻り値: VarChar(256)

例:

&directory = &SftpClient.GetWorkingDirectory()

Disconnect

SFTP 接続を終了します。
チャネルの使用が終了したら必ず実施することを優れたプログラミングプラクティスとしてお勧めします。また、セキュリティ対策にもなります。

Disconnect()

パラメーターも戻り値もありません。

例

&SftpClient.Disconnect()

ファイルをダウンロードする方法

&SftpOptions.Host = "172.16.4.5"
&SftpOptions.User = "dummyuser"
&SftpOptions.Port = 22
&SftpOptions.Password = "dummypass"
&SftpOptions.AllowHostKeyChecking = true
&SftpOptions.KeyPath = "C:\Temp\keys\private_key.pem"
&SftpOptions.KeyPassword= "dummykeypass"
&SftpOptions.KnownHostsPath = "C:\Temp\known_hosts"

&success = &SftpClient.Connect(&sftpOptions)
&var_error = false

if (&success = true)
    &getsuccess = &SftpClient.Put("C:\temp\testfile.txt", "/sftptest")
    if (&getsuccess = false)
        &var_error=true
    endif
else
    &var_error=true
endif

&SftpClient.Disconnect()

if (&var_error = true)
    if(&SftpClient.HasError())
        msg("Error.Code: " + &SftpClient.GetErrorCode() + "Description: " + &SftpClient.GetErrorDescription())
    endif
endif

ファイルをアップロードする方法

&SftpOptions.Host = "172.16.4.5"
&SftpOptions.User = "dummyuser"
&SftpOptions.Port = 22 
&SftpOptions.Password = "dumypass"
&SftpOptions.AllowHostKeyChecking = true
&SftpOptions.KeyPath = "C:\Temp\keys\private_key.pem"
&SftpOptions.KeyPassword= "dummykeypass"
&SftpOptions.KnownHostsPath = "C:\Temp\known_hosts"

&success = &SftpClient.Connect(&sftpOptions)
&var_error = false

if (&success = true)
    &putsuccess = &SftpClient.Put("C:\temp\testfile.txt", "/sftptest")
    if (&putsuccess = false)
        &var_error=true
    endif
else
    &var_error=true
endif

&SftpClient.Disconnect()

if (&var_error = true)
    if(&SftpClient.HasError())
        msg("Error.Code: " + &SftpClient.GetErrorCode() + "Description: " + &SftpClient.GetErrorDescription())
    endif
endif

警告: これらは単なる一例です。パスワードや鍵はハードコーディングしないでください。