Apache Mina SSHD 2.15.0 · org.apache.sshd.client.config.hosts.ConfigFileHostEntryResolver

Modifier and Type	Field and Description
private final AtomicReference<HostConfigEntryResolver>	delegateHolder

Access	Constructor and Description
public	ConfigFileHostEntryResolver(Path file)
public	ConfigFileHostEntryResolver(Path file, LinkOption... options)

Method Summary

Modifier and Type	Method and Description
protected List<HostConfigEntry>	reloadHostConfigEntries(Path path, String host, int port, String username, String proxyJump)
public HostConfigEntry	resolveEffectiveHost(String The requested host - never `null`/empty host, int The requested port port, SocketAddress Optional binding endpoint for the local peer localAddress, String The requested username username, String The requested proxyJump proxyJump, AttributeRepository An optional "context" provided during the connection request (to be attached to the established session if successfully connected) context) Implements org.apache.sshd.client.config.hosts.HostConfigEntryResolver.resolveEffectiveHost. Invoked when creating a new client session in order to allow for overriding of the original parameters
protected HostConfigEntryResolver	resolveEffectiveResolver(String host, int port, String username, String proxyJump)

Inherited from org.apache.sshd.common.util.io.ModifiableFileWatcher:: checkReloadRequired exists getPath lastModified resetReloadAttributes size toPathResource toPathResource toString updateReloadAttributes validateStrictConfigFilePermissions

delegateHolder	back to summary
private final AtomicReference<HostConfigEntryResolver> delegateHolder

ConfigFileHostEntryResolver	back to summary
public ConfigFileHostEntryResolver(Path file)

ConfigFileHostEntryResolver	back to summary
public ConfigFileHostEntryResolver(Path file, LinkOption... options)

Method Detail

reloadHostConfigEntries	back to summary
protected List<HostConfigEntry> reloadHostConfigEntries(Path path, String host, int port, String username, String proxyJump) throws IOException

resolveEffectiveHost back to summary

resolveEffectiveHost	back to summary
public HostConfigEntry resolveEffectiveHost(String host, int port, SocketAddress localAddress, String username, String proxyJump, AttributeRepository context) throws IOException Implements org.apache.sshd.client.config.hosts.HostConfigEntryResolver.resolveEffectiveHost. Doc from org.apache.sshd.client.config.hosts.HostConfigEntryResolver.resolveEffectiveHost. Invoked when creating a new client session in order to allow for overriding of the original parameters Parameters host:String The requested host - never `null`/empty port:int The requested port localAddress:SocketAddress Optional binding endpoint for the local peer username:String The requested username proxyJump:String The requested proxyJump context:AttributeRepository An optional "context" provided during the connection request (to be attached to the established session if successfully connected) Returns:HostConfigEntry 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 Annotations @Override Exceptions IOException: If failed to resolve the configuration

public HostConfigEntry resolveEffectiveHost(String host, int port, SocketAddress localAddress, String username, String proxyJump, AttributeRepository context) throws IOException

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

Doc from org.apache.sshd.client.config.hosts.HostConfigEntryResolver.resolveEffectiveHost.

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

Parameters

host:String: The requested host - never null/empty
port:int: The requested port
localAddress:SocketAddress: Optional binding endpoint for the local peer
username:String: The requested username
proxyJump:String: The requested proxyJump
context:AttributeRepository: An optional "context" provided during the connection request (to be attached to the established session if successfully connected)

Returns:HostConfigEntry

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

Annotations

@Override

Exceptions

IOException:: If failed to resolve the configuration

resolveEffectiveResolver	back to summary
protected HostConfigEntryResolver resolveEffectiveResolver(String host, int port, String username, String proxyJump) throws IOException

public Class ConfigFileHostEntryResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail