Package org.springframework.boot.devtools.tunnel.client

Class HttpTunnelConnection

java.lang.Object

org.springframework.boot.devtools.tunnel.client.HttpTunnelConnection

All Implemented Interfaces:

TunnelConnection

public class HttpTunnelConnection
extends Object
implements TunnelConnection

TunnelConnection implementation that uses HTTP to transfer data.

Since:

1.3.0

Author:

Phillip Webb, Rob Winch, Andy Wilkinson

See Also:

• TunnelClient
• HttpTunnelServer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	HttpTunnelConnection.TunnelChannel	A WritableByteChannel used to transfer traffic.

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpTunnelConnection(String url, ClientHttpRequestFactory requestFactory)	Create a new HttpTunnelConnection instance.
protected	HttpTunnelConnection(String url, ClientHttpRequestFactory requestFactory, Executor executor)	Create a new HttpTunnelConnection instance.

Method Summary

Modifier and Type	Method	Description
protected final ClientHttpRequest	createRequest(boolean hasPayload)
HttpTunnelConnection.TunnelChannel	open(WritableByteChannel incomingChannel, Closeable closeable)	Open the tunnel connection.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpTunnelConnection

public HttpTunnelConnection(String url,
 ClientHttpRequestFactory requestFactory)

Create a new HttpTunnelConnection instance.

Parameters:

url - the URL to connect to

requestFactory - the HTTP request factory

HttpTunnelConnection

protected HttpTunnelConnection(String url,
 ClientHttpRequestFactory requestFactory,
 Executor executor)

Create a new HttpTunnelConnection instance.

Parameters:

url - the URL to connect to

requestFactory - the HTTP request factory

executor - the executor used to handle connections

Method Details

open

public HttpTunnelConnection.TunnelChannel open(WritableByteChannel incomingChannel,
 Closeable closeable)
                                        throws Exception

Description copied from interface: TunnelConnection

Open the tunnel connection.

Specified by:

open in interface TunnelConnection

Parameters:

incomingChannel - a WritableByteChannel that should be used to write any incoming data received from the remote server

closeable - a closeable to call when the channel is closed

Returns:

a WritableByteChannel that should be used to send any outgoing data destined for the remote server

Throws:

Exception - in case of errors

createRequest

protected final ClientHttpRequest createRequest(boolean hasPayload)
                                         throws IOException

Throws:

IOException