DefaultSftpSessionFactory (Spring Integration API)

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

実装されたすべてのインターフェース:
SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry>, SharedSessionCapable
```
public class DefaultSftpSessionFactory
extends ObjectSE
implements SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry>, SharedSessionCapable
```
SftpSession インスタンスを作成するためのファクトリ。
導入:
2.0
作成者:
Josh Long, Mario Gray, Oleg Zhurakousky, Gunnar Hillert, Gary Russell, David Liu, Pat Turner, Artem Bilan

コンストラクターの概要

コンストラクター
コンストラクターと説明
`DefaultSftpSessionFactory()`
`DefaultSftpSessionFactory(boolean isSharedSession)`
`DefaultSftpSessionFactory(com.jcraft.jsch.JSch jsch, boolean isSharedSession)` jsch を for 笑できるように、テストでの使用を目的としています。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`SftpSession`	`getSession()`
`boolean`	`isSharedSession()`
`void`	`resetSharedSession()` 共有セッションをリセットして、次の `#getSession()` が新しい接続を使用してセッションを返すようにします。
`void`	`setAllowUnknownKeys(boolean allowUnknownKeys)` `UserInfo` が提供されていない場合は、true に設定して、未知のホストへの接続を無条件に許可するか、ホストのキーが変更された場合（`knownHosts` を参照）。
`void`	`setChannelConnectTimeout(java.time.Duration timeout)` 接続タイムアウトを設定します。
`void`	`setClientVersion(StringSE clientVersion)` クライアントバージョンプロパティを設定できます。
`void`	`setEnableDaemonThread(BooleanSE enableDaemonThread)` true の場合、すべてのスレッドはデーモンスレッドになります。
`void`	`setHost(StringSE host)` 接続するホストの URL。
`void`	`setHostKeyAlias(StringSE hostKeyAlias)` ホストキーを既知のホストリストと比較するときに使用されるホストキーエイリアスを設定します。
`void`	`setKnownHosts(StringSE knownHosts)` 使用すべきではありません。 5.2.5 以降、`setKnownHostsResource(Resource)` を推奨
`void`	`setKnownHostsResource(Resource knownHosts)` ホストキーリポジトリに使用されるファイル名を指定します。
`void`	`setPassword(StringSE password)` リモートホストに対して認証するパスワード。
`void`	`setPort(int port)` SFTP 接続が確立されるポート。
`void`	`setPrivateKey(Resource privateKey)` リモートホストに対する認証に使用される秘密鍵の場所を表す `Resource` を設定できます。
`void`	`setPrivateKeyPassphrase(StringSE privateKeyPassphrase)` 秘密鍵のパスワード。
`void`	`setProxy(com.jcraft.jsch.Proxy proxy)` JSch ベースの `Proxy` を指定できます。
`void`	`setServerAliveCountMax(IntegerSE serverAliveCountMax)` 切断する前にサーバーからの応答なしで送信されるサーバー生存メッセージの数を指定します。
`void`	`setServerAliveInterval(IntegerSE serverAliveInterval)` サーバーからメッセージが受信されない場合に、サーバーアライブメッセージが送信されるまでのタイムアウト間隔（ミリ秒）を設定します。
`void`	`setSessionConfig(PropertiesSE sessionConfig)` `Properties`SE を使用して、基礎となる JSch `Session` に追加の構成設定を設定できます。
`void`	`setSocketFactory(com.jcraft.jsch.SocketFactory socketFactory)` `SocketFactory` を渡すことができます。
`void`	`setTimeout(IntegerSE timeout)` タイムアウトプロパティは、デフォルトの接続タイムアウトと同様に、ソケットタイムアウトパラメーターとして使用されます。
`void`	`setUser(StringSE user)` 使用するリモートユーザー。
`void`	`setUserInfo(com.jcraft.jsch.UserInfo userInfo)` 新しいキーまたはキーの変更を処理する制御を公開する `UserInfo` を提供します。

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

- コンストラクターの詳細
  - DefaultSftpSessionFactory
```
public DefaultSftpSessionFactory()
```
  - DefaultSftpSessionFactory
```
public DefaultSftpSessionFactory(boolean isSharedSession)
```
    パラメーター:
    isSharedSession - セッションを共有する場合は true。
  - DefaultSftpSessionFactory
```
public DefaultSftpSessionFactory(com.jcraft.jsch.JSch jsch,
                                 boolean isSharedSession)
```
    jsch を for 笑できるように、テストでの使用を目的としています。
    パラメーター:
    jsch - jsch インスタンス。
    isSharedSession - セッションを共有する場合は true。
- メソッドの詳細
  - setHost
```
public void setHost(StringSE host)
```
    接続するホストの URL。これは必須のプロパティです。
    パラメーター:
    host - ザホスト。
    関連事項:
    JSch.getSession(String, String, int)
  - setPort
