Class OpenSshConfig.Host
- java.lang.Object
-
- org.eclipse.jgit.transport.ssh.jsch.OpenSshConfig.Host
-
- Enclosing class:
- OpenSshConfig
public static class OpenSshConfig.Host extends java.lang.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.
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.lang.Boolean
batchMode
private com.jcraft.jsch.ConfigRepository.Config
config
(package private) int
connectionAttempts
private OpenSshConfigFile.HostEntry
entry
(package private) java.lang.String
hostName
(package private) java.io.File
identityFile
private static java.util.Map<java.lang.String,java.lang.String>
KEY_MAP
(package private) int
port
(package private) java.lang.String
preferredAuthentications
(package private) java.lang.String
strictHostKeyChecking
(package private) java.lang.String
user
-
Constructor Summary
Constructors Constructor Description Host()
Creates a new uninitializedOpenSshConfig.Host
.Host(OpenSshConfigFile.HostEntry entry, java.lang.String hostName, java.lang.String localUserName)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
complete(java.lang.String initialHostName, java.lang.String localUserName)
com.jcraft.jsch.ConfigRepository.Config
getConfig()
Get the ssh configurationint
getConnectionAttempts()
java.lang.String
getHostName()
java.io.File
getIdentityFile()
int
getPort()
java.lang.String
getPreferredAuthentications()
java.lang.String
getStrictHostKeyChecking()
java.lang.String
getUser()
boolean
isBatchMode()
private static java.lang.String
mapKey(java.lang.String key)
java.lang.String
toString()
-
-
-
Field Detail
-
hostName
java.lang.String hostName
-
port
int port
-
identityFile
java.io.File identityFile
-
user
java.lang.String user
-
preferredAuthentications
java.lang.String preferredAuthentications
-
batchMode
java.lang.Boolean batchMode
-
strictHostKeyChecking
java.lang.String strictHostKeyChecking
-
connectionAttempts
int connectionAttempts
-
entry
private OpenSshConfigFile.HostEntry entry
-
config
private com.jcraft.jsch.ConfigRepository.Config config
-
KEY_MAP
private static final java.util.Map<java.lang.String,java.lang.String> KEY_MAP
-
-
Constructor Detail
-
Host
public Host()
Creates a new uninitializedOpenSshConfig.Host
.
-
Host
Host(OpenSshConfigFile.HostEntry entry, java.lang.String hostName, java.lang.String localUserName)
-
-
Method Detail
-
mapKey
private static java.lang.String mapKey(java.lang.String key)
-
getStrictHostKeyChecking
public java.lang.String getStrictHostKeyChecking()
- 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 java.lang.String getHostName()
- Returns:
- the real IP address or host name to connect to; never null.
-
getPort
public int getPort()
- Returns:
- the real port number to connect to; never 0.
-
getIdentityFile
public java.io.File getIdentityFile()
- Returns:
- path of the private key file to use for authentication; null if the caller should use default authentication strategies.
-
getUser
public java.lang.String getUser()
- Returns:
- the real user name to connect as; never null.
-
getPreferredAuthentications
public java.lang.String getPreferredAuthentications()
- Returns:
- the preferred authentication methods, separated by commas if more than one authentication method is preferred.
-
isBatchMode
public boolean isBatchMode()
- Returns:
- true if batch (non-interactive) mode is preferred for this host connection.
-
getConnectionAttempts
public int getConnectionAttempts()
- 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
-
complete
private void complete(java.lang.String initialHostName, java.lang.String localUserName)
-
getConfig
public com.jcraft.jsch.ConfigRepository.Config getConfig()
Get the ssh configuration- Returns:
- the ssh configuration
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-