com.github.mike10004.seleniumhelp

Class TrafficMonitorFilter

java.lang.Object

org.littleshoot.proxy.HttpFiltersAdapter

net.lightbody.bmp.filters.HttpsAwareFiltersAdapter

com.github.mike10004.seleniumhelp.TrafficMonitorFilter

All Implemented Interfaces:

org.littleshoot.proxy.HttpFilters

public class TrafficMonitorFilter
extends net.lightbody.bmp.filters.HttpsAwareFiltersAdapter

Implementation of HttpFilters that sends a notification when an HTTP response is received. This is still a pretty rough implementation, but it may suffice for limited use cases at this stage. Don't expect the HTTP request/response objects contained in the notification to be perfect representations.

Most of this code is copied from HarCaptureFilter. The main difference is that the HAR filter keeps adding to the HAR object when HTTP requests or responses are intercepted, but this implementation accumulates (most of) the same data and packages it up in a notification when the request/response interaction is completed. The interaction is considered completed when one of four methods is invoked:

• serverToProxyResponse(HttpObject) if everything goes normally,
• or one of the failure methods:
  • serverToProxyResponseTimedOut()
  • proxyToServerConnectionFailed()
  • proxyToServerResolutionFailed(String)

Field Summary

Fields inherited from class net.lightbody.bmp.filters.HttpsAwareFiltersAdapter

HOST_ATTRIBUTE_NAME, IS_HTTPS_ATTRIBUTE_NAME, ORIGINAL_HOST_ATTRIBUTE_NAME

Fields inherited from class org.littleshoot.proxy.HttpFiltersAdapter

ctx, NOOP_FILTER, originalRequest

Constructor Summary

Constructors

Constructor and Description
TrafficMonitorFilter(io.netty.handler.codec.http.HttpRequest originalRequest, io.netty.channel.ChannelHandlerContext ctx, TrafficMonitor trafficMonitor) Create a new instance of the HarCaptureFilter that will capture request and response information.

Method Summary

Modifier and Type	Method and Description
protected void	captureHeaders(io.netty.handler.codec.http.HttpHeaders headers, net.lightbody.bmp.core.har.HarRequest harRequest)
protected void	captureQueryParameters(io.netty.handler.codec.http.HttpRequest httpRequest, net.lightbody.bmp.core.har.HarRequest harRequest)
protected void	captureRedirectUrl(io.netty.handler.codec.http.HttpResponse httpResponse, net.lightbody.bmp.core.har.HarResponse harResponse)
protected void	captureRequestContent(io.netty.handler.codec.http.HttpRequest httpRequest, byte[] fullMessage, net.lightbody.bmp.core.har.HarRequest harRequest)
protected void	captureRequestHeaders(io.netty.handler.codec.http.HttpRequest httpRequest, net.lightbody.bmp.core.har.HarRequest harRequest)
protected void	captureResponse(io.netty.handler.codec.http.HttpResponse httpResponse, net.lightbody.bmp.core.har.HarResponse harResponse)
protected void	captureResponseContent(io.netty.handler.codec.http.HttpResponse httpResponse, byte[] fullMessage, net.lightbody.bmp.core.har.HarResponse harResponse)
protected void	captureResponseHeaders(io.netty.handler.codec.http.HttpResponse httpResponse, net.lightbody.bmp.core.har.HarResponse harResponse)
protected void	captureResponseHeaderSize(io.netty.handler.codec.http.HttpResponse httpResponse, net.lightbody.bmp.core.har.HarResponse harResponse)
protected void	captureResponseMimeType(io.netty.handler.codec.http.HttpResponse httpResponse, net.lightbody.bmp.core.har.HarResponse harResponse)
protected void	captureTrailingHeaders(io.netty.handler.codec.http.LastHttpContent lastHttpContent, net.lightbody.bmp.core.har.HarRequest harRequest)
io.netty.handler.codec.http.HttpResponse	clientToProxyRequest(io.netty.handler.codec.http.HttpObject httpObject)
protected void	populateAddressFromCache(io.netty.handler.codec.http.HttpRequest httpRequest) Populates the serverIpAddress field of the harEntry using the internal hostname to IP address cache.
io.netty.handler.codec.http.HttpObject	proxyToClientResponse(io.netty.handler.codec.http.HttpObject httpObject)
void	proxyToServerConnectionFailed()
void	proxyToServerRequestSending()
void	proxyToServerResolutionFailed(String hostAndPort)
void	proxyToServerResolutionSucceeded(String serverHostAndPort, InetSocketAddress resolvedRemoteAddress)
io.netty.handler.codec.http.HttpObject	serverToProxyResponse(io.netty.handler.codec.http.HttpObject httpObject)
void	serverToProxyResponseTimedOut()

Methods inherited from class net.lightbody.bmp.filters.HttpsAwareFiltersAdapter

getFullUrl, getHost, getHostAndPort, getOriginalUrl, isHttps

Methods inherited from class org.littleshoot.proxy.HttpFiltersAdapter

proxyToServerConnectionQueued, proxyToServerConnectionSSLHandshakeStarted, proxyToServerConnectionStarted, proxyToServerConnectionSucceeded, proxyToServerRequest, proxyToServerRequestSent, proxyToServerResolutionStarted, serverToProxyResponseReceived, serverToProxyResponseReceiving

Methods inherited from class java.lang.Object

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

Constructor Detail

TrafficMonitorFilter