```
public void setPort(int port)
```
    SFTP 接続が確立されるポート。指定しない場合、この値はデフォルトで 22 になります。指定する場合、このプロパティは正数でなければなりません。
    パラメーター:
    port - ポート。
    関連事項:
    JSch.getSession(String, String, int)
  - setUser
```
public void setUser(StringSE user)
```
    使用するリモートユーザー。これは必須のプロパティです。
    パラメーター:
    user - ユーザー。
    関連事項:
    JSch.getSession(String, String, int)
  - setPassword
```
public void setPassword(StringSE password)
```
    リモートホストに対して認証するパスワード。パスワードが提供されない場合、privateKey は必須です。userInfo が提供されている場合は許可されません - パスワードはそのオブジェクトから取得されます。
    パラメーター:
    password - パスワード。
    関連事項:
    Session.setPassword(String)
  - setKnownHosts
```
@DeprecatedSE
public void setKnownHosts(StringSE knownHosts)
```
    非推奨。5.2.5 から setKnownHostsResource(Resource) に移行
    ホストキーリポジトリに使用されるファイル名を指定します。ファイルの形式は、OpenSSH の known_hosts ファイルと同じです。
    allowUnknownKeys が false（デフォルト）の場合は必須。
    パラメーター:
    knownHosts - 既知のホスト。
    関連事項:
    JSch.setKnownHosts(String)
  - setKnownHostsResource
```
public void setKnownHostsResource(Resource knownHosts)
```
    ホストキーリポジトリに使用されるファイル名を指定します。ファイルの形式は、OpenSSH の known_hosts ファイルと同じです。
    パラメーター:
    knownHosts - 既知のホストのリソース。
    導入:
    5.2.5
    関連事項:
    JSch.setKnownHosts(java.io.InputStream)
  - setPrivateKey
```
public void setPrivateKey(Resource privateKey)
```
    リモートホストに対する認証に使用される秘密鍵の場所を表す Resource を設定できます。privateKey が指定されていない場合は、password プロパティ (またはパスワードを返す userInfo) が必須です。
    パラメーター:
    privateKey - 秘密鍵。
    関連事項:
    JSch.addIdentity(String), JSch.addIdentity(String, String)
  - setPrivateKeyPassphrase
```
public void setPrivateKeyPassphrase(StringSE privateKeyPassphrase)
```
    秘密鍵のパスワード。オプション。userInfo が提供されている場合は許可されません - パスフレーズはそのオブジェクトから取得されます。
    パラメーター:
    privateKeyPassphrase - 秘密鍵のパスフレーズ。
    関連事項:
    JSch.addIdentity(String, String)
  - setSessionConfig
```
public void setSessionConfig(PropertiesSE sessionConfig)
```
    PropertiesSE を使用して、基礎となる JSch Session に追加の構成設定を設定できます。
    パラメーター:
    sessionConfig - セッション構成プロパティ。
    関連事項:
    Session.setConfig(Properties)
  - setProxy
```
public void setProxy(com.jcraft.jsch.Proxy proxy)
```
    JSch ベースの Proxy を指定できます。設定すると、プロキシオブジェクトを使用してリモートホストへの接続が作成されます。
    パラメーター:
    proxy - プロキシ。
    関連事項:
    Session.setProxy(Proxy)
  - setSocketFactory
```
public void setSocketFactory(com.jcraft.jsch.SocketFactory socketFactory)
```
    SocketFactory を渡すことができます。ソケットファクトリは、ターゲットホストへのソケットを作成するために使用されます。Proxy を使用すると、ソケットファクトリがプロキシに渡されます。デフォルトでは、プレーンな TCP ソケットが使用されます。
    パラメーター:
    socketFactory - ソケットファクトリ。
    関連事項:
    Session.setSocketFactory(SocketFactory)
  - setTimeout
```
public void setTimeout(IntegerSE timeout)
```
    タイムアウトプロパティは、デフォルトの接続タイムアウトと同様に、ソケットタイムアウトパラメーターとして使用されます。デフォルトは 0 です。つまり、タイムアウトは発生しません。
    パラメーター:
    timeout - タイムアウト。
    関連事項:
    Session.setTimeout(int)
  - setClientVersion
```
public void setClientVersion(StringSE clientVersion)
```
    クライアントバージョンプロパティを設定できます。デフォルトは基礎となる JSch バージョンに依存しますが、SSH-2.0-JSCH-0.1.45 のようになります
    パラメーター:
    clientVersion - クライアントのバージョン。
    関連事項:
    Session.setClientVersion(String)
  - setHostKeyAlias
```
public void setHostKeyAlias(StringSE hostKeyAlias)
```
    ホストキーを既知のホストリストと比較するときに使用されるホストキーエイリアスを設定します。
    パラメーター:
    hostKeyAlias - ホストキーのエイリアス。
    関連事項:
    Session.setHostKeyAlias(String)
  - setServerAliveInterval
