org.zodiac.server.proxy.http

接口 HttpFilters

所有已知实现类:

HttpFilterAdapterImpl, HttpFiltersAdapter

public interface HttpFilters

Interface for objects that filter HttpObjects, including both requests and responses, and informs of different steps in request/response.

Multiple methods are defined, corresponding to different steps in the request processing lifecycle. Some of these methods is given the current object (request, response or chunk) and is allowed to modify it in place. Others provide a notification of when specific operations happen (i.e. connection in queue, DNS resolution, SSL handshaking and so forth).

Because HTTP transfers can be chunked, for any given request or response, the filter methods that can modify request/response in place may be called multiple times, once for the initial HttpRequest or HttpResponse, and once for each subsequent HttpContent. The last chunk will always be a LastHttpContent and can be checked for being last using HttpProxyUtil.isLastChunk(HttpObject).

A new instance of HttpFilters is created for each request, so these objects can be stateful.

To monitor (and time measure?) the different steps the request/response goes through, many informative methods are provided. Those steps are reported in the following order:

1. clientToProxyRequest
2. proxyToServerConnectionQueued
3. proxyToServerResolutionStarted
4. proxyToServerResolutionSucceeded
5. proxyToServerRequest (can be multiple if chunked)
6. proxyToServerConnectionStarted
7. proxyToServerConnectionFailed (if connection couldn't be established)
8. proxyToServerConnectionSSLHandshakeStarted (only if HTTPS required)
9. proxyToServerConnectionSucceeded
10. proxyToServerRequestSending
11. proxyToServerRequestSent
12. serverToProxyResponseReceiving
13. serverToProxyResponse (can be multiple if chuncked)
14. serverToProxyResponseReceived
15. proxyToClientResponse

方法概要

限定符和类型	方法和说明
io.netty.handler.codec.http.HttpResponse	clientToProxyRequest(io.netty.handler.codec.http.HttpObject httpObject) Filters requests on their way from the client to the proxy.
io.netty.handler.codec.http.HttpObject	proxyToClientResponse(io.netty.handler.codec.http.HttpObject httpObject) Filters responses on their way from the proxy to the client.
void	proxyToServerConnectionFailed(FullFlowContext flowContext) Informs filter that proxy to server connection has failed.
void	proxyToServerConnectionQueued(FullFlowContext flowContext) Informs filter that proxy to server connection is in queue.
void	proxyToServerConnectionSSLHandshakeStarted(FullFlowContext flowContext) Informs filter that proxy to server ssl handshake is initiating.
void	proxyToServerConnectionStarted(FullFlowContext flowContext) Informs filter that proxy to server connection is initiating.
void	proxyToServerConnectionSucceeded(FullFlowContext flowContext) Informs filter that proxy to server connection has succeeded.
io.netty.handler.codec.http.HttpResponse	proxyToServerRequest(io.netty.handler.codec.http.HttpObject httpObject) Filters requests on their way from the proxy to the server.
void	proxyToServerRequestSending(FullFlowContext flowContext, io.netty.handler.codec.http.HttpRequest httpRequest)
void	proxyToServerRequestSent(FullFlowContext flowContext, io.netty.handler.codec.http.LastHttpContent lastHttpContent)
io.netty.handler.codec.http.HttpObject	serverToProxyResponse(io.netty.handler.codec.http.HttpObject httpObject) Filters responses on their way from the server to the proxy.
void	serverToProxyResponseReceived(FullFlowContext flowContext) Informs filter that server to proxy response has been received.
void	serverToProxyResponseReceiving(FullFlowContext flowContext) Informs filter that server to proxy response is being received.
void	serverToProxyResponseTimedOut() Informs filter that a timeout occurred before the server response was received by the client.

方法详细资料

clientToProxyRequest

io.netty.handler.codec.http.HttpResponse clientToProxyRequest(io.netty.handler.codec.http.HttpObject httpObject)

Filters requests on their way from the client to the proxy. To interrupt processing of this request and return a response to the client immediately, return an HttpResponse here. Otherwise, return null to continue processing as usual.

Important: When returning a response, you must include a mechanism to allow the client to determine the length of the message (see RFC 7230, section 3.3.3: https://tools.ietf.org/html/rfc7230#section-3.3.3 ). For messages that may contain a body, you may do this by setting the Transfer-Encoding to chunked, setting an appropriate Content-Length, or by adding a "Connection: close" header to the response (which will instruct LittleProxy to close the connection). If the short-circuit response contains body content, it is recommended that you return a FullHttpResponse.

参数:

httpObject - Client to Proxy HttpRequest (and HttpContent, if chunked)

返回:

a short-circuit response, or null to continue processing as usual

proxyToServerRequest

io.netty.handler.codec.http.HttpResponse proxyToServerRequest(io.netty.handler.codec.http.HttpObject httpObject)

Filters requests on their way from the proxy to the server. To interrupt processing of this request and return a response to the client immediately, return an HttpResponse here. Otherwise, return null to continue processing as usual.

Important: When returning a response, you must include a mechanism to allow the client to determine the length of the message (see RFC 7230, section 3.3.3: https://tools.ietf.org/html/rfc7230#section-3.3.3 ). For messages that may contain a body, you may do this by setting the Transfer-Encoding to chunked, setting an appropriate Content-Length, or by adding a "Connection: close" header to the response. (which will instruct LittleProxy to close the connection). If the short-circuit response contains body content, it is recommended that you return a FullHttpResponse.

参数:

httpObject - Proxy to Server HttpRequest (and HttpContent, if chunked)

返回:

a short-circuit response, or null to continue processing as usual

proxyToServerRequestSending

void proxyToServerRequestSending(FullFlowContext flowContext,
                                 io.netty.handler.codec.http.HttpRequest httpRequest)

参数:

flowContext - provides contextual information about the flow

httpRequest - Informs filter that proxy to server request is being sent.

proxyToServerRequestSent

void proxyToServerRequestSent(FullFlowContext flowContext,
                              io.netty.handler.codec.http.LastHttpContent lastHttpContent)

参数:

flowContext - the ChannelHandlerContext used to connect to the server

lastHttpContent - Informs filter that the HTTP request, including any content, has been sent.

serverToProxyResponse

io.netty.handler.codec.http.HttpObject serverToProxyResponse(io.netty.handler.codec.http.HttpObject httpObject)

Filters responses on their way from the server to the proxy.

参数:

httpObject - Server to Proxy HttpResponse (and HttpContent, if chunked)

返回:

the modified (or unmodified) HttpObject. Returning null will force a disconnect.

serverToProxyResponseTimedOut

void serverToProxyResponseTimedOut()

Informs filter that a timeout occurred before the server response was received by the client. The timeout may have occurred while the client was sending the request, waiting for a response, or after the client started receiving a response (i.e. if the response from the server "stalls"). See HttpProxyManagerBootstrap.withIdleConnectionTimeout(int) for information on setting the timeout.

serverToProxyResponseReceiving

void serverToProxyResponseReceiving(FullFlowContext flowContext)

Informs filter that server to proxy response is being received.

参数:

flowContext - the ChannelHandlerContext used to connect to the server

serverToProxyResponseReceived

void serverToProxyResponseReceived(FullFlowContext flowContext)

Informs filter that server to proxy response has been received.

参数:

flowContext - the ChannelHandlerContext used to connect to the server

proxyToClientResponse

io.netty.handler.codec.http.HttpObject proxyToClientResponse(io.netty.handler.codec.http.HttpObject httpObject)

Filters responses on their way from the proxy to the client.

参数:

httpObject - Proxy to Client HttpResponse (and HttpContent, if chunked)

返回:

the modified (or unmodified) HttpObject. Returning null will force a disconnect.

proxyToServerConnectionQueued

void proxyToServerConnectionQueued(FullFlowContext flowContext)

Informs filter that proxy to server connection is in queue.

参数:

flowContext - the ChannelHandlerContext used to connect to the server

proxyToServerConnectionStarted

void proxyToServerConnectionStarted(FullFlowContext flowContext)

Informs filter that proxy to server connection is initiating.

参数:

flowContext - the ChannelHandlerContext used to connect to the server

proxyToServerConnectionSSLHandshakeStarted

void proxyToServerConnectionSSLHandshakeStarted(FullFlowContext flowContext)

Informs filter that proxy to server ssl handshake is initiating.

参数:

flowContext - the ChannelHandlerContext used to connect to the server

proxyToServerConnectionFailed

void proxyToServerConnectionFailed(FullFlowContext flowContext)

Informs filter that proxy to server connection has failed.

参数:

flowContext - the ChannelHandlerContext used to connect to the server

proxyToServerConnectionSucceeded

void proxyToServerConnectionSucceeded(FullFlowContext flowContext)

Informs filter that proxy to server connection has succeeded.

参数:

flowContext - the ChannelHandlerContext used to connect to the server