public TrafficMonitorFilter(io.netty.handler.codec.http.HttpRequest originalRequest,
                            io.netty.channel.ChannelHandlerContext ctx,
                            TrafficMonitor trafficMonitor)

Create a new instance of the HarCaptureFilter that will capture request and response information. If no har is specified in the constructor, this filter will do nothing.

Regardless of the CaptureTypes specified in dataToCapture, the HarCaptureFilter will always capture:

• Request and response sizes
• HTTP request and status lines
• Page timing information

Parameters:

originalRequest - the original HttpRequest from the HttpFiltersSource factory

ctx - channel handler context

trafficMonitor - traffic monitor (subscriber to notifications from this filter)

Throws:

IllegalArgumentException - if request method is CONNECT

Method Detail

clientToProxyRequest

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

Specified by:

clientToProxyRequest in interface org.littleshoot.proxy.HttpFilters

Overrides:

clientToProxyRequest in class org.littleshoot.proxy.HttpFiltersAdapter

proxyToClientResponse

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

Specified by:

proxyToClientResponse in interface org.littleshoot.proxy.HttpFilters

Overrides:

proxyToClientResponse in class org.littleshoot.proxy.HttpFiltersAdapter

serverToProxyResponse

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

Specified by:

serverToProxyResponse in interface org.littleshoot.proxy.HttpFilters

Overrides:

serverToProxyResponse in class org.littleshoot.proxy.HttpFiltersAdapter

captureQueryParameters

protected void captureQueryParameters(io.netty.handler.codec.http.HttpRequest httpRequest,
                                      net.lightbody.bmp.core.har.HarRequest harRequest)

captureRequestHeaders

protected void captureRequestHeaders(io.netty.handler.codec.http.HttpRequest httpRequest,
                                     net.lightbody.bmp.core.har.HarRequest harRequest)

captureTrailingHeaders

protected void captureTrailingHeaders(io.netty.handler.codec.http.LastHttpContent lastHttpContent,
                                      net.lightbody.bmp.core.har.HarRequest harRequest)

captureHeaders

protected void captureHeaders(io.netty.handler.codec.http.HttpHeaders headers,
                              net.lightbody.bmp.core.har.HarRequest harRequest)

captureRequestContent

protected void captureRequestContent(io.netty.handler.codec.http.HttpRequest httpRequest,
                                     byte[] fullMessage,
                                     net.lightbody.bmp.core.har.HarRequest harRequest)

captureResponseContent

protected void captureResponseContent(io.netty.handler.codec.http.HttpResponse httpResponse,
                                      byte[] fullMessage,
                                      net.lightbody.bmp.core.har.HarResponse harResponse)

captureResponse

protected void captureResponse(io.netty.handler.codec.http.HttpResponse httpResponse,
                               net.lightbody.bmp.core.har.HarResponse harResponse)

captureResponseMimeType

protected void captureResponseMimeType(io.netty.handler.codec.http.HttpResponse httpResponse,
                                       net.lightbody.bmp.core.har.HarResponse harResponse)

captureResponseHeaderSize

protected void captureResponseHeaderSize(io.netty.handler.codec.http.HttpResponse httpResponse,
                                         net.lightbody.bmp.core.har.HarResponse harResponse)

captureResponseHeaders

protected void captureResponseHeaders(io.netty.handler.codec.http.HttpResponse httpResponse,
                                      net.lightbody.bmp.core.har.HarResponse harResponse)

captureRedirectUrl

protected void captureRedirectUrl(io.netty.handler.codec.http.HttpResponse httpResponse,
                                  net.lightbody.bmp.core.har.HarResponse harResponse)

populateAddressFromCache

protected void populateAddressFromCache(io.netty.handler.codec.http.HttpRequest httpRequest)

Populates the serverIpAddress field of the harEntry using the internal hostname to IP address cache.

Parameters:

httpRequest - HTTP request to take the hostname from

proxyToServerResolutionSucceeded

public void proxyToServerResolutionSucceeded(String serverHostAndPort,
                                             InetSocketAddress resolvedRemoteAddress)

Specified by:

proxyToServerResolutionSucceeded in interface org.littleshoot.proxy.HttpFilters

Overrides:

proxyToServerResolutionSucceeded in class org.littleshoot.proxy.HttpFiltersAdapter

proxyToServerRequestSending

public void proxyToServerRequestSending()

Specified by:

proxyToServerRequestSending in interface org.littleshoot.proxy.HttpFilters

Overrides:

proxyToServerRequestSending in class org.littleshoot.proxy.HttpFiltersAdapter

proxyToServerResolutionFailed

public void proxyToServerResolutionFailed(String hostAndPort)

Specified by:

proxyToServerResolutionFailed in interface org.littleshoot.proxy.HttpFilters

Overrides:

proxyToServerResolutionFailed in class org.littleshoot.proxy.HttpFiltersAdapter

proxyToServerConnectionFailed

public void proxyToServerConnectionFailed()

Specified by:

proxyToServerConnectionFailed in interface org.littleshoot.proxy.HttpFilters

Overrides:

proxyToServerConnectionFailed in class org.littleshoot.proxy.HttpFiltersAdapter

serverToProxyResponseTimedOut

public void serverToProxyResponseTimedOut()

Specified by:

serverToProxyResponseTimedOut in interface org.littleshoot.proxy.HttpFilters

Overrides:

serverToProxyResponseTimedOut in class org.littleshoot.proxy.HttpFiltersAdapter