UserAgent

java.lang.Object
- com.jaunt.UserAgent

```
public class UserAgent
extends Object
```
Represents a lightweight, headless browser for XML, XHTML and XML documents. When the UserAgent loads an HTML or XML page, it represents it as a Document object. The Document object exposes the content through a tree-like document object model (DOM). The DOM consists of Nodes, such as Element objects, Text objects, and Comment objects. HTML documents, for example, begin with the <html> Element, whose child nodes are <head> and <body> Elements. Each Element contains zero or more attributes (such as <body id='main') and zero or more children. The children can be Text objects, Comment objects, or other Element Objects.

Since:

0.9.0

Author:

Tom Cervenka (tom.cervenka@gmail.com)

Field Summary

Fields
Modifier and Type	Field and Description
`Cookies`	`cookies` A container for Cookies.
`Document`	`doc` The Document created as a result of the most recent request, where response type was HTML or XML.
`JNode`	`json` The JSON object created as a result of the most recent request, where response type was JSON.
`HttpResponse`	`response` The Response object generated by the most recent HTTP request.
`UserAgentSettings`	`settings` The UserAgent's settings.

Constructor Summary

Constructors
Constructor and Description

UserAgent()
Creates a UserAgent; throws runtime exception (ExpirationException) if software has expired.

