org.apache.sshd.client.config.hosts

Class ConfigFileHostEntryResolver

java.lang.Object

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

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

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

All Implemented Interfaces:

HostConfigEntryResolver

Direct Known Subclasses:

DefaultConfigFileHostEntryResolver

public class ConfigFileHostEntryResolver
extends ModifiableFileWatcher
implements HostConfigEntryResolver

Watches for changes in a configuration file and automatically reloads any changes

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.atomic.AtomicReference<HostConfigEntryResolver>	delegateHolder

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 and Description
ConfigFileHostEntryResolver(java.nio.file.Path file)
ConfigFileHostEntryResolver(java.nio.file.Path file, java.nio.file.LinkOption... options)

Method Summary

Modifier and Type	Method and Description
protected java.util.List<HostConfigEntry>	reloadHostConfigEntries(java.nio.file.Path path, java.lang.String host, int port, java.lang.String username)
HostConfigEntry	resolveEffectiveHost(java.lang.String host, int port, java.net.SocketAddress localAddress, java.lang.String username, AttributeRepository context) Invoked when creating a new client session in order to allow for overriding of the original parameters
protected HostConfigEntryResolver	resolveEffectiveResolver(java.lang.String host, int port, java.lang.String username)

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

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Field Detail

delegateHolder

private final java.util.concurrent.atomic.AtomicReference<HostConfigEntryResolver> delegateHolder

Constructor Detail

ConfigFileHostEntryResolver

public ConfigFileHostEntryResolver(java.nio.file.Path file)

ConfigFileHostEntryResolver

public ConfigFileHostEntryResolver(java.nio.file.Path file,
                                   java.nio.file.LinkOption... options)

Method Detail

resolveEffectiveHost

public HostConfigEntry resolveEffectiveHost(java.lang.String host,
                                            int port,
                                            java.net.SocketAddress localAddress,
                                            java.lang.String username,
                                            AttributeRepository context)
                                     throws java.io.IOException

Description copied from interface: HostConfigEntryResolver

Invoked when creating a new client session in order to allow for overriding of the original parameters

Specified by:

resolveEffectiveHost in interface HostConfigEntryResolver

Parameters:

host - The requested host - never null/empty

port - The requested port

localAddress - Optional binding endpoint for the local peer

username - The requested username

context - An optional "context" provided during the connection request (to be attached to the established session if successfully connected)

Returns:

A HostConfigEntry for the actual target - null if use original parameters. Note: if any identity files are attached to the configuration then they must point to existing locations. This means that any macros such as ~, %d, %h, etc. must be resolved prior to returning the value

Throws:

java.io.IOException - If failed to resolve the configuration

resolveEffectiveResolver

protected HostConfigEntryResolver resolveEffectiveResolver(java.lang.String host,
                                                           int port,
                                                           java.lang.String username)
                                                    throws java.io.IOException

Throws:

java.io.IOException

reloadHostConfigEntries

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

Throws:

java.io.IOException