クラス DefaultSftpSessionFactory

メソッドの詳細

• setHost

  public void setHost(StringSE host)

  接続したいホストの URL。これは必須のプロパティです。

  パラメーター:

  host - ザホスト。

  関連事項:

  • ClientSessionCreator.connect(String, String, int)

• setPort

  public void setPort(int port)

  SFTP 接続が確立されるポート。指定しない場合、この値はデフォルトで 22 になります。指定する場合、このプロパティは正数でなければなりません。

  パラメーター:

  port - ポート。

  関連事項:

  • ClientSessionCreator.connect(String, String, int)

• setUser

  public void setUser(StringSE user)

  使用するリモートユーザー。これは必須のプロパティです。

  パラメーター:

  user - ユーザー。

  関連事項:

  • ClientSessionCreator.connect(String, String, int)

• setPassword

  public void setPassword(StringSE password)

  リモートホストに対して認証するためのパスワード。パスワードが提供されない場合、privateKey は必須です。

  パラメーター:

  password - パスワード。

  関連事項:

  • SshClient.setPasswordIdentityProvider(PasswordIdentityProvider)

• setHostConfig

  public void setHostConfig(org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig)

  ユーザー / ホスト / ポートオプションの代替として HostConfigEntry を提供します。プロキシジャンププロパティを使用して構成できます。

  パラメーター:

  hostConfig - 接続用の HostConfigEntry。

  導入:

  6.0

  関連事項:

  • ClientSessionCreator.connect(HostConfigEntry)

• setKnownHostsResource

  public void setKnownHostsResource(Resource knownHosts)

  ホスト鍵リポジトリに使用される Resource を指定します。データは、OpenSSH の known_hosts ファイルと同じ形式である必要があります。

  パラメーター:

  knownHosts - 既知のホストのリソース。

  導入:

  5.2.5

  関連事項:

  • SshClient.setServerKeyVerifier(ServerKeyVerifier)

• setPrivateKey

  public void setPrivateKey(Resource privateKey)

  リモートホストに対する認証に使用される秘密鍵の場所を表す Resource を設定できます。privateKey が指定されていない場合は、password プロパティが必須です。

  パラメーター:

  privateKey - 秘密鍵。

  関連事項:

  • SshClient.setKeyIdentityProvider(KeyIdentityProvider)

• setPrivateKeyPassphrase

  public void setPrivateKeyPassphrase(StringSE privateKeyPassphrase)

  秘密鍵のパスワード。オプション。

  パラメーター:

  privateKeyPassphrase - 秘密鍵のパスフレーズ。

  関連事項:

  • SshClient.setKeyIdentityProvider(KeyIdentityProvider)

• setUserInteraction

  public void setUserInteraction(org.apache.sshd.client.auth.keyboard.UserInteraction userInteraction)

  新しいキーまたはキーの変更を処理するための制御を公開する UserInteraction を提供します。Spring Integration は通常、ユーザーの操作を許可しないため、実装は適切な方法で SSH プロトコル呼び出しに応答する必要があります。

  パラメーター:

  userInteraction - UserInteraction。

  導入:

  4.1.7

  関連事項:

  • SshClient.setUserInteraction(UserInteraction)

• setAllowUnknownKeys

  public void setAllowUnknownKeys(boolean allowUnknownKeys)

  knownHosts が提供されていない場合、不明なホストへの接続を無条件に許可するか、ホストのキーが変更された場合 (knownHosts を参照)、true に設定します。デフォルトは false (4.2 以降)。knownHosts ファイルが提供されていない場合は true に設定します。

  パラメーター:

  allowUnknownKeys - 不明なホストへの接続を許可する場合は true。

  導入:

  4.1.7

• setTimeout

  public void setTimeout(IntegerSE timeout)

  timeout プロパティは、デフォルトの接続タイムアウトだけでなく、ソケットタイムアウトパラメーターとしても使用されます。デフォルトは 30 seconds です。0 に設定すると、タイムアウトがないことを意味します。null へ - 無限待機。

  パラメーター:

  timeout - タイムアウト。

  関連事項:

  • VerifiableFuture.verify(Duration, org.apache.sshd.common.future.CancelOption...)

• setSftpVersionSelector

  public void setSftpVersionSelector(org.apache.sshd.sftp.client.SftpVersionSelector sftpVersionSelector)

• setSshClientConfigurer

  public void setSshClientConfigurer(ConsumerSE<org.apache.sshd.client.SshClient> sshClientConfigurer)

  内部 SshClient インスタンスをさらにカスタマイズするには、ConsumerSE をコールバックとして設定します。例: PropertyResolverUtils.updateProperty(org.apache.sshd.common.PropertyResolver, java.lang.String, long) API を使用してそのプロパティのカスタム値を設定します。

  パラメーター:

  sshClientConfigurer - ConsumerSE を使用して内部 SshClient インスタンスを構成します。

  導入:

  6.4

  関連事項:

  • SshClient
  • PropertyResolverUtils.updateProperty(org.apache.sshd.common.PropertyResolver, java.lang.String, long)

• getSession

  public SftpSession getSession()

  次で指定:

  インターフェース SessionFactory<org.apache.sshd.sftp.client.SftpClient.DirEntry> の getSession 

• isSharedSession

  public final boolean isSharedSession()

  次で指定:

  インターフェース SharedSessionCapable の isSharedSession 

  戻り値:

  このファクトリが共有セッションを使用する場合は true。

• resetSharedSession

  public void resetSharedSession()

  インターフェースからコピーされた説明: SharedSessionCapable

  共有セッションをリセットして、次の #getSession() が新しい接続を使用してセッションを返すようにします。

  次で指定:

  インターフェース SharedSessionCapable の resetSharedSession 

• createSftpClient

  protected org.apache.sshd.sftp.client.SftpClient createSftpClient(org.apache.sshd.client.session.ClientSession clientSession, org.apache.sshd.sftp.client.SftpVersionSelector initialVersionSelector, org.apache.sshd.sftp.client.SftpErrorDataHandler errorDataHandler) throws IOExceptionSE

  カスタム SftpClient から getSession() を提供するようにオーバーライドできます。

  パラメーター:

  clientSession - ClientSession

  initialVersionSelector - 初期 SftpVersionSelector

  errorDataHandler - SftpErrorDataHandler は、エラーストリームを通じて受信データを処理します。

  戻り値:

  SftpClient

  例外:

  IOExceptionSE - 初期化に失敗した場合

  導入:

  6.1.3

• destroy

  public void destroy()

  次で指定:

  インターフェース DisposableBean の destroy