Constructors
Constructor and Description
`UserAgent()` Creates a UserAgent; throws runtime exception (ExpirationException) if software has expired.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`UserAgent`	`addBasicAuthenticator(String realmName, String userId, String password)` Adds a BasicAuthenticator to the collection of BasicAuthenticators.
`UserAgent`	`addBasicAuthenticator(String realmName, String protectedDir, String userId, String password)` Adds a BasicAuthenticator to the collection of BasicAuthenticators.
`boolean`	`cachingEnabled()` Indicates whether document caching is enabled.
`void`	`close()` Performs cleanup such as saving cookies to disk.
`UserAgent`	`copy()` returns a new UserAgent who's state information for certain fields is (deep) copied from this UserAgent; those fields are UserAgent.settings, UserAgent.cookies, as well as the location url (referer), the proxy host, and proxy port.
`HttpResponse`	`download(String url, File downloadFile)` Downloads and saves the content at the specified url as the specified File, overwriting the file if it already exists; this method does not invoke the parser, and therefore UserAgent.doc is set to an empty Document; UserAgent.response is created to represent the HttpResponse.
`Cache`	`getCache()` Returns the current cache or null if no cache is set.
`Handler`	`getHandler(String contentType)` Returns the content handler that was set for the specified (case-insensitive) contentType, or null if no Handler was set.
`MultiMap<String,String>`	`getHeaders(String key)` Returns a MultiMap containing the headers received for the most recent request, where each header name is associated with one or more header values.
`String`	`getLocation()` Retrieves the current location (url).
`String`	`getProxyHost()` Retrieves the ip address of the http proxy or null if no proxy is being used.
`int`	`getProxyPort()` Retrieves the port number of the current http proxy being used or -1 if the proxy host is unset.
`String`	`getReferer()` Retrieves the referer value (ie, the url of the last document visited, which is sent in the header of the next HTTP request).
`String`	`getSource()` Returns the original unparsed source of the last request, or an empty String if there is no source from a previous request.
`static String`	`getVersionInfo()` returns the version number, edition, and expiration date of this Jaunt release.
`Document`	`open(File file)` Parses the HTML/XHTML/XML within the specified File, and creates UserAgent.doc to represent the Document (which is also returned by this method).
`Document`	`open(File file, String documentUrl)` Parses the HTML/XHTML/XML within the specified File, and creates UserAgent.doc to represent the Document (which is also returned by this method).
`Document`	`openContent(String content)` Parses the source HTML, XHTML, or XML and creates UserAgent.doc to represent the Document (which is also returned by this method).
`Document`	`openContent(String content, String documentUrl)` Parses the source HTML, XHTML, or XML and creates UserAgent.doc to represent the Document (which is also returned by this method).
`JNode`	`openJSON(File file)` Parses the JSON within the specified File, and creates UserAgent.json to represent the root node of the JSON object (which is also returned by this method).
`JNode`	`openJSON(String json)` Parses the specified JSON and creates UserAgent.json to represent the root node of the JSON object (which is also returned by this method).
`int`	`removeBasicAuthenticators(String realmName)` Removes any basic authenticators associated with the specified realmName.
`FilterCallback`	`removeFilter()` Deprecated.
`Document`	`send(HttpRequest httpRequest)` Sends the specified HttpRequest (GET, POST, HEAD, DELETE, or PUT)
`Document`	`sendDELETE(String url)` Sends an HTTP DELETE request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`Document`	`sendDELETE(String url, String... additionalHeaders)` Sends an HTTP DELETE request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`Document`	`sendGET(String url)` Sends an HTTP GET request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`Document`	`sendGET(String url, String... additionalHeaders)` Sends an HTTP GET request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`HttpResponse`	`sendHEAD(String url)` Sends an HTTP HEAD request to the specified url; UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information), and is also the return value.
`HttpResponse`	`sendHEAD(String url, String... additionalHeaders)` Sends an HTTP HEAD request to the specified url; UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information), and is also the return value.
`Document`	`sendPOST(String url, String postData)` Sends an HTTP POST request for the specified url and queryString; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`Document`	`sendPOST(String url, String postData, String... additionalHeaders)` Sends an HTTP POST request for the specified url and queryString; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`Document`	`sendPUT(String url, String content)` Sends an HTTP PUT request for the specified url and content; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`Document`	`sendPUT(String url, String content, String... additionalHeaders)` Sends an HTTP PUT request for the specified url and content; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`UserAgent`	`setCache(Cache cache)` Sets the specified cache; the cache must be enabled before being used.
`UserAgent`	`setCacheEnabled(boolean enable)` Turns on/off caching, which causes HTML/XHTML source retrieved by HTTP GET request to be stored in the cache and pulled from that cache for any subsequent GET requests to the same url, as long as caching is enabled; by default, caching is handled by the FileSystemCache, which stores files in a directory called "jaunt_cache", which is in the directory specified by UserAgentSettings.outputPath.
`UserAgent`	`setFilter(FilterCallback filter)` Deprecated.
`UserAgent`	`setHandler(String contentType, Handler handler)` Sets the content handler for the specified contentType; the Handler receives callbacks to process the content rather than having it handled by the parser.
`UserAgent`	`setProxyHost(String proxyHost)` Sets or clears the ip address of the http proxy.
`UserAgent`	`setProxyPort(int proxyPort)` Sets the port number of the http proxy to be used.
`UserAgent`	`setReferer(String referer)` Sets the value of the referer header in the next HTTP request.
`Document`	`visit(String url)` Directs the UserAgent to visit the specified url (ie, sends an HTTP GET request); UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
`Document`	`visit(String url, int redirectCount)` Directs the UserAgent to visit the specified url (ie, to send an HTTP GET request); UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).

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

- Field Detail
  - response
```
public HttpResponse response
```
    The Response object generated by the most recent HTTP request.
  - settings
```
public UserAgentSettings settings
```
    The UserAgent's settings.
  - doc
```
public Document doc
```
    The Document created as a result of the most recent request, where response type was HTML or XML.
  - json
```
public JNode json
```
    The JSON object created as a result of the most recent request, where response type was JSON.
  - cookies
```
public Cookies cookies
```
    A container for Cookies.
- Constructor Detail
  - UserAgent
```
public UserAgent()
          throws ExpirationException
```
    Creates a UserAgent; throws runtime exception (ExpirationException) if software has expired.
    
    Throws:
    
    ExpirationException
- Method Detail
  - copy
