bayou.http

Class ConnectTunnel

java.lang.Object

bayou.http.ConnectTunnel

All Implemented Interfaces:

TcpTunnel

public class ConnectTunnel
extends Object
implements TcpTunnel

A TcpTunnel using HTTP CONNECT method. See RFC7231 §4.3.6

Such tunnel is often used for "HTTPS proxy"; but it can be used for tunneling any TCP traffic too.

Basic/Digest authentications are supported.

This class is stateful for caching authentication state.

Constructor Summary

Constructors

Constructor and Description
ConnectTunnel(TcpAddress address, Supplier<Async<UserPass>> userPassSupplier) Create an HTTP CONNECT tunnel.
ConnectTunnel(String host, int port, String username, String password) Create an HTTP CONNECT tunnel.
ConnectTunnel(String host, int port) Create an HTTP CONNECT tunnel.

Method Summary

Instance Methods
TcpAddress	address() The address of the tunnel service.
Async<TcpConnection>	tunnelTo(TcpConnection tcpConn, String host, int port) Tunnel to the remote host:port.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectTunnel

public ConnectTunnel(TcpAddress address,
                     Supplier<Async<UserPass>> userPassSupplier)

Create an HTTP CONNECT tunnel.

If userPassSupplier!=null, BASIC and DIGEST authentications are supported.

ConnectTunnel

public ConnectTunnel(String host,
                     int port,
                     String username,
                     String password)

Create an HTTP CONNECT tunnel.

This is a convenience method for ConnectTunnel(address, userPassSupplier) with address.ssl=false.

ConnectTunnel

public ConnectTunnel(String host,
                     int port)

Create an HTTP CONNECT tunnel.

This is a convenience method for ConnectTunnel(address, userPassSupplier) with address.ssl=false, userPassSupplier=null.

Method Detail

address

public TcpAddress address()

Description copied from interface: TcpTunnel

The address of the tunnel service.

If address.ssl==true, traffic between the client and the tunnel must be encrypted in SSL.

Specified by:

address in interface TcpTunnel

tunnelTo

public Async<TcpConnection> tunnelTo(TcpConnection tcpConn,
                                     String host,
                                     int port)

Description copied from interface: TcpTunnel

Tunnel to the remote host:port.

The `connection` is established between the client and the tunnel service. The implementation of this method does necessary protocol dance to instruct the tunnel service to tunnel to the server (at host:port).

When this action succeeds, the resulting TcpConnection is used by the client to communicate to the server, as if it's a direct connection. The resulting TcpConnection could be the same object as the `connection` argument.

Specified by:

tunnelTo in interface TcpTunnel