org.jsoup.Connection Maven / Gradle / Ivy
package org.jsoup;
import org.jsoup.nodes.Document;
import java.net.URL;
import java.util.Map;
import java.util.Collection;
import java.io.IOException;
/**
* A Connection provides a convenient interface to fetch content from the web, and parse them into Documents.
*
* To get a new Connection, use {@link org.jsoup.Jsoup#connect(String)}. Connections contain {@link Connection.Request}
* and {@link Connection.Response} objects. The request objects are reusable as prototype requests.
*
* Request configuration can be made using either the shortcut methods in Connection (e.g. {@link #userAgent(String)}),
* or by methods in the Connection.Request object directly. All request configuration must be made before the request
* is executed.
*
* The Connection interface is currently in beta and subject to change. Comments, suggestions, and bug reports are welcome.
*/
public interface Connection {
/**
* GET and POST http methods.
*/
public enum Method {
GET, POST
}
/**
* Set the request URL to fetch. The protocol must be HTTP or HTTPS.
* @param url URL to connect to
* @return this Connection, for chaining
*/
public Connection url(URL url);
/**
* Set the request URL to fetch. The protocol must be HTTP or HTTPS.
* @param url URL to connect to
* @return this Connection, for chaining
*/
public Connection url(String url);
/**
* Set the request user-agent header.
* @param userAgent user-agent to use
* @return this Connection, for chaining
*/
public Connection userAgent(String userAgent);
/**
* Set the request timeouts (connect and read). If a timeout occurs, an IOException will be thrown. The default
* timeout is 3 seconds (3000 millis). A timeout of zero is treated as an infinite timeout.
* @param millis number of milliseconds (thousandths of a second) before timing out connects or reads.
* @return this Connection, for chaining
*/
public Connection timeout(int millis);
/**
* Set the request referrer (aka "referer") header.
* @param referrer referrer to use
* @return this Connection, for chaining
*/
public Connection referrer(String referrer);
/**
* Configures the connection to (not) follow server redirects. By default this is true.
* @param followRedirects true if server redirects should be followed.
* @return this Connection, for chaining
*/
public Connection followRedirects(boolean followRedirects);
/**
* Set the request method to use, GET or POST. Default is GET.
* @param method HTTP request method
* @return this Connection, for chaining
*/
public Connection method(Method method);
/**
* Add a request data parameter. Request parameters are sent in the request query string for GETs, and in the request
* body for POSTs. A request may have multiple values of the same name.
* @param key data key
* @param value data value
* @return this Connection, for chaining
*/
public Connection data(String key, String value);
/**
* Adds all of the supplied data to the request data parameters
* @param data map of data parameters
* @return this Connection, for chaining
*/
public Connection data(Map data);
/**
* Add a number of request data parameters. Multiple parameters may be set at once, e.g.:
* .data("name", "jsoup", "language", "Java", "language", "English"); creates a query string like:
* ?name=jsoup&language=Java&language=English
* @param keyvals a set of key value pairs.
* @return this Connection, for chaining
*/
public Connection data(String... keyvals);
/**
* Set a request header.
* @param name header name
* @param value header value
* @return this Connection, for chaining
* @see org.jsoup.Connection.Request#headers()
*/
public Connection header(String name, String value);
/**
* Set a cookie to be sent in the request
* @param name name of cookie
* @param value value of cookie
* @return this Connection, for chaining
*/
public Connection cookie(String name, String value);
/**
* Execute the request as a GET, and parse the result.
* @return parsed Document
* @throws IOException on error
*/
public Document get() throws IOException;
/**
* Execute the request as a POST, and parse the result.
* @return parsed Document
* @throws IOException on error
*/
public Document post() throws IOException;
/**
* Execute the request.
* @return a response object
* @throws IOException on error
*/
public Response execute() throws IOException;
/**
* Get the request object associatated with this connection
* @return request
*/
public Request request();
/**
* Set the connection's request
* @param request new request object
* @return this Connection, for chaining
*/
public Connection request(Request request);
/**
* Get the response, once the request has been executed
* @return response
*/
public Response response();
/**
* Set the conenction's response
* @param response new response
* @return this Connection, for chaining
*/
public Connection response(Response response);
/**
* Common methods for Requests and Responses
* @param Type of Base, either Request or Response
*/
interface Base {
/**
* Get the URL
* @return URL
*/
public URL url();
/**
* Set the URL
* @param url new URL
* @return this, for chaining
*/
public T url(URL url);
/**
* Get the request method
* @return method
*/
public Method method();
/**
* Set the request method
* @param method new method
* @return this, for chaining
*/
public T method(Method method);
/**
* Get the value of a header. This is a simplified header model, where a header may only have one value.
*
* Header names are case insensitive.
* @param name name of header (case insensitive)
* @return value of header, or null if not set.
* @see #hasHeader(String)
* @see #cookie(String)
*/
public String header(String name);
/**
* Set a header. This method will overwrite any existing header with the same case insensitive name.
* @param name Name of header
* @param value Value of header
* @return this, for chaining
*/
public T header(String name, String value);
/**
* Check if a header is present
* @param name name of header (case insensitive)
* @return if the header is present in this request/response
*/
public boolean hasHeader(String name);
/**
* Remove a header by name
* @param name name of header to remove (case insensitive)
* @return this, for chianing
*/
public T removeHeader(String name);
/**
* Retrieve all of the request/response headers as a map
* @return headers
*/
public Map headers();
/**
* Get a cookie value by name from this request/response.
*
* Response objects have a simplified cookie model. Each cookie set in the response is added to the response
* object's cookie key=value map. The cookie's path, domain, and expiry date are ignored.
* @param name name of cookie to retrieve.
* @return value of cookie, or null if not set
*/
public String cookie(String name);
/**
* Set a cookie in this request/response.
* @param name name of cookie
* @param value value of cookie
* @return this, for chianing
*/
public T cookie(String name, String value);
/**
* Check if a cookie is present
* @param name name of cookie
* @return if the cookie is present in this request/response
*/
public boolean hasCookie(String name);
/**
* Remove a cookie by name
* @param name name of cookie to remove
* @return this, for chianing
*/
public T removeCookie(String name);
/**
* Retrieve all of the request/response cookies as a map
* @return cookies
*/
public Map cookies();
}
/**
* Represents a HTTP request.
*/
public interface Request extends Base {
/**
* Get the request timeout, in milliseconds.
* @return the timeout in milliseconds.
*/
public int timeout();
/**
* Update the request timeout.
* @param millis timeout, in milliseconds
* @return this Request, for chaining
*/
public Request timeout(int millis);
/**
* Get the current followRedirects configuration.
* @return true if followRedirects is enabled.
*/
public boolean followRedirects();
/**
* Configures the request to (not) follow server redirects. By default this is true.
*
* @param followRedirects true if server redirects should be followed.
* @return this Connection, for chaining
*/
public Request followRedirects(boolean followRedirects);
/**
* Add a data parameter to the request
* @param keyval data to add.
* @return this Request, for chaining
*/
public Request data(KeyVal keyval);
/**
* Get all of the request's data parameters
* @return collection of keyvals
*/
public Collection data();
}
/**
* Represents a HTTP response.
*/
public interface Response extends Base {
/**
* Get the status code of the response.
* @return status code
*/
public int statusCode();
/**
* Get the status message of the response.
* @return status message
*/
public String statusMessage();
/**
* Get the character set name of the response.
* @return character set name
*/
public String charset();
/**
* Get the response content type (e.g. "text/html");
* @return the response content type
*/
public String contentType();
/**
* Parse the body of the response as a Document.
* @return a parsed Document
* @throws IOException on error
*/
public Document parse() throws IOException;
/**
* Get the body of the response as a plain string.
* @return body
*/
public String body();
/**
* Get the body of the response as an array of bytes.
* @return body bytes
*/
public byte[] bodyAsBytes();
}
/**
* A Key Value tuple.
*/
public interface KeyVal {
/**
* Update the key of a keyval
* @param key new key
* @return this KeyVal, for chaining
*/
public KeyVal key(String key);
/**
* Get the key of a keyval
* @return the key
*/
public String key();
/**
* Update the value of a keyval
* @param value the new value
* @return this KeyVal, for chaining
*/
public KeyVal value(String value);
/**
* Get the value of a keyval
* @return the value
*/
public String value();
}
}