Interface ClientSessionCreator

    • Method Detail

      • connect

        default ConnectFuture connect​(java.lang.String username,
                                      java.lang.String host,
                                      int port)
                               throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        host - The target host name/address - never null/empty
        port - The target port
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
        See Also:
        connect(HostConfigEntry)
      • connect

        default ConnectFuture connect​(java.lang.String username,
                                      java.lang.String host,
                                      int port,
                                      AttributeRepository context)
                               throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        host - The target host name/address - never null/empty
        port - The target port
        context - An optional "context" to be attached to the established session if successfully connected
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
      • connect

        default ConnectFuture connect​(java.lang.String username,
                                      java.lang.String host,
                                      int port,
                                      java.net.SocketAddress localAddress)
                               throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        host - The target host name/address - never null/empty
        port - The target port
        localAddress - The local address to use - if null an automatic ephemeral port and bind address is used
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
        See Also:
        connect(HostConfigEntry)
      • connect

        ConnectFuture connect​(java.lang.String username,
                              java.lang.String host,
                              int port,
                              AttributeRepository context,
                              java.net.SocketAddress localAddress)
                       throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        host - The target host name/address - never null/empty
        port - The target port
        context - An optional "context" to be attached to the established session if successfully connected
        localAddress - The local address to use - if null an automatic ephemeral port and bind address is used
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
      • connect

        default ConnectFuture connect​(java.lang.String username,
                                      java.net.SocketAddress address)
                               throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        address - The intended SocketAddress - never null. If this is an InetSocketAddress then the effective HostConfigEntry is resolved and used.
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
        See Also:
        connect(HostConfigEntry)
      • connect

        default ConnectFuture connect​(java.lang.String username,
                                      java.net.SocketAddress address,
                                      AttributeRepository context)
                               throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        address - The intended SocketAddress - never null. If this is an InetSocketAddress then the effective HostConfigEntry is resolved and used.
        context - An optional "context" to be attached to the established session if successfully connected
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
      • connect

        default ConnectFuture connect​(java.lang.String username,
                                      java.net.SocketAddress targetAddress,
                                      java.net.SocketAddress localAddress)
                               throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        targetAddress - The intended target SocketAddress - never null. If this is an InetSocketAddress then the effective HostConfigEntry is resolved and used.
        localAddress - The local address to use - if null an automatic ephemeral port and bind address is used
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
        See Also:
        connect(HostConfigEntry)
      • connect

        ConnectFuture connect​(java.lang.String username,
                              java.net.SocketAddress targetAddress,
                              AttributeRepository context,
                              java.net.SocketAddress localAddress)
                       throws java.io.IOException
        Resolves the effective HostConfigEntry and connects to it
        Parameters:
        username - The intended username
        targetAddress - The intended target SocketAddress - never null. If this is an InetSocketAddress then the effective HostConfigEntry is resolved and used.
        context - An optional "context" to be attached to the established session if successfully connected
        localAddress - The local address to use - if null an automatic ephemeral port and bind address is used
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to resolve the effective target or connect to it
      • connect

        default ConnectFuture connect​(HostConfigEntry hostConfig,
                                      AttributeRepository context)
                               throws java.io.IOException
        Parameters:
        hostConfig - The effective HostConfigEntry to connect to - never null
        context - An optional "context" to be attached to the established session if successfully connected
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to create the connection future
      • connect

        default ConnectFuture connect​(HostConfigEntry hostConfig,
                                      java.net.SocketAddress localAddress)
                               throws java.io.IOException
        Parameters:
        hostConfig - The effective HostConfigEntry to connect to - never null
        localAddress - The local address to use - if null an automatic ephemeral port and bind address is used
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to create the connection future
      • connect

        ConnectFuture connect​(HostConfigEntry hostConfig,
                              AttributeRepository context,
                              java.net.SocketAddress localAddress)
                       throws java.io.IOException
        Parameters:
        hostConfig - The effective HostConfigEntry to connect to - never null
        context - An optional "context" to be attached to the established session if successfully connected
        localAddress - The local address to use - if null an automatic ephemeral port and bind address is used
        Returns:
        A ConnectFuture
        Throws:
        java.io.IOException - If failed to create the connection future