SftpSession (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.sftp.session.SftpSession

実装されているすべてのインターフェース:
CloseableSE, AutoCloseableSE, Session<com.jcraft.jsch.ChannelSftp.LsEntry>
```
public class SftpSession
extends ObjectSE
implements Session<com.jcraft.jsch.ChannelSftp.LsEntry>
```
デフォルトの SFTP Session 実装。JSCH セッションインスタンスをラップします。
導入:
2.0
作成者:
Josh Long, Mario Gray, Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

コンストラクターの概要
コンストラクター
コンストラクターと説明
SftpSession(org.springframework.integration.sftp.session.JSchSessionWrapper wrapper)
SftpSession(com.jcraft.jsch.Session jschSession)

コンストラクター
コンストラクターと説明
`SftpSession(org.springframework.integration.sftp.session.JSchSessionWrapper wrapper)`
`SftpSession(com.jcraft.jsch.Session jschSession)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`append(InputStreamSE inputStream, StringSE destination)` ファイルに追加します。
`void`	`close()`
`boolean`	`exists(StringSE path)` リモートファイルまたはディレクトリが存在するかどうかを確認します。
`boolean`	`finalizeRaw()` `Session.readRaw(String)` から InputStream を閉じた後に呼び出します。
`com.jcraft.jsch.ChannelSftp`	`getClientInstance()` このセッションの基礎となるクライアントライブラリのクライアントインスタンスを取得します。
`StringSE`	`getHostPort()` このセッションが接続されているホストとポートのペアを返します。
`boolean`	`isOpen()`
`com.jcraft.jsch.ChannelSftp.LsEntry[]`	`list(StringSE path)`
`StringSE[]`	`listNames(StringSE path)`
`boolean`	`mkdir(StringSE remoteDirectory)`
`void`	`read(StringSE source, OutputStreamSE os)`
`InputStreamSE`	`readRaw(StringSE source)` リモートファイルを生の `InputStream`SE として取得します。
`boolean`	`remove(StringSE path)`
`void`	`rename(StringSE pathFrom, StringSE pathTo)`
`boolean`	`rmdir(StringSE remoteDirectory)` リモートディレクトリを削除します。
`void`	`setChannelConnectTimeout(java.time.Duration timeout)` 接続タイムアウトを設定します。
`boolean`	`test()` セッションがまだ生きていることをテストします。
`void`	`write(InputStreamSE inputStream, StringSE destination)`

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.integration.file.remote.session.Session から継承されたメソッド
dirty

- コンストラクターの詳細
  - SftpSession
```
public SftpSession(com.jcraft.jsch.Session jschSession)
```
  - SftpSession
```
public SftpSession(org.springframework.integration.sftp.session.JSchSessionWrapper wrapper)
```
- メソッドの詳細
  - setChannelConnectTimeout
```
public void setChannelConnectTimeout(java.time.Duration timeout)
```
    接続タイムアウトを設定します。
    パラメーター:
    timeout - 設定するタイムアウト。
    導入:
    5.2
  - remove
```
public boolean remove(StringSE path)
               throws IOExceptionSE
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の remove
    例外:
    IOExceptionSE
  - list
```
public com.jcraft.jsch.ChannelSftp.LsEntry[] list(StringSE path)
                                           throws IOExceptionSE
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の list
    例外:
    IOExceptionSE
  - listNames
```
public StringSE[] listNames(StringSE path)
                   throws IOExceptionSE
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の listNames
    例外:
    IOExceptionSE
  - read
```
public void read(StringSE source,
                 OutputStreamSE os)
          throws IOExceptionSE
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の read
    例外:
    IOExceptionSE
  - readRaw
```
public InputStreamSE readRaw(StringSE source)
                    throws IOExceptionSE
```
    インターフェースからコピーされた説明: Session
    リモートファイルを生の InputStreamSE として取得します。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の readRaw
    パラメーター:
    source - リモートファイルのパス。
    戻り値:
    生の inputStream。
    例外:
    IOExceptionSE - IOException。
  - finalizeRaw
```
public boolean finalizeRaw()
```
    インターフェースからコピーされた説明: Session
    Session.readRaw(String) から InputStream を閉じた後に呼び出します。一部のセッションプロバイダーで必要です。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の finalizeRaw
    戻り値:
    成功した場合は true。
  - write
```
public void write(InputStreamSE inputStream,
                  StringSE destination)
           throws IOExceptionSE
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の write
    例外:
    IOExceptionSE
  - append
```
public void append(InputStreamSE inputStream,
                   StringSE destination)
            throws IOExceptionSE
```
    インターフェースからコピーされた説明: Session
    ファイルに追加します。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の append
    パラメーター:
    inputStream - ストリーム。
    destination - 宛先。
    例外:
    IOExceptionSE - IO 例外。
  - close
```
public void close()
```
    次で指定:
    インターフェース CloseableSE の closeSE
    次で指定:
    インターフェース AutoCloseableSE の closeSE
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の close
  - isOpen
```
public boolean isOpen()
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の isOpen
  - rename
```
public void rename(StringSE pathFrom,
                   StringSE pathTo)
            throws IOExceptionSE
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の rename
    例外:
    IOExceptionSE
  - mkdir
```
public boolean mkdir(StringSE remoteDirectory)
              throws IOExceptionSE
```
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の mkdir
    例外:
    IOExceptionSE
  - rmdir
```
public boolean rmdir(StringSE remoteDirectory)
              throws IOExceptionSE
```
    インターフェースからコピーされた説明: Session
    リモートディレクトリを削除します。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の rmdir
    パラメーター:
    remoteDirectory - ディレクトリ。
    戻り値:
    ディレクトリが削除された場合は true。
    例外:
    IOExceptionSE - IO 例外。
  - exists
```
public boolean exists(StringSE path)
```
    インターフェースからコピーされた説明: Session
    リモートファイルまたはディレクトリが存在するかどうかを確認します。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の exists
    パラメーター:
    path - リモートパス。
    戻り値:
    リモートパスが存在するかどうかは、true または false です。
  - getClientInstance
```
public com.jcraft.jsch.ChannelSftp getClientInstance()
```
    インターフェースからコピーされた説明: Session
    このセッションの基礎となるクライアントライブラリのクライアントインスタンスを取得します。-file、-ftp、-sftp モジュールへの大幅な変更を避けるために Object を返します。これは、別のジェネリクスパラメーターを追加した場合に必要になります。実装では、戻り値の型を絞り込む必要があります。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の getClientInstance
    戻り値:
    クライアントインスタンス。
  - getHostPort
```
public StringSE getHostPort()
```
    インターフェースからコピーされた説明: Session
    このセッションが接続されているホストとポートのペアを返します。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の getHostPort
    戻り値:
    このセッションが接続されているホスト: ポートのペア。
  - test
```
public boolean test()
```
    インターフェースからコピーされた説明: Session
    セッションがまだ生きていることをテストします。プールからチェックアウトするとき。デフォルトの実装では、単に Session.isOpen() に委譲します。
    次で指定:
    インターフェース Session<com.jcraft.jsch.ChannelSftp.LsEntry> の test
    戻り値:
    テストが成功した場合は true。

クラス SftpSession

コンストラクターの概要

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.integration.file.remote.session.Session から継承されたメソッド

コンストラクターの詳細

SftpSession

SftpSession

メソッドの詳細

setChannelConnectTimeout

remove

list

listNames

read

readRaw

finalizeRaw

write

append

close

isOpen

rename

mkdir

rmdir

exists

getClientInstance

getHostPort

test