org.apache.sshd.client.config.hosts

Interface HostConfigEntryResolver

All Known Implementing Classes:

ConfigFileHostEntryResolver, DefaultConfigFileHostEntryResolver

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HostConfigEntryResolver

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static HostConfigEntryResolver	EMPTY An "empty" implementation that does not resolve any entry

Method Summary

Modifier and Type	Method and Description
HostConfigEntry	resolveEffectiveHost(String host, int port, String username) Invoked when creating a new client session in order to allow for overriding of the original parameters

Field Detail

EMPTY

static final HostConfigEntryResolver EMPTY

An "empty" implementation that does not resolve any entry

Method Detail

resolveEffectiveHost

HostConfigEntry resolveEffectiveHost(String host,
                                     int port,
                                     String username)
                              throws IOException

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

Parameters:

host - The requested host - never null/empty

port - The requested port

username - The requested username

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:

IOException - If failed to resolve the configuration