```
public UserAgent copy()
```
    returns a new UserAgent who's state information for certain fields is (deep) copied from this UserAgent; those fields are UserAgent.settings, UserAgent.cookies, as well as the location url (referer), the proxy host, and proxy port.
  - getHeaders
```
public MultiMap<String,String> getHeaders(String key)
```
    Returns a MultiMap containing the headers received for the most recent request, where each header name is associated with one or more header values.
  - setFilter
```
@Deprecated
public UserAgent setFilter(FilterCallback filter)
```
    Deprecated.
    
    Sets the specified filter.
    
    Returns:
    
    a reference to this UserAgent.
  - removeFilter
```
@Deprecated
public FilterCallback removeFilter()
```
    Deprecated.
    
    Removes (and returns) the current filter and replaces it with the default Filter, which allows all content to pass through.
  - setCache
```
public UserAgent setCache(Cache cache)
```
    Sets the specified cache; the cache must be enabled before being used.
    
    Parameters:
    
    cache - the cache to be used for storing XHTML/HTML source, or null to set no cache.
    
    Returns:
    
    a referece to this UserAgent.
    
    See Also:
    
    setCacheEnabled(boolean)
  - getCache
```
public Cache getCache()
```
    Returns the current cache or null if no cache is set.
  - setCacheEnabled
```
public UserAgent setCacheEnabled(boolean enable)
                          throws CacheException
```
    Turns on/off caching, which causes HTML/XHTML source retrieved by HTTP GET request to be stored in the cache and pulled from that cache for any subsequent GET requests to the same url, as long as caching is enabled; by default, caching is handled by the FileSystemCache, which stores files in a directory called "jaunt_cache", which is in the directory specified by UserAgentSettings.outputPath.
    
    Returns:
    
    a referece to this UserAgent.
    
    Throws:
    
    CacheException
  - cachingEnabled
```
public boolean cachingEnabled()
```
    Indicates whether document caching is enabled.
  - setHandler
```
public UserAgent setHandler(String contentType,
                            Handler handler)
```
    Sets the content handler for the specified contentType; the Handler receives callbacks to process the content rather than having it handled by the parser.
    
    Parameters:
    
    contentType - the (case-insensitive) content-type for the specified Handler (eg "text/css", "text/javascript", "image/png", etc), as designated in the HTTP response header.
    
    handler - an object that implements the Handler interface for handling the response content.
    
    Returns:
    
    a reference to this UserAgent.
  - getHandler
```
public Handler getHandler(String contentType)
```
    Returns the content handler that was set for the specified (case-insensitive) contentType, or null if no Handler was set.
  - setProxyHost
```
public UserAgent setProxyHost(String proxyHost)
```
    Sets or clears the ip address of the http proxy.
    
    Parameters:
    
    proxyHost - proxy ip address to be used, or null to remove proxy
    
    Returns:
    
    a reference to this UserAgent.
    
    See Also:
    
    setProxyPort(int)
  - getProxyHost
```
public String getProxyHost()
```
    Retrieves the ip address of the http proxy or null if no proxy is being used.
  - setProxyPort
```
public UserAgent setProxyPort(int proxyPort)
```
    Sets the port number of the http proxy to be used.
    
    Parameters:
    
    proxyPort - proxy port number.
    
    Returns:
    
    a referece to this UserAgent.
    
    See Also:
    
    setProxyHost(String)
  - getProxyPort
```
public int getProxyPort()
```
    Retrieves the port number of the current http proxy being used or -1 if the proxy host is unset.
    
    Returns:
    
    proxy port number
  - addBasicAuthenticator
