クラス 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, Darryl Smith

  • コンストラクターの詳細

    • SftpSession

      public SftpSession(org.apache.sshd.sftp.client.SftpClient sftpClient)

    • SftpSession

      public SftpSession(org.apache.sshd.sftp.client.SftpClient sftpClient, boolean isSharedClient)
      SftpClient とその shared ステータスに基づいてインスタンスを構築します。isSharedClient == true の場合、close() は無効になります。
      パラメーター:
      sftpClient - 使用する SftpClient。
      isSharedClient - SftpClient が共有されているかどうか。
      導入:
      6.3.9

  • メソッドの詳細

    • remove

      public boolean remove(StringSE path) throws IOExceptionSE
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の remove 
      例外:
      IOExceptionSE

    • list

      public org.apache.sshd.sftp.client.SftpClient.DirEntry[] list(@Nullable StringSE path) throws IOExceptionSE
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の list 
      例外:
      IOExceptionSE

    • listNames

      public StringSE[] listNames(@Nullable StringSE path) throws IOExceptionSE
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の listNames 
      例外:
      IOExceptionSE

    • doList

      public StreamSE<org.apache.sshd.sftp.client.SftpClient.DirEntry> doList(@Nullable StringSE path) throws IOExceptionSE
      例外:
      IOExceptionSE

    • read

      public void read(StringSE source, OutputStreamSE os) throws IOExceptionSE
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の read 
      例外:
      IOExceptionSE

    • readRaw

      public InputStreamSE readRaw(StringSE source) throws IOExceptionSE
      インターフェースからコピーされた説明: Session
      リモートファイルを生の InputStreamSE として取得します。
      次で指定:
      インターフェース 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

      public void write(InputStreamSE inputStream, StringSE destination) throws IOExceptionSE
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の write 
      例外:
      IOExceptionSE

    • append

      public void append(InputStreamSE inputStream, StringSE destination) throws IOExceptionSE
      インターフェースからコピーされた説明: 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()
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の isOpen 

    • rename

      public void rename(StringSE pathFrom, StringSE pathTo) throws IOExceptionSE
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の rename 
      例外:
      IOExceptionSE

    • mkdir

      public boolean mkdir(StringSE remoteDirectory) throws IOExceptionSE
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の mkdir 
      例外:
      IOExceptionSE

    • rmdir

      public boolean rmdir(StringSE remoteDirectory) throws IOExceptionSE
      インターフェースからコピーされた説明: Session
      リモートディレクトリを削除します。
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の rmdir 
      パラメーター:
      remoteDirectory - ディレクトリ。
      戻り値:
      ディレクトリが削除された場合は true。
      例外:
      IOExceptionSE - IO 例外。

    • exists

      public boolean exists(StringSE path)
      インターフェースからコピーされた説明: Session
      リモートファイルまたはディレクトリが存在するかどうかを確認します。
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の exists 
      パラメーター:
      path - リモートパス。
      戻り値:
      リモートパスが存在するかどうかは、true または false です。

    • getClientInstance

      public org.apache.sshd.sftp.client.SftpClient getClientInstance()
      インターフェースからコピーされた説明: Session
      このセッションの基礎となるクライアントライブラリのクライアントインスタンスを取得します。-file、-ftp、-sftp モジュールへの大幅な変更を避けるために Object を返します。これは、別のジェネリクスパラメーターを追加した場合に必要になります。実装では、戻り値の型を絞り込む必要があります。
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の getClientInstance 
      戻り値:
      クライアントインスタンス。

    • getHostPort

      public StringSE getHostPort()
      インターフェースからコピーされた説明: Session
      このセッションが接続されているホストとポートのペアを返します。
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の getHostPort 
      戻り値:
      このセッションが接続されているホスト: ポートのペア。

    • test

      public boolean test()
      インターフェースからコピーされた説明: Session
      セッションがまだ生きていることをテストします。プールからチェックアウトするとき。デフォルトの実装では、単に Session.isOpen() に委譲します。
      次で指定:
      インターフェース Session<org.apache.sshd.sftp.client.SftpClient.DirEntry> の test 
      戻り値:
      テストが成功した場合は true。