org.zkoss.zsoup

Interface Connection.Base<T extends Connection.Base>

Type Parameters:

T - Type of Base, either Request or Response

All Known Subinterfaces:

Connection.Request, Connection.Response

All Known Implementing Classes:

HttpConnection.Request, HttpConnection.Response

Enclosing interface:

Connection

public static interface Connection.Base<T extends Connection.Base>

Common methods for Requests and Responses

Method Summary

Modifier and Type	Method and Description
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
boolean	hasCookie(String name) Check if a cookie is present
boolean	hasHeader(String name) Check if a header is present
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 headers as a map
Connection.Method	method() Get the request method
T	method(Connection.Method method) Set the request method
T	removeCookie(String name) Remove a cookie by name
T	removeHeader(String name) Remove a header by name
URL	url() Get the URL
T	url(URL url) Set the URL

Method Detail

url

URL url()

Get the URL

Returns:

URL

url

T url(URL url)

Set the URL

Parameters:

url - new URL

Returns:

this, for chaining

method

Connection.Method method()

Get the request method

Returns:

method

method

T method(Connection.Method method)

Set the request method

Parameters:

method - new method

Returns:

this, for chaining

header

String header(String name)

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.

Parameters:

name - name of header (case insensitive)

Returns:

value of header, or null if not set.

See Also:

hasHeader(String), cookie(String)

header

T header(String name,
         String value)

Set a header. This method will overwrite any existing header with the same case insensitive name.

Parameters:

name - Name of header

value - Value of header

Returns:

this, for chaining

hasHeader

boolean hasHeader(String name)

Check if a header is present

Parameters:

name - name of header (case insensitive)

Returns:

if the header is present in this request/response

removeHeader

T removeHeader(String name)

Remove a header by name

Parameters:

name - name of header to remove (case insensitive)

Returns:

this, for chaining

headers

Map<String,String> headers()

Retrieve all of the request/response headers as a map

Returns:

headers

cookie

String cookie(String name)

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.

Parameters:

name - name of cookie to retrieve.

Returns:

value of cookie, or null if not set

cookie

T cookie(String name,
         String value)

Set a cookie in this request/response.

Parameters:

name - name of cookie

value - value of cookie

Returns:

this, for chaining

hasCookie

boolean hasCookie(String name)

Check if a cookie is present

Parameters:

name - name of cookie

Returns:

if the cookie is present in this request/response

removeCookie

T removeCookie(String name)

Remove a cookie by name

Parameters:

name - name of cookie to remove

Returns:

this, for chaining

cookies

Map<String,String> cookies()

Retrieve all of the request/response cookies as a map

Returns:

cookies