```
public UserAgent addBasicAuthenticator(String realmName,
                                       String userId,
                                       String password)
```
    Adds a BasicAuthenticator to the collection of BasicAuthenticators. When an authenticator is added, it must specify a realm but may or may not specify the protected directory. Every time a request is sent, the UserAgent searches for authenticators that match the (protected directory) of the request. If found, the authenticator is used to send a pre-emptive authentication header. If no pre-emptive authentication header is sent, the server will ask for one with the www-authenticate header, which the userAgent looks for in all replies from the server. if the header is detected, the UserAgent finds the authenticator with the matching realm, update's that authenticator's protected-directory setting, and re-sends the request with the authenticator's username & password, ie with header Authentication: Basic <username:password^gt;, where <> denotes base64 encoding. The next time a request is sent to the domain, the authorization should be pre-emtive since the protected-directory is now set in the authenticator.
    
    Parameters:
    
    realmName - the string that will be shown when the browser pops up the login window, eg - "Please enter your username and password for [realm name]"
    
    Returns:
    
    a reference to this UserAgent.
  - addBasicAuthenticator
```
public UserAgent addBasicAuthenticator(String realmName,
                                       String protectedDir,
                                       String userId,
                                       String password)
```
    Adds a BasicAuthenticator to the collection of BasicAuthenticators. When an authenticator is added, it must specify a realm but may or may not specify the protected directory. Every time a request is sent, the UserAgent searches for authenticators that match the (protected directory) of the request. If found, the authenticator is used to send a pre-emptive authentication header. If no pre-emptive authentication header is sent, the server will ask for one with the www-authenticate header, which the userAgent looks for in all replies from the server. if the header is detected, the UserAgent finds the authenticator with the matching realm, update's that authenticator's protected-directory setting, and re-sends the request with the authenticator's username & password, ie with header Authentication: Basic <username:password^gt;, where <> denotes base64 encoding. The next time a request is sent to the domain, the authorization should be pre-emtive since the protected-directory is now set in the authenticator.
    
    Parameters:
    
    protectedDir - is an absolute url to the protected directory.
    
    realmName - the string that will be shown when the browser pops up the login window, eg - "Please enter your username and password for [realm name]"
    
    Returns:
    
    a referece to this UserAgent.
  - removeBasicAuthenticators
```
public int removeBasicAuthenticators(String realmName)
```
    Removes any basic authenticators associated with the specified realmName.
    
    Returns:
    
    the number of basic authenticators that were removed.
  - setReferer
```
public UserAgent setReferer(String referer)
```
    Sets the value of the referer header in the next HTTP request.
    
    Returns:
    
    a reference to this UserAgent.
  - getReferer
```
public String getReferer()
```
    Retrieves the referer value (ie, the url of the last document visited, which is sent in the header of the next HTTP request).
  - getLocation
```
public String getLocation()
```
    Retrieves the current location (url).
  - getSource
```
public String getSource()
```
    Returns the original unparsed source of the last request, or an empty String if there is no source from a previous request.
  - open
```
public Document open(File file)
              throws IOException,
                     ResponseException
```
    Parses the HTML/XHTML/XML within the specified File, and creates UserAgent.doc to represent the Document (which is also returned by this method).
    
    Returns:
    
    a reference to the Document.
    
    Throws:
    
    ResponseException - may occur if the document contains a meta tag that redirects to a url that results in the ResponseException.
    
    IOException
  - open
```
public Document open(File file,
                     String documentUrl)
              throws IOException,
                     ResponseException
```
    Parses the HTML/XHTML/XML within the specified File, and creates UserAgent.doc to represent the Document (which is also returned by this method).
    
    Parameters:
    
    documentUrl - the url of the content in the specified file, used to convert relative/implicit urls in the document to absolute urls; if null, relative urls are not converted.
    
    Returns:
    
    a reference to the Document.
    
    Throws:
    
    ResponseException - may occur if the document contains a meta tag that redirects to a url that results in the ResponseException.
    
    IOException
  - openContent
```
public Document openContent(String content)
                     throws ResponseException
```
    Parses the source HTML, XHTML, or XML and creates UserAgent.doc to represent the Document (which is also returned by this method). A ResponseException can be thrown if the document autoredirects to a url.
    
    Parameters:
    
    content - the HTML, XHTML, or XML content.
    
    Returns:
    
    a Document.
    
    Throws:
    
    ResponseException
    
    See Also:
    
    parse(String)
  - openJSON
