Module org.eclipse.jgit.ssh.jsch
Package org.eclipse.jgit.transport.ssh.jsch

Class OpenSshConfig.Host

java.lang.Object
org.eclipse.jgit.transport.ssh.jsch.OpenSshConfig.Host
Enclosing class:
OpenSshConfig
public static class OpenSshConfig.Host extends Object
Configuration of one "Host" block in the configuration file.

If returned from OpenSshConfig.lookup(String) some or all of the properties may not be populated. The properties which are not populated should be defaulted by the caller.

When returned from OpenSshConfig.lookup(String) any wildcard entries which appear later in the configuration file will have been already merged into this block.

  • Constructor Details

  • Method Details

    • getStrictHostKeyChecking

      public String getStrictHostKeyChecking()
      Get the value StrictHostKeyChecking property
      Returns:
      the value StrictHostKeyChecking property, the valid values are "yes" (unknown hosts are not accepted), "no" (unknown hosts are always accepted), and "ask" (user should be asked before accepting the host)

    • getHostName

      public String getHostName()
      Get hostname
      Returns:
      the real IP address or host name to connect to; never null.

    • getPort

      public int getPort()
      Get port
      Returns:
      the real port number to connect to; never 0.

    • getIdentityFile

      public File getIdentityFile()
      Get identity file
      Returns:
      path of the private key file to use for authentication; null if the caller should use default authentication strategies.

    • getUser

      public String getUser()
      Get user
      Returns:
      the real user name to connect as; never null.

    • getPreferredAuthentications

      public String getPreferredAuthentications()
      Get preferred authentication methods
      Returns:
      the preferred authentication methods, separated by commas if more than one authentication method is preferred.

    • isBatchMode

      public boolean isBatchMode()
      Whether batch mode is preferred
      Returns:
      true if batch (non-interactive) mode is preferred for this host connection.

    • getConnectionAttempts

      public int getConnectionAttempts()
      Get connection attempts
      Returns:
      the number of tries (one per second) to connect before exiting. The argument must be an integer. This may be useful in scripts if the connection sometimes fails. The default is 1.
      Since:
      3.4

    • getConfig

      public com.jcraft.jsch.ConfigRepository.Config getConfig()
      Get the ssh configuration
      Returns:
      the ssh configuration

    • toString

      public String toString()
      Overrides:
      toString in class Object