Package org.apache.sshd.client.config.hosts

Class DefaultConfigFileHostEntryResolver

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.io.ModifiableFileWatcher

org.apache.sshd.client.config.hosts.ConfigFileHostEntryResolver

org.apache.sshd.client.config.hosts.DefaultConfigFileHostEntryResolver

All Implemented Interfaces:

HostConfigEntryResolver

public class DefaultConfigFileHostEntryResolver
extends ConfigFileHostEntryResolver

Monitors the ~/.ssh/config file of the user currently running the client, re-loading it if necessary. It also (optionally) enforces the same permissions regime as OpenSSH

Field Summary

Fields

Modifier and Type	Field	Description
static DefaultConfigFileHostEntryResolver	INSTANCE	The default instance that enforces the same permissions regime as OpenSSH
private boolean	strict

Fields inherited from class org.apache.sshd.common.util.io.ModifiableFileWatcher

options, STRICTLY_PROHIBITED_FILE_PERMISSION

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultConfigFileHostEntryResolver(boolean strict)
DefaultConfigFileHostEntryResolver(java.nio.file.Path path, boolean strict, java.nio.file.LinkOption... options)

Method Summary

Modifier and Type	Method	Description
boolean	isStrict()
protected java.util.List<HostConfigEntry>	reloadHostConfigEntries(java.nio.file.Path path, java.lang.String host, int port, java.lang.String username, java.lang.String proxyJump)

Methods inherited from class org.apache.sshd.client.config.hosts.ConfigFileHostEntryResolver

resolveEffectiveHost, resolveEffectiveResolver

Methods inherited from class org.apache.sshd.common.util.io.ModifiableFileWatcher

checkReloadRequired, exists, getPath, lastModified, resetReloadAttributes, size, toPathResource, toPathResource, toString, updateReloadAttributes, validateStrictConfigFilePermissions

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DefaultConfigFileHostEntryResolver INSTANCE

The default instance that enforces the same permissions regime as OpenSSH

strict

private final boolean strict

Constructor Detail

DefaultConfigFileHostEntryResolver

public DefaultConfigFileHostEntryResolver(boolean strict)

Parameters:

strict - If true then makes sure that the containing folder has 0700 access and the file 0644. Note: for Windows it does not check these permissions

See Also:

ModifiableFileWatcher.validateStrictConfigFilePermissions(Path, LinkOption...)

DefaultConfigFileHostEntryResolver

public DefaultConfigFileHostEntryResolver(java.nio.file.Path path,
                                          boolean strict,
                                          java.nio.file.LinkOption... options)

Method Detail

isStrict

public final boolean isStrict()

Returns:

If true then makes sure that the containing folder has 0700 access and the file 0644. Note: for Windows it does not check these permissions

See Also:

ModifiableFileWatcher.validateStrictConfigFilePermissions(Path, LinkOption...)

reloadHostConfigEntries

protected java.util.List<HostConfigEntry> reloadHostConfigEntries(java.nio.file.Path path,
                                                                  java.lang.String host,
                                                                  int port,
                                                                  java.lang.String username,
                                                                  java.lang.String proxyJump)
                                                           throws java.io.IOException

Overrides:

reloadHostConfigEntries in class ConfigFileHostEntryResolver

Throws:

java.io.IOException