org.zodiac.server.proxy.impl

类 ProxyToServerConnection

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<I>

org.zodiac.server.proxy.impl.ProxyConnection<Object>

org.zodiac.server.proxy.impl.HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

org.zodiac.server.proxy.impl.ProxyToServerConnection

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

@ChannelHandler.Sharable
public class ProxyToServerConnection
extends HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

Represents a connection from our proxy to a server on the web. ProxyConnections are reused fairly liberally, and can go from disconnected to connected, back to disconnected and so on.

Connecting a ProxyToServerConnection can involve more than just connecting the underlying Channel. In particular, the connection may use encryption (i.e. TLS) and it may also establish an HTTP CONNECT tunnel. The various steps involved in fully establishing a connection are encapsulated in the property connectionFlow, which is initialized in initializeConnectionFlow().

嵌套类概要

嵌套类

限定符和类型	类和说明
private class	ProxyToServerConnection.HeadAwareHttpResponseDecoder Responses to HEAD requests aren't supposed to have content, but Netty doesn't know that any given response is to a HEAD request, so it needs to be told that there's no content so that it doesn't hang waiting for it.

从类继承的嵌套类/接口 org.zodiac.server.proxy.impl.HttpProxyConnection

HttpProxyConnection.RequestReadMonitor, HttpProxyConnection.RequestWrittenMonitor, HttpProxyConnection.ResponseReadMonitor, HttpProxyConnection.ResponseWrittenMonitor

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
private ClientToProxyConnection	clientConnection
private ConnectionFlowStep	ConnectChannel
private ConnectionFlow	connectionFlow
private Object	connectLock
private HttpFilters	currentFilters
private HttpRequestWrapper	currentHttpRequest
private io.netty.handler.codec.http.HttpResponse	currentHttpResponse
private FullFlowContext	flowContext
private InetSocketAddress	localAddress
private ProxyConfigOptions	proxyConfigOptions
private InetSocketAddress	remoteAddress
private HttpProxyConnection.RequestWrittenMonitor	requestWrittenMonitor
private HttpProxyConnection.ResponseReadMonitor	responseReadMonitor Activity Tracking/Statistics We track statistics on bytes, requests and responses by adding handlers at the appropriate parts of the pipeline (see initChannelPipeline()).
private io.netty.handler.traffic.GlobalTrafficShapingHandler	trafficHandler
private TransportProtocol	transportProtocol

从类继承的字段 org.zodiac.server.proxy.impl.HttpProxyConnection

log, proxyManager

从类继承的字段 org.zodiac.server.proxy.impl.ProxyConnection

channel, ctx, lastReadTime, logger, sslEngine

构造器概要

构造器

限定符	构造器和说明
private	ProxyToServerConnection(ProxyConfigOptions proxyConfigOptions, HttpProxyManager httpProxyManager, String applicationName, ClientToProxyConnection clientConnection, HttpFilters initialFilters, io.netty.handler.traffic.GlobalTrafficShapingHandler globalTrafficShapingHandler, InetSocketAddress remoteAddress)

方法概要

