クラス SftpSession
java.lang.ObjectSE
org.springframework.integration.sftp.session.SftpSession
- 実装されたすべてのインターフェース:
CloseableSE
、AutoCloseableSE
、Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
public class SftpSession
extends ObjectSE
implements Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
デフォルトの SFTP
Session
実装。MINA SSHD セッションインスタンスをラップします。- 導入:
- 2.0
- 作成者:
- Josh Long, Mario Gray, Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan, Christian Tzolov
コンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明void
append
(InputStreamSE inputStream, StringSE destination) ファイルに追加します。void
close()
StreamSE<org.apache.sshd.sftp.client.SftpClient.DirEntry>
boolean
リモートファイルまたはディレクトリが存在するかどうかを確認します。boolean
Session.readRaw(String)
から InputStream を閉じた後に呼び出します。org.apache.sshd.sftp.client.SftpClient
このセッションの基礎となるクライアントライブラリのクライアントインスタンスを取得します。このセッションが接続されているホストとポートのペアを返します。boolean
isOpen()
org.apache.sshd.sftp.client.SftpClient.DirEntry[]
StringSE[]
boolean
void
read
(StringSE source, OutputStreamSE os) リモートファイルを生のInputStream
SE として取得します。boolean
void
boolean
リモートディレクトリを削除します。boolean
test()
セッションがまだ生きていることをテストします。void
write
(InputStreamSE inputStream, StringSE destination)
コンストラクターの詳細
SftpSession
public SftpSession(org.apache.sshd.sftp.client.SftpClient sftpClient)
メソッドの詳細
remove
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のremove
- 例外:
IOExceptionSE
list
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のlist
- 例外:
IOExceptionSE
listNames
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のlistNames
- 例外:
IOExceptionSE
doList
public StreamSE<org.apache.sshd.sftp.client.SftpClient.DirEntry> doList(StringSE path) throws IOExceptionSE read
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のread
- 例外:
IOExceptionSE
readRaw
インターフェースからコピーされた説明:Session
リモートファイルを生のInputStream
SE として取得します。- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のreadRaw
- パラメーター:
source
- リモートファイルのパス。- 戻り値:
- 生の inputStream。
- 例外:
IOExceptionSE
- IOException。
finalizeRaw
public boolean finalizeRaw()インターフェースからコピーされた説明:Session
Session.readRaw(String)
から InputStream を閉じた後に呼び出します。一部のセッションプロバイダーで必要です。- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のfinalizeRaw
- 戻り値:
- 成功した場合は true。
write
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のwrite
- 例外:
IOExceptionSE
append
インターフェースからコピーされた説明:Session
ファイルに追加します。- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のappend
- パラメーター:
inputStream
- ストリーム。destination
- 宛先。- 例外:
IOExceptionSE
- IO 例外。
close
public void close()- 次で指定:
- インターフェース
AutoCloseableSE
のclose
- 次で指定:
- インターフェース
CloseableSE
のclose
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のclose
isOpen
public boolean isOpen()rename
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のrename
- 例外:
IOExceptionSE
mkdir
- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のmkdir
- 例外:
IOExceptionSE
rmdir
インターフェースからコピーされた説明:Session
リモートディレクトリを削除します。- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のrmdir
- パラメーター:
remoteDirectory
- ディレクトリ。- 戻り値:
- ディレクトリが削除された場合は true。
- 例外:
IOExceptionSE
- IO 例外。
exists
インターフェースからコピーされた説明:Session
リモートファイルまたはディレクトリが存在するかどうかを確認します。getClientInstance
public org.apache.sshd.sftp.client.SftpClient getClientInstance()インターフェースからコピーされた説明:Session
このセッションの基礎となるクライアントライブラリのクライアントインスタンスを取得します。-file、-ftp、-sftp モジュールへの大幅な変更を避けるためにObject
を返します。これは、別のジェネリクスパラメーターを追加した場合に必要になります。実装では、戻り値の型を絞り込む必要があります。- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のgetClientInstance
- 戻り値:
- クライアントインスタンス。
getHostPort
インターフェースからコピーされた説明:Session
このセッションが接続されているホストとポートのペアを返します。- 次で指定:
- インターフェース
Session<org.apache.sshd.sftp.client.SftpClient.DirEntry>
のgetHostPort
- 戻り値:
- このセッションが接続されているホスト: ポートのペア。
test
public boolean test()インターフェースからコピーされた説明:Session
セッションがまだ生きていることをテストします。プールからチェックアウトするとき。デフォルトの実装では、単にSession.isOpen()
に委譲します。