HttpBrowser (Jodd API Documentation)

java.lang.Object
- jodd.http.HttpBrowser

```
public class HttpBrowser
extends java.lang.Object
```
Emulates HTTP Browser and persist cookies between requests.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`catchTransportExceptions`
`protected HttpMultiMap<Cookie>`	`cookies`
`protected HeadersMultiMap`	`defaultHeaders`
`protected long`	`elapsedTime`
`protected HttpConnectionProvider`	`httpConnectionProvider`
`protected HttpRequest`	`httpRequest`
`protected HttpResponse`	`httpResponse`
`protected boolean`	`keepAlive`

Constructor Summary

Constructors
Constructor and Description

HttpBrowser()

Constructors
Constructor and Description
`HttpBrowser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected HttpResponse`	`_sendRequest(HttpRequest httpRequest, HttpResponse previouseResponse)` Opens connection and sends a response.
`protected void`	`addCookies(HttpRequest httpRequest)` Add cookies to the request.
`protected void`	`addDefaultHeaders(HttpRequest httpRequest)` Add default headers to the request.
`void`	`clearCookies()` Deletes all cookies.
`void`	`close()` Closes browser explicitly, needed when keep-alive connection is used.
`long`	`getElapsedTime()` Returns elapsed time of last `sendRequest(HttpRequest)` in milliseconds.
`HttpRequest`	`getHttpRequest()` Returns last used request.
`HttpResponse`	`getHttpResponse()` Returns last received `HTTP response` object.
`java.lang.String`	`getPage()` Returns last response HTML page.
`boolean`	`isKeepAlive()` Returns `true` if keep alive is used.
`protected void`	`readCookies(HttpResponse httpResponse)` Reads cookies from response and adds to cookies list.
`HttpResponse`	`sendRequest(HttpRequest httpRequest)` Sends new request as a browser.
`HttpBrowser`	`setCatchTransportExceptions(boolean catchTransportExceptions)` Defines if transport exceptions should be thrown.
`HttpBrowser`	`setDefaultHeader(java.lang.String name, java.lang.String value)` Adds default header to all requests.
`HttpBrowser`	`setHttpConnectionProvider(HttpConnectionProvider httpConnectionProvider)` Defines `HttpConnectionProvider` for this browser session.
`HttpBrowser`	`setKeepAlive(boolean keepAlive)` Defines that persistent HTTP connection should be used.
`HttpBrowser`	`setProxyInfo(ProxyInfo proxyInfo)` Defines proxy for a browser.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - httpConnectionProvider
```
protected HttpConnectionProvider httpConnectionProvider
```
  - httpRequest
```
protected HttpRequest httpRequest
```
  - httpResponse
```
protected HttpResponse httpResponse
```
  - cookies
```
protected HttpMultiMap<Cookie> cookies
```
  - defaultHeaders
```
protected HeadersMultiMap defaultHeaders
```
  - keepAlive
```
protected boolean keepAlive
```
  - elapsedTime
```
protected long elapsedTime
```
  - catchTransportExceptions
```
protected boolean catchTransportExceptions
```
- Constructor Detail
  - HttpBrowser
```
public HttpBrowser()
```
- Method Detail
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Returns true if keep alive is used.
  - setKeepAlive
```
public HttpBrowser setKeepAlive(boolean keepAlive)
```
    Defines that persistent HTTP connection should be used.
  - setCatchTransportExceptions
```
public HttpBrowser setCatchTransportExceptions(boolean catchTransportExceptions)
```
    Defines if transport exceptions should be thrown.
  - setProxyInfo
```
public HttpBrowser setProxyInfo(ProxyInfo proxyInfo)
```
    Defines proxy for a browser.
  - setHttpConnectionProvider
```
public HttpBrowser setHttpConnectionProvider(HttpConnectionProvider httpConnectionProvider)
```
    Defines HttpConnectionProvider for this browser session. Resets the previous proxy definition, if set.
  - setDefaultHeader
```
public HttpBrowser setDefaultHeader(java.lang.String name,
                                    java.lang.String value)
```
    Adds default header to all requests.
  - getHttpRequest
```
public HttpRequest getHttpRequest()
```
    Returns last used request.
  - getHttpResponse
```
public HttpResponse getHttpResponse()
```
    Returns last received HTTP response object.
  - getPage
```
public java.lang.String getPage()
```
    Returns last response HTML page.
  - sendRequest
```
public HttpResponse sendRequest(HttpRequest httpRequest)
```
    Sends new request as a browser. Before sending, all browser cookies are added to the request. After sending, the cookies are read from the response. Moreover, status codes 301 and 302 are automatically handled. Returns very last response.
  - _sendRequest
```
protected HttpResponse _sendRequest(HttpRequest httpRequest,
                                    HttpResponse previouseResponse)
```
    Opens connection and sends a response.
  - addDefaultHeaders
```
protected void addDefaultHeaders(HttpRequest httpRequest)
```
    Add default headers to the request. If request already has a header set, default header will be ignored.
  - getElapsedTime
```
public long getElapsedTime()
```
    Returns elapsed time of last sendRequest(HttpRequest) in milliseconds.
  - close
```
public void close()
```
    Closes browser explicitly, needed when keep-alive connection is used.
  - clearCookies
```
public void clearCookies()
```
    Deletes all cookies.
  - readCookies
```
protected void readCookies(HttpResponse httpResponse)
```
    Reads cookies from response and adds to cookies list.
  - addCookies
```
protected void addCookies(HttpRequest httpRequest)
```
    Add cookies to the request.

Class HttpBrowser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

httpConnectionProvider

httpRequest

httpResponse

cookies

defaultHeaders

keepAlive

elapsedTime

catchTransportExceptions

Constructor Detail

HttpBrowser

Method Detail

isKeepAlive

setKeepAlive

setCatchTransportExceptions

setProxyInfo

setHttpConnectionProvider

setDefaultHeader

getHttpRequest

getHttpResponse

getPage

sendRequest

_sendRequest

addDefaultHeaders

getElapsedTime

close

clearCookies

readCookies

addCookies