限定符和类型	方法和说明
protected void	becameSaturated() Callback that's invoked if this connection becomes saturated.
protected void	becameWritable() Callback that's invoked when this connection becomes writeable again.
protected void	become(ConnectionState newState) Lifecycle
private ChannelFuture	connect()
private void	connectAndWrite(HttpRequestWrapper currentHttpRequest)
protected boolean	connectionFailed(Throwable cause) Called when the connection to the server or upstream chained proxy fails.
(专用程序包) void	connectionSucceeded(boolean shouldForwardInitialRequest) Do all the stuff that needs to be done after our ConnectionFlow has succeeded.
(专用程序包) static ProxyToServerConnection	create(ProxyConfigOptions proxyConfigOptions, HttpProxyManager httpProxyManager, String applicationName, ClientToProxyConnection clientConnection, HttpFilters initialFilters, InetSocketAddress remoteAddress, io.netty.handler.traffic.GlobalTrafficShapingHandler globalTrafficShapingHandler)
protected void	disconnected() This method is called as soon as the underlying Channel becomes disconnected.
protected void	exceptionCaught(Throwable cause) Override this to handle exceptions that occurred during asynchronous processing on the Channel.
HttpRequestWrapper	getCurrentHttpRequest()
protected HttpFilters	getHttpFiltersFromProxyServer(io.netty.handler.codec.http.HttpRequest httpRequest) Request the ProxyServer for Filters.
InetSocketAddress	getRemoteAddress()
TransportProtocol	getTransportProtocol() Get transport protocol.
private String	hostToString(InetSocketAddress address)
private void	initChannelPipeline(ChannelPipeline pipeline) Initialize our ChannelPipeline to connect the upstream server.
private void	initializeConnectionFlow()
protected void	readHTTPChunk(io.netty.handler.codec.http.HttpContent chunk) Implement this to handle reading a chunk in a chunked transfer.
protected ConnectionState	readHTTPInitial(io.netty.handler.codec.http.HttpResponse httpResponse) Implement this to handle reading the initial object (e.g.
protected void	readIncoming(ChannelHandlerContext ctx, Object msg) Reading
private void	rememberCurrentResponse(io.netty.handler.codec.http.HttpResponse response) Keeps track of the current HttpResponse so that we can associate its headers with future related chunks for this same transfer.
private void	replaceProxyHostForRemoteConnenct(io.netty.handler.codec.http.HttpRequest httpRequest, String host)
private void	respondWith(io.netty.handler.codec.http.HttpObject httpObject)
void	setCurrentHttpRequest(HttpRequestWrapper currentHttpRequest)
private void	setupConnectionParameters() Set up our connection parameters based on server address and chained proxies.
protected void	timedOut() This method is called when the underlying Channel times out due to an idle timeout.
(专用程序包) void	write(HttpRequestWrapper httpRequest, HttpFilters filters) Like write(Object) and also sets the current filters to the given value.
(专用程序包) void	write(Object msg) This method is called by users of the ProxyConnection to send stuff out over the socket.
protected void	writeHttp(io.netty.handler.codec.http.HttpObject httpObject) Writes HttpObjects to the connection asynchronously.

从类继承的方法 org.zodiac.server.proxy.impl.HttpProxyConnection

connected, disconnect, doWrite, encrypt, encrypt, getLOG, getSslEngine, isSaturated, readProxyIncoming, resumeReading, stopReading, writeRaw, writeToChannel, writeToChannelNoFlush

从类继承的方法 org.zodiac.server.proxy.impl.ProxyConnection

channelActive, channelInactive, channelRead0, channelRegistered, channelRegistered0, channelWritabilityChanged, exceptionCaught, getApplicationName, getChannel, getCurrentState, is, isConnecting, userEventTriggered

从类继承的方法 io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelUnregistered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

字段详细资料

clientConnection

private final ClientToProxyConnection clientConnection

transportProtocol

private volatile TransportProtocol transportProtocol

remoteAddress

private volatile InetSocketAddress remoteAddress

localAddress

private volatile InetSocketAddress localAddress

currentFilters

private volatile HttpFilters currentFilters

connectionFlow

private volatile ConnectionFlow connectionFlow

connectLock

private final Object connectLock

currentHttpRequest

private volatile HttpRequestWrapper currentHttpRequest

currentHttpResponse

private volatile io.netty.handler.codec.http.HttpResponse currentHttpResponse

trafficHandler

private volatile io.netty.handler.traffic.GlobalTrafficShapingHandler trafficHandler

flowContext

private volatile FullFlowContext flowContext

proxyConfigOptions

private final ProxyConfigOptions proxyConfigOptions

ConnectChannel

private ConnectionFlowStep ConnectChannel

responseReadMonitor

private HttpProxyConnection.ResponseReadMonitor responseReadMonitor

Activity Tracking/Statistics We track statistics on bytes, requests and responses by adding handlers at the appropriate parts of the pipeline (see initChannelPipeline()).

requestWrittenMonitor

private HttpProxyConnection.RequestWrittenMonitor requestWrittenMonitor

构造器详细资料

ProxyToServerConnection

private ProxyToServerConnection(ProxyConfigOptions proxyConfigOptions,
                                HttpProxyManager httpProxyManager,
                                String applicationName,
                                ClientToProxyConnection clientConnection,
                                HttpFilters initialFilters,
                                io.netty.handler.traffic.GlobalTrafficShapingHandler globalTrafficShapingHandler,
                                InetSocketAddress remoteAddress)
                         throws UnknownHostException

抛出:

UnknownHostException

方法详细资料

create

static ProxyToServerConnection create(ProxyConfigOptions proxyConfigOptions,
                                      HttpProxyManager httpProxyManager,
                                      String applicationName,
                                      ClientToProxyConnection clientConnection,
                                      HttpFilters initialFilters,
                                      InetSocketAddress remoteAddress,
                                      io.netty.handler.traffic.GlobalTrafficShapingHandler globalTrafficShapingHandler)
                               throws UnknownHostException

抛出:

UnknownHostException

readIncoming

protected void readIncoming(ChannelHandlerContext ctx,
                            Object msg)

Reading

覆盖:

readIncoming 在类中 ProxyConnection<Object>

参数:

ctx - handler context

msg - message

readHTTPInitial

protected ConnectionState readHTTPInitial(io.netty.handler.codec.http.HttpResponse httpResponse)

从类复制的说明: HttpProxyConnection

Implement this to handle reading the initial object (e.g. HttpRequest or HttpResponse).

指定者:

readHTTPInitial 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

参数:

httpResponse - http object

返回:

connection state

readHTTPChunk

protected void readHTTPChunk(io.netty.handler.codec.http.HttpContent chunk)

从类复制的说明: HttpProxyConnection

Implement this to handle reading a chunk in a chunked transfer.

指定者:

readHTTPChunk 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

参数:

chunk - http content

write

void write(HttpRequestWrapper httpRequest,
           HttpFilters filters)

Like write(Object) and also sets the current filters to the given value.

参数:

httpRequest - request

filters - filter collection

write

void write(Object msg)

从类复制的说明: HttpProxyConnection

This method is called by users of the ProxyConnection to send stuff out over the socket.

覆盖:

write 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

参数:

msg - message

writeHttp

protected void writeHttp(io.netty.handler.codec.http.HttpObject httpObject)

从类复制的说明: HttpProxyConnection

Writes HttpObjects to the connection asynchronously.

覆盖:

writeHttp 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

参数:

httpObject - http bject

replaceProxyHostForRemoteConnenct

private void replaceProxyHostForRemoteConnenct(io.netty.handler.codec.http.HttpRequest httpRequest,
                                               String host)

hostToString

private String hostToString(InetSocketAddress address)

become

protected void become(ConnectionState newState)

Lifecycle

覆盖:

become 在类中 ProxyConnection<Object>

参数:

newState - connection state

becameSaturated

protected void becameSaturated()

从类复制的说明: HttpProxyConnection

Callback that's invoked if this connection becomes saturated.

覆盖:

becameSaturated 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

becameWritable

protected void becameWritable()

从类复制的说明: HttpProxyConnection

Callback that's invoked when this connection becomes writeable again.

覆盖:

becameWritable 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

timedOut

protected void timedOut()

从类复制的说明: HttpProxyConnection

This method is called when the underlying Channel times out due to an idle timeout.

覆盖:

timedOut 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

disconnected

protected void disconnected()

从类复制的说明: HttpProxyConnection

This method is called as soon as the underlying Channel becomes disconnected.

覆盖:

disconnected 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

exceptionCaught

protected void exceptionCaught(Throwable cause)

从类复制的说明: HttpProxyConnection

Override this to handle exceptions that occurred during asynchronous processing on the Channel.

覆盖:

exceptionCaught 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

参数:

cause - raised error

getTransportProtocol

public TransportProtocol getTransportProtocol()

Get transport protocol.

返回:

transport protocol

getRemoteAddress

public InetSocketAddress getRemoteAddress()

getHttpFiltersFromProxyServer

protected HttpFilters getHttpFiltersFromProxyServer(io.netty.handler.codec.http.HttpRequest httpRequest)

从类复制的说明: HttpProxyConnection

Request the ProxyServer for Filters. By default, no-op filters are returned by DefaultHttpProxyServer. Subclasses of ProxyConnection can change this behaviour.

覆盖:

getHttpFiltersFromProxyServer 在类中 HttpProxyConnection<io.netty.handler.codec.http.HttpResponse>

参数:

httpRequest - Filter attached to the give HttpRequest (if any)

返回:

filters

rememberCurrentResponse

private void rememberCurrentResponse(io.netty.handler.codec.http.HttpResponse response)

Keeps track of the current HttpResponse so that we can associate its headers with future related chunks for this same transfer.

参数:

response - http response

respondWith

private void respondWith(io.netty.handler.codec.http.HttpObject httpObject)

connectAndWrite

private void connectAndWrite(HttpRequestWrapper currentHttpRequest)

initializeConnectionFlow

private void initializeConnectionFlow()

connect

private ChannelFuture connect()

connectionFailed

protected boolean connectionFailed(Throwable cause)
                            throws UnknownHostException

Called when the connection to the server or upstream chained proxy fails. This method may return true to indicate that the connection should be retried. If returning true, this method must set up the connection itself.

参数:

cause - the reason that our attempt to connect failed (can be null)

返回:

true if we are trying to fall back to another connection

抛出:

UnknownHostException - when unable to resolve the hostname to an IP address

setupConnectionParameters

private void setupConnectionParameters()
                                throws UnknownHostException

Set up our connection parameters based on server address and chained proxies.

抛出:

UnknownHostException - when unable to resolve the hostname to an IP address

initChannelPipeline

private void initChannelPipeline(ChannelPipeline pipeline)

Initialize our ChannelPipeline to connect the upstream server. Proxy acts as a client here. A ChannelPipeline invokes the read (Inbound) handlers in ascending ordering of the list and then the write (Outbound) handlers in descending ordering. Regarding the Javadoc of HttpObjectAggregator it's needed to have the HttpResponseEncoder or HttpRequestEncoder before the HttpObjectAggregator in the ChannelPipeline.

参数:

pipeline - channel pipeline

connectionSucceeded

void connectionSucceeded(boolean shouldForwardInitialRequest)

Do all the stuff that needs to be done after our ConnectionFlow has succeeded.

参数:

shouldForwardInitialRequest - whether or not we should forward the initial HttpRequest to the server after the connection has been established.

getCurrentHttpRequest

public HttpRequestWrapper getCurrentHttpRequest()

setCurrentHttpRequest

public void setCurrentHttpRequest(HttpRequestWrapper currentHttpRequest)