```
public void setServerAliveInterval(IntegerSE serverAliveInterval)
```
    サーバーからメッセージが受信されない場合に、サーバーアライブメッセージが送信されるまでのタイムアウト間隔（ミリ秒）を設定します。
    パラメーター:
    serverAliveInterval - サーバーの生存間隔。
    関連事項:
    Session.setServerAliveInterval(int)
  - setServerAliveCountMax
```
public void setServerAliveCountMax(IntegerSE serverAliveCountMax)
```
    切断する前にサーバーからの応答なしで送信されるサーバー生存メッセージの数を指定します。設定しない場合、このプロパティはデフォルトで 1 になります。
    パラメーター:
    serverAliveCountMax - サーバーの最大生存数。
    関連事項:
    Session.setServerAliveCountMax(int)
  - setEnableDaemonThread
```
public void setEnableDaemonThread(BooleanSE enableDaemonThread)
```
    true の場合、すべてのスレッドはデーモンスレッドになります。false に設定すると、通常の非デーモンスレッドが使用されます。このプロパティは、Session.setDaemonThread(boolean) を使用して、基になる Session に設定されます。明示的に設定されていない場合、このプロパティはデフォルトで false になります。
    パラメーター:
    enableDaemonThread - デーモンスレッドを有効にする場合は true。
    関連事項:
    Session.setDaemonThread(boolean)
  - setUserInfo
```
public void setUserInfo(com.jcraft.jsch.UserInfo userInfo)
```
    新しいキーまたはキーの変更を処理する制御を公開する UserInfo を提供します。Spring Integration は通常、ユーザーとの対話を許可しないため、実装は適切な方法で Jsch 呼び出しに応答する必要があります。
    Jsch は、不明なホストに接続するとき、または既知のホストのキーが変更されたときに UserInfo.promptYesNo(String) を呼び出します（setKnownHostsResource(Resource) knownHosts を参照）。通常、true を返すとすべての新しいキーまたはキーの変更が受け入れられるため、false を返す必要があります。
    UserInfo が提供されない場合、動作は allowUnknownKeys によって定義されます。
    setPassword が null 以外のパスワードで呼び出された場合、指定された UserInfo のパスワードはすべてオーバーライドされます。
    NOTE: これが指定されている場合、password および passphrase は許可されません。これらの値は UserInfo から取得されるためです。
    パラメーター:
    userInfo - UserInfo。
    導入:
    4.1.7
    関連事項:
    Session.setUserInfo(com.jcraft.jsch.UserInfo)
  - setAllowUnknownKeys
```
public void setAllowUnknownKeys(boolean allowUnknownKeys)
```
    UserInfo が提供されていない場合、不明なホストへの接続を無条件に許可するか、ホストのキーが変更された場合 (knownHosts を参照)、true に設定します。デフォルトは false (4.2 以降)。knownHosts ファイルが提供されていない場合は true に設定します。
    パラメーター:
    allowUnknownKeys - 不明なホストへの接続を許可する場合は true。
    導入:
    4.1.7
  - setChannelConnectTimeout
```
public void setChannelConnectTimeout(java.time.Duration timeout)
```
    接続タイムアウトを設定します。
    パラメーター:
    timeout - 設定するタイムアウト。
    導入:
    5.2
  - getSession
```
public SftpSession getSession()
```
    次で指定:
    インターフェース SessionFactory<com.jcraft.jsch.ChannelSftp.LsEntry> の getSession
  - isSharedSession
```
public final boolean isSharedSession()
```
    次で指定:
    インターフェース SharedSessionCapable の isSharedSession
    戻り値:
    このファクトリが共有セッションを使用する場合は true。
  - resetSharedSession
```
public void resetSharedSession()
```
    インターフェースからコピーされた説明: SharedSessionCapable
    共有セッションをリセットして、次の #getSession() が新しい接続を使用してセッションを返すようにします。
    次で指定:
    インターフェース SharedSessionCapable の resetSharedSession

クラス DefaultSftpSessionFactory

コンストラクターの概要

メソッドのサマリー

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

コンストラクターの詳細

DefaultSftpSessionFactory

DefaultSftpSessionFactory

DefaultSftpSessionFactory

メソッドの詳細

setHost

setPort

setUser

setPassword

setKnownHosts

setKnownHostsResource

setPrivateKey

setPrivateKeyPassphrase

setSessionConfig

setProxy

setSocketFactory

setTimeout

setClientVersion

setHostKeyAlias

setServerAliveInterval

setServerAliveCountMax

setEnableDaemonThread

setUserInfo

setAllowUnknownKeys

setChannelConnectTimeout

getSession

isSharedSession

resetSharedSession