HttpSniffer

A local proxy that intercepts browser HTTP traffic for inspection.

crawler/webJavadoc: HttpSniffer

Notes

Operates as a local proxy that intercepts HTTP traffic from a browser-based fetcher (such as a WebDriver fetcher) to capture request and response details. Supports custom request headers, buffer size limits, and optional chained proxy configuration.

Usage

YAML

chainedProxy:
  credentials:
    password: string
    passwordKey: {}
    username: string
  host:
    name: string
    port: 0
  realm: string
  scheme: string
host: string
maxBufferSize: 0
networkInterface: string
port: 0
requestHeaders: {}
responseTimeout: 0
userAgent: string

JSON

{
  "chainedProxy": {
    "credentials": {
      "password": "string",
      "passwordKey": {},
      "username": "string"
    },
    "host": {
      "name": "string",
      "port": 0
    },
    "realm": "string",
    "scheme": "string"
  },
  "host": "string",
  "maxBufferSize": 0,
  "networkInterface": "string",
  "port": 0,
  "requestHeaders": {},
  "responseTimeout": 0,
  "userAgent": "string"
}

XML

<httpSniffer>
  <chainedProxy>
    <credentials>
      <password>string</password>
      <passwordKey/>
      <username>string</username>
    </credentials>
    <host>
      <name>string</name>
      <port>0</port>
    </host>
    <realm>string</realm>
    <scheme>string</scheme>
  </chainedProxy>
  <host>string</host>
  <maxBufferSize>0</maxBufferSize>
  <networkInterface>string</networkInterface>
  <port>0</port>
  <requestHeaders/>
  <responseTimeout>0</responseTimeout>
  <userAgent>string</userAgent>
</httpSniffer>

Properties

Property	Type	Required	Default
chainedProxy	ProxySettings	No	-
host	string	No	-
maxBufferSize	integer	No	-
networkInterface	string	No	-
port	integer	No	-
requestHeaders	Record<string, string>	No	-
responseTimeout	integer	No	-
userAgent	string	No	-

Property Details

chainedProxy

Configure the HTTP Sniffer to go through a proxy.

host

Host name to use to access the HTTP sniffer as a proxy. Default is "localhost".

maxBufferSize

Maximum byte size before a request/response content is considered too large.

networkInterface

The network interface address (IP) for the sniffer proxy to listen on for incoming connections. Defaults to 0.0.0.0 (all interfaces).

port

Port under which to run the HTTP sniffer as a proxy. Use zero (0) for a random port.

requestHeaders

HTTP request headers to be added to every browser requests.

responseTimeout

The maximum time to wait for the target host to respond before timing out. Default is 2 minutes.

userAgent

Overwrite the browser user agent.