org.eclipse.jgit.internal.transport.sshd

Class JGitSshConfig

java.lang.Object

org.eclipse.jgit.internal.transport.sshd.JGitSshConfig

All Implemented Interfaces:

org.apache.sshd.client.config.hosts.HostConfigEntryResolver

public class JGitSshConfig
extends java.lang.Object
implements org.apache.sshd.client.config.hosts.HostConfigEntryResolver

A HostConfigEntryResolver adapted specifically for JGit.

We use our own config file parser and entry resolution since the default ConfigFileHostEntryResolver has a number of problems:

• It does case-insensitive pattern matching. Matching in OpenSsh is case-sensitive! Compare also bug 531118.
• It only merges values from the global items (before the first "Host" line) into the host entries. Otherwise it selects the most specific match. OpenSsh processes all entries in the order they appear in the file and whenever one matches, it updates values as appropriate.
• We have to ensure that ~ replacement uses the same HOME directory as JGit. Compare bug bug 526175.

Therefore, this re-uses the parsing and caching from OpenSshConfigFile.

Field Summary

Fields

Modifier and Type	Field and Description
private OpenSshConfigFile	configFile

Fields inherited from interface org.apache.sshd.client.config.hosts.HostConfigEntryResolver

EMPTY

Constructor Summary

Constructors

Constructor and Description
JGitSshConfig(java.io.File home, java.io.File config, java.lang.String localUserName) Creates a new OpenSshConfigFile that will read the config from file config use the given file home as "home" directory.

Method Summary

Modifier and Type	Method and Description
org.apache.sshd.client.config.hosts.HostConfigEntry	resolveEffectiveHost(java.lang.String host, int port, java.net.SocketAddress localAddress, java.lang.String username, org.apache.sshd.common.AttributeRepository attributes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFile

private OpenSshConfigFile configFile

Constructor Detail

JGitSshConfig

public JGitSshConfig(@NonNull
                     java.io.File home,
                     @NonNull
                     java.io.File config,
                     @NonNull
                     java.lang.String localUserName)

Creates a new OpenSshConfigFile that will read the config from file config use the given file home as "home" directory.

Parameters:

home - user's home directory for the purpose of ~ replacement

config - file to load.

localUserName - user name of the current user on the local host OS

Method Detail

resolveEffectiveHost

public org.apache.sshd.client.config.hosts.HostConfigEntry resolveEffectiveHost(java.lang.String host,
                                                                                int port,
                                                                                java.net.SocketAddress localAddress,
                                                                                java.lang.String username,
                                                                                org.apache.sshd.common.AttributeRepository attributes)
                                                                         throws java.io.IOException

Specified by:

resolveEffectiveHost in interface org.apache.sshd.client.config.hosts.HostConfigEntryResolver

Throws:

java.io.IOException