Package org.jsoup.helper

Class HttpConnection.Base<T extends Connection.Base<T>>

java.lang.Object

org.jsoup.helper.HttpConnection.Base<T>

All Implemented Interfaces:

Connection.Base<T>

Direct Known Subclasses:

HttpConnection.Request, HttpConnection.Response

Enclosing class:

HttpConnection

private abstract static class HttpConnection.Base<T extends Connection.Base<T>>
extends Object
implements Connection.Base<T>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Map<String,String>	cookies
(package private) Map<String,List<String>>	headers
(package private) Connection.Method	method
private static final URL	UnsetUrl
(package private) URL	url

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Base()
private	Base(HttpConnection.Base<T> copy)

Method Summary

Modifier and Type	Method	Description
T	addHeader(String name, String value)	Add a header.
String	cookie(String name)	Get a cookie value by name from this request/response.
T	cookie(String name, String value)	Set a cookie in this request/response.
Map<String,String>	cookies()	Retrieve all of the request/response cookies as a map
private List<String>	getHeadersCaseInsensitive(String name)
boolean	hasCookie(String name)	Check if a cookie is present
boolean	hasHeader(String name)	Check if a header is present
boolean	hasHeaderWithValue(String name, String value)	Test if the request has a header with this value (case insensitive).
String	header(String name)	Get the value of a header.
T	header(String name, String value)	Set a header.
Map<String,String>	headers()	Retrieve all of the request/response header names and corresponding values as a map.
List<String>	headers(String name)	Get the values of a header.
Connection.Method	method()	Get the request method, which defaults to GET
T	method(Connection.Method method)	Set the request method
Map<String,List<String>>	multiHeaders()	Retreive all of the headers, keyed by the header name, and with a list of values per header.
T	removeCookie(String name)	Remove a cookie by name
T	removeHeader(String name)	Remove headers by name.
private Map.Entry<String,List<String>>	scanHeaders(String name)
URL	url()	Get the URL of this Request or Response.
T	url(URL url)	Set the URL

Methods inherited from class java.lang.Object

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

Field Details

UnsetUrl

private static final URL UnsetUrl

url

URL url

method

Connection.Method method

headers

Map<String,List<String>> headers

cookies

Map<String,String> cookies

Constructor Details

Base

private Base()

Base

private Base(HttpConnection.Base<T> copy)

Method Details

url

public URL url()

Description copied from interface: Connection.Base

Get the URL of this Request or Response. For redirected responses, this will be the final destination URL.

Specified by:

url in interface Connection.Base<T extends Connection.Base<T>>

Returns:

URL

url

public T url(URL url)

Description copied from interface: Connection.Base

Set the URL

Specified by:

url in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

url - new URL

Returns:

this, for chaining

method

public Connection.Method method()

Description copied from interface: Connection.Base

Get the request method, which defaults to GET

Specified by:

method in interface Connection.Base<T extends Connection.Base<T>>

Returns:

method

method

public T method(Connection.Method method)

Description copied from interface: Connection.Base

Set the request method

Specified by:

method in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

method - new method

Returns:

this, for chaining

header

public String header(String name)

Description copied from interface: Connection.Base

Get the value of a header. If there is more than one header value with the same name, the headers are returned comma separated, per rfc2616-sec4.

Header names are case-insensitive.

Specified by:

header in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - name of header (case-insensitive)

Returns:

value of header, or null if not set.

See Also:

• Connection.Base.hasHeader(String)
• Connection.Base.cookie(String)

addHeader

public T addHeader(String name,
 String value)

Description copied from interface: Connection.Base

Add a header. The header will be added regardless of whether a header with the same name already exists.

For compatibility, if the content of the header includes text that cannot be represented by ISO-8859-1, then it should be encoded first per RFC 2047.

Specified by:

addHeader in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - Name of new header

value - Value of new header

Returns:

this, for chaining

headers

public List<String> headers(String name)

Description copied from interface: Connection.Base

Get the values of a header.

Specified by:

headers in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - header name, case-insensitive.

Returns:

a list of values for this header, or an empty list if not set.

header

public T header(String name,
 String value)

Description copied from interface: Connection.Base

Set a header. This method will overwrite any existing header with the same case-insensitive name. If there is more than one value for this header, this method will update the first matching header.

For compatibility, if the content of the header includes text that cannot be represented by ISO-8859-1, then it should be encoded first per RFC 2047.

Specified by:

header in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - Name of header

value - Value of header

Returns:

this, for chaining

See Also:

• Connection.Base.addHeader(String, String)

hasHeader

public boolean hasHeader(String name)

Description copied from interface: Connection.Base

Check if a header is present

Specified by:

hasHeader in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - name of header (case-insensitive)

Returns:

if the header is present in this request/response

hasHeaderWithValue

public boolean hasHeaderWithValue(String name,
 String value)

Test if the request has a header with this value (case insensitive).

Specified by:

hasHeaderWithValue in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - header name (case-insensitive)

value - value (case-insensitive)

Returns:

if the header and value pair are set in this req/res

removeHeader

public T removeHeader(String name)

Description copied from interface: Connection.Base

Remove headers by name. If there is more than one header with this name, they will all be removed.

Specified by:

removeHeader in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - name of header to remove (case-insensitive)

Returns:

this, for chaining

headers

public Map<String,String> headers()

Description copied from interface: Connection.Base

Retrieve all of the request/response header names and corresponding values as a map. For headers with multiple values, only the first header is returned.

Note that this is a view of the headers only, and changes made to this map will not be reflected in the request/response object.

Specified by:

headers in interface Connection.Base<T extends Connection.Base<T>>

Returns:

headers

See Also:

• Connection.Base.multiHeaders()

multiHeaders

public Map<String,List<String>> multiHeaders()

Description copied from interface: Connection.Base

Retreive all of the headers, keyed by the header name, and with a list of values per header.

Specified by:

multiHeaders in interface Connection.Base<T extends Connection.Base<T>>

Returns:

a list of multiple values per header.

getHeadersCaseInsensitive

private List<String> getHeadersCaseInsensitive(String name)

scanHeaders

private Map.Entry<String,List<String>> scanHeaders(String name)

cookie

public String cookie(String name)

Description copied from interface: Connection.Base

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.

Specified by:

cookie in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - name of cookie to retrieve.

Returns:

value of cookie, or null if not set

cookie

public T cookie(String name,
 String value)

Description copied from interface: Connection.Base

Set a cookie in this request/response.

Specified by:

cookie in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - name of cookie

value - value of cookie

Returns:

this, for chaining

hasCookie

public boolean hasCookie(String name)

Description copied from interface: Connection.Base

Check if a cookie is present

Specified by:

hasCookie in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - name of cookie

Returns:

if the cookie is present in this request/response

removeCookie

public T removeCookie(String name)

Description copied from interface: Connection.Base

Remove a cookie by name

Specified by:

removeCookie in interface Connection.Base<T extends Connection.Base<T>>

Parameters:

name - name of cookie to remove

Returns:

this, for chaining

cookies

public Map<String,String> cookies()

Description copied from interface: Connection.Base

Retrieve all of the request/response cookies as a map

Specified by:

cookies in interface Connection.Base<T extends Connection.Base<T>>

Returns:

cookies