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
- See Also:
- ssh_config
-
-
Field Summary
Fields Modifier and Type Field Description static HostConfigEntryResolver
EMPTY
An "empty" implementation that does not resolve any entry - i.e., uses the original entry as-is
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HostConfigEntry
resolveEffectiveHost(java.lang.String host, int port, java.net.SocketAddress localAddress, java.lang.String username, java.lang.String proxyJump, AttributeRepository context)
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 - i.e., uses the original entry as-is
-
-
Method Detail
-
resolveEffectiveHost
HostConfigEntry resolveEffectiveHost(java.lang.String host, int port, java.net.SocketAddress localAddress, java.lang.String username, java.lang.String proxyJump, AttributeRepository context) throws java.io.IOException
Invoked when creating a new client session in order to allow for overriding of the original parameters- Parameters:
host
- The requested host - nevernull
/emptyport
- The requested portlocalAddress
- Optional binding endpoint for the local peerusername
- The requested usernameproxyJump
- The requested proxyJumpcontext
- 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
-
-