```
public JNode openJSON(File file)
               throws IOException
```
    Parses the JSON within the specified File, and creates UserAgent.json to represent the root node of the JSON object (which is also returned by this method).
    
    Returns:
    
    a reference to the root node of the JSON object.
    
    Throws:
    
    IOException
  - openJSON
```
public JNode openJSON(String json)
```
    Parses the specified JSON and creates UserAgent.json to represent the root node of the JSON object (which is also returned by this method). A ResponseException can be thrown if the document autoredirects to a url.
    
    Parameters:
    
    json - JSON content.
    
    Returns:
    
    a referece to the root node of the JSON object.
  - openContent
```
public Document openContent(String content,
                            String documentUrl)
                     throws ResponseException
```
    Parses the source HTML, XHTML, or XML and creates UserAgent.doc to represent the Document (which is also returned by this method). A ResponseException can be thrown if the document autoredirects to a url.
    
    Parameters:
    
    content - the HTML, XHTML, or XML content.
    
    documentUrl - the url of the specified content, used to convert relative/implicit urls in the document to absolute urls; if null, relative urls are not converted.
    
    Returns:
    
    a Document.
    
    Throws:
    
    ResponseException
    
    See Also:
    
    parse(String)
  - send
```
public Document send(HttpRequest httpRequest)
              throws ResponseException
```
    Sends the specified HttpRequest (GET, POST, HEAD, DELETE, or PUT)
    
    Returns:
    
    a Document or null if the response was successful but there was no content body (eg, HEAD request or 204 response).
    
    Throws:
    
    ResponseException
  - visit
```
public Document visit(String url)
               throws ResponseException
```
    Directs the UserAgent to visit the specified url (ie, sends an HTTP GET request); UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - visit
```
public Document visit(String url,
                      int redirectCount)
               throws ResponseException
```
    Directs the UserAgent to visit the specified url (ie, to send an HTTP GET request); UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Parameters:
    
    redirectCount - the number of consecutive redirections that occurred immediately before this request.
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - sendGET
```
public Document sendGET(String url)
                 throws ResponseException
```
    Sends an HTTP GET request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
    
    See Also:
    
    visit(String)
  - sendGET
```
public Document sendGET(String url,
                        String... additionalHeaders)
                 throws ResponseException
```
    Sends an HTTP GET request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Parameters:
    
    additionalHeaders - each String must contain a header name followed by a colon followed by the header value (these headers are added-to or override the auto-managed headers [eg cookies, referer, etc] as well as the headers specified in UserAgent.settings.defaultRequestHeaders); can be null
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
    
    See Also:
    
    visit(String)
  - download
```
public HttpResponse download(String url,
                             File downloadFile)
                      throws ResponseException
```
    Downloads and saves the content at the specified url as the specified File, overwriting the file if it already exists; this method does not invoke the parser, and therefore UserAgent.doc is set to an empty Document; UserAgent.response is created to represent the HttpResponse. Note that this method is not affected by UserAgentSettings.responseTimeout
    
    Parameters:
    
    url - the url (beginning with http, https, or ftp) of the file to download.
    
    Returns:
    
    the HttpResponse object, or returns null in the case of a request to an ftp url.
    
    Throws:
    
    ResponseException
  - sendDELETE
```
public Document sendDELETE(String url)
                    throws ResponseException
```
    Sends an HTTP DELETE request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - sendDELETE
```
public Document sendDELETE(String url,
                           String... additionalHeaders)
                    throws ResponseException
```
    Sends an HTTP DELETE request for the specified url; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Parameters:
    
    additionalHeaders - each String must contain a header name followed by a colon followed by the header value (these headers are added-to or override the auto-managed headers [eg cookies, referer, etc] as well as the headers specified in UserAgent.settings.defaultRequestHeaders); can be null
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - sendPUT
```
public Document sendPUT(String url,
                        String content)
                 throws ResponseException
```
    Sends an HTTP PUT request for the specified url and content; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information). Note that this method is not affected by UserAgentSettings.responseTimeout.
    
    Parameters:
    
    content - the body of the PUT content.
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - sendPUT
```
public Document sendPUT(String url,
                        String content,
                        String... additionalHeaders)
                 throws ResponseException
```
    Sends an HTTP PUT request for the specified url and content; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information). Note that this method is not affected by UserAgentSettings.responseTimeout.
    
    Parameters:
    
    additionalHeaders - each String must contain a header name followed by a colon followed by the header value (these headers are added-to or override the auto-managed headers [eg cookies, referer, etc] as well as the headers specified in UserAgent.settings.defaultRequestHeaders); can be null
    
    content - the body of the PUT content.
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - sendHEAD
```
public HttpResponse sendHEAD(String url,
                             String... additionalHeaders)
                      throws ResponseException
```
    Sends an HTTP HEAD request to the specified url; UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information), and is also the return value. Note that this method is not affected by UserAgentSettings.responseTimeout.
    
    Parameters:
    
    additionalHeaders - each String must contain a header name followed by a colon followed by the header value (these headers are added-to or override the auto-managed headers [eg cookies, referer, etc] as well as the headers specified in UserAgent.settings.defaultRequestHeaders); can be null
    
    Throws:
    
    ResponseException
  - sendHEAD
```
public HttpResponse sendHEAD(String url)
                      throws ResponseException
```
    Sends an HTTP HEAD request to the specified url; UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information), and is also the return value. Note that this method is not affected by UserAgentSettings.responseTimeout.
    
    Throws:
    
    ResponseException
  - close
```
public void close()
           throws IOException
```
    Performs cleanup such as saving cookies to disk.
    
    Throws:
    
    IOException
  - sendPOST
```
public Document sendPOST(String url,
                         String postData)
                  throws ResponseException
```
    Sends an HTTP POST request for the specified url and queryString; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Parameters:
    
    postData - the posted data, which may be url-encoded queryString data (eg "foo=bar&msg=hi%20there") or some other data payload (or null for no data).
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - sendPOST
```
public Document sendPOST(String url,
                         String postData,
                         String... additionalHeaders)
                  throws ResponseException
```
    Sends an HTTP POST request for the specified url and queryString; UserAgent.doc is created to represent the retrieved HTML/XML/XHTML Document (which is also returned by this method); UserAgent.response is created to represent the HttpResponse (the response headers and other response-related information).
    
    Parameters:
    
    postData - the posted data, which may be url-encoded queryString data (eg "foo=bar&msg=hi%20there") or some other data payload (or null for no data).
    
    additionalHeaders - each String must contain a header name followed by a colon followed by the header value (these headers are added-to or override the auto-managed headers [eg cookies, referer, etc] as well as the headers specified in UserAgent.settings.defaultRequestHeaders); can be null
    
    Returns:
    
    a Document object representing the retrieved HTML/XML/XHTML content.
    
    Throws:
    
    ResponseException
  - getVersionInfo
```
public static String getVersionInfo()
```
    returns the version number, edition, and expiration date of this Jaunt release.

Class UserAgent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

response

settings

doc

json

cookies

Constructor Detail

UserAgent

Method Detail

copy

getHeaders

setFilter

removeFilter

setCache

getCache

setCacheEnabled

cachingEnabled

setHandler

getHandler

setProxyHost

getProxyHost

setProxyPort

getProxyPort

addBasicAuthenticator

addBasicAuthenticator

removeBasicAuthenticators

setReferer

getReferer

getLocation

getSource

open

open

openContent

openJSON

openJSON

openContent

send

visit

visit

sendGET

sendGET

download

sendDELETE

sendDELETE

sendPUT

sendPUT

sendHEAD

sendHEAD

close

sendPOST

sendPOST

getVersionInfo