com.nbsaas.http

接口 Connection

所有已知实现类:

HttpConnection

public interface Connection

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	Connection.Base<T extends Connection.Base> Common methods for Requests and Responses
static interface	Connection.KeyVal A Key Value tuple.
static class	Connection.Method GET and POST http methods.
static interface	Connection.Request Represents a HTTP request.
static interface	Connection.Response Represents a HTTP response.

方法概要

限定符和类型	方法和说明
Connection	cookie(String name, String value) Set a cookie to be sent in the request
Connection	data(Map<String,String> data) Adds all of the supplied data to the request data parameters
Connection	data(String... keyvals) Add a number of request data parameters.
Connection	data(String key, String value) Add a request data parameter.
Connection.Response	execute() Execute the request.
Connection	followRedirects(boolean followRedirects) Configures the connection to (not) follow server redirects.
Connection	header(String name, String value) Set a request header.
Connection	method(Connection.Method method) Set the request method to use, GET or POST.
Connection	referrer(String referrer) Set the request referrer (aka "referer") header.
Connection.Request	request() Get the request object associatated with this connection
Connection	request(Connection.Request request) Set the connection's request
Connection.Response	response() Get the response, once the request has been executed
Connection	response(Connection.Response response) Set the conenction's response
Connection	timeout(int millis) Set the request timeouts (connect and read).
Connection	url(String url) Set the request URL to fetch.
Connection	url(URL url) Set the request URL to fetch.
Connection	userAgent(String userAgent) Set the request user-agent header.

方法详细资料

url

Connection url(URL url)

Set the request URL to fetch. The protocol must be HTTP or HTTPS.

参数:

url - URL to connect to

返回:

this Connection, for chaining

url

Connection url(String url)

Set the request URL to fetch. The protocol must be HTTP or HTTPS.

参数:

url - URL to connect to

返回:

this Connection, for chaining

userAgent

Connection userAgent(String userAgent)

Set the request user-agent header.

参数:

userAgent - user-agent to use

返回:

this Connection, for chaining

timeout

Connection timeout(int millis)

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.

参数:

millis - number of milliseconds (thousandths of a second) before timing out connects or reads.

返回:

this Connection, for chaining

referrer

Connection referrer(String referrer)

Set the request referrer (aka "referer") header.

参数:

referrer - referrer to use

返回:

this Connection, for chaining

followRedirects

Connection followRedirects(boolean followRedirects)

Configures the connection to (not) follow server redirects. By default this is true.

参数:

followRedirects - true if server redirects should be followed.

返回:

this Connection, for chaining

method

Connection method(Connection.Method method)

Set the request method to use, GET or POST. Default is GET.

参数:

method - HTTP request method

返回:

this Connection, for chaining

data

Connection data(String key,
                String value)

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.

参数:

key - data key

value - data value

返回:

this Connection, for chaining

data

Connection data(Map<String,String> data)

Adds all of the supplied data to the request data parameters

参数:

data - map of data parameters

返回:

this Connection, for chaining

data

Connection data(String... keyvals)

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:

参数:

keyvals - a set of key value pairs.

返回:

this Connection, for chaining

header

Connection header(String name,
                  String value)

Set a request header.

参数:

name - header name

value - header value

返回:

this Connection, for chaining

cookie

Connection cookie(String name,
                  String value)

Set a cookie to be sent in the request

参数:

name - name of cookie

value - value of cookie

返回:

this Connection, for chaining

execute

Connection.Response execute()
                     throws IOException

Execute the request.

返回:

a response object

抛出:

IOException - on error

request

Connection.Request request()

Get the request object associatated with this connection

返回:

request

request

Connection request(Connection.Request request)

Set the connection's request

参数:

request - new request object

返回:

this Connection, for chaining

response

Connection.Response response()

Get the response, once the request has been executed

返回:

response

response

Connection response(Connection.Response response)

Set the conenction's response

参数:

response - new response

返回:

this Connection, for chaining