Class ConfigFileHostEntryResolver

    • Constructor Detail

      • ConfigFileHostEntryResolver

        public ConfigFileHostEntryResolver​(Path file)
      • ConfigFileHostEntryResolver

        public ConfigFileHostEntryResolver​(Path file,
                                           LinkOption... options)
    • Method Detail

      • resolveEffectiveHost

        public HostConfigEntry resolveEffectiveHost​(String host,
                                                    int port,
                                                    SocketAddress localAddress,
                                                    String username,
                                                    AttributeRepository context)
                                             throws 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:
        IOException - If failed to resolve the configuration