play.libs
类 WS.WSRequest

java.lang.Object
  play.libs.WS.WSRequest

直接已知子类：

WSAsync.WSAsyncRequest, WSUrlFetch.WSUrlfetchRequest

包容类：

WS

public abstract static class WS.WSRequest
extends java.lang.Object

字段摘要

java.lang.Object	body
java.lang.String	encoding
WS.FileParam[]	fileParams
boolean	followRedirects
java.util.Map<java.lang.String,java.lang.String>	headers
java.lang.String	mimeType
OAuth.ServiceInfo	oauthInfo
java.lang.String	oauthSecret
java.lang.String	oauthToken
java.util.Map<java.lang.String,java.lang.Object>	parameters
java.lang.String	password
WS.Scheme	scheme
java.lang.Integer	timeout timeout: value in seconds
java.lang.String	url
java.lang.String	username

构造方法摘要

WS.WSRequest()

WS.WSRequest(java.lang.String url, java.lang.String encoding)

方法摘要

WS.WSRequest	authenticate(java.lang.String username, java.lang.String password) define client authentication for a server host provided credentials will be used during the request the basic scheme will be used
WS.WSRequest	authenticate(java.lang.String username, java.lang.String password, WS.Scheme scheme) define client authentication for a server host provided credentials will be used during the request
protected java.lang.String	basicAuthHeader()
WS.WSRequest	body(java.lang.Object body) Add the given body to the request.
protected java.lang.String	createQueryString()
abstract WS.HttpResponse	delete() Execute a DELETE request.
F.Promise<WS.HttpResponse>	deleteAsync() Execute a DELETE request asynchronously.
protected java.lang.String	encode(java.lang.String part)
WS.WSRequest	files(java.io.File... files) Add files to request.
WS.WSRequest	files(WS.FileParam... fileParams) Add fileParams aka File and Name parameter to the request.
WS.WSRequest	followRedirects(boolean value) Indicate if the WS should continue when hitting a 301 or 302
abstract WS.HttpResponse	get() Execute a GET request synchronously.
F.Promise<WS.HttpResponse>	getAsync() Execute a GET request asynchronously.
abstract WS.HttpResponse	head() Execute a HEAD request.
F.Promise<WS.HttpResponse>	headAsync() Execute a HEAD request asynchronously.
WS.WSRequest	headers(java.util.Map<java.lang.String,java.lang.String> headers) Use the provided headers when executing request.
WS.WSRequest	mimeType(java.lang.String mimeType) Add a MimeType to the web service request.
WS.WSRequest	oauth(OAuth.ServiceInfo oauthInfo, OAuth.TokenPair oauthTokens) 已过时。
WS.WSRequest	oauth(OAuth.ServiceInfo oauthInfo, java.lang.String token, java.lang.String secret) Sign the request for do a call to a server protected by oauth
abstract WS.HttpResponse	options() Execute a OPTIONS request.
F.Promise<WS.HttpResponse>	optionsAsync() Execute a OPTIONS request asynchronously.
WS.WSRequest	params(java.util.Map<java.lang.String,java.lang.Object> parameters) Add parameters to request.
abstract WS.HttpResponse	post() Execute a POST request.
F.Promise<WS.HttpResponse>	postAsync() Execute a POST request asynchronously.
abstract WS.HttpResponse	put() Execute a PUT request.
F.Promise<WS.HttpResponse>	putAsync() Execute a PUT request asynchronously.
WS.WSRequest	setHeader(java.lang.String name, java.lang.String value) Add a header to the request
WS.WSRequest	setParameter(java.lang.String name, java.lang.Object value)
WS.WSRequest	setParameter(java.lang.String name, java.lang.String value) Add a parameter to the request
WS.WSRequest	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Add parameters to request.
WS.WSRequest	timeout(java.lang.String timeout) Set the value of the request timeout, i.e. the number of seconds before cutting the connection - default to 60 seconds
abstract WS.HttpResponse	trace() Execute a TRACE request.
F.Promise<WS.HttpResponse>	traceAsync() Execute a TRACE request asynchronously.

从类 java.lang.Object 继承的方法

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

字段详细信息

url

public java.lang.String url

encoding

public final java.lang.String encoding

username

public java.lang.String username

password

public java.lang.String password

scheme

public WS.Scheme scheme

body

public java.lang.Object body

fileParams

public WS.FileParam[] fileParams

headers

public java.util.Map<java.lang.String,java.lang.String> headers

parameters

public java.util.Map<java.lang.String,java.lang.Object> parameters

mimeType

public java.lang.String mimeType

followRedirects

public boolean followRedirects

timeout

public java.lang.Integer timeout

timeout: value in seconds

oauthInfo

public OAuth.ServiceInfo oauthInfo

oauthToken

public java.lang.String oauthToken

oauthSecret

public java.lang.String oauthSecret

构造方法详细信息

WS.WSRequest

public WS.WSRequest()

WS.WSRequest

public WS.WSRequest(java.lang.String url,
                    java.lang.String encoding)

方法详细信息

mimeType

public WS.WSRequest mimeType(java.lang.String mimeType)

Add a MimeType to the web service request.

参数：

mimeType -

返回：

the WSRequest for chaining.

authenticate

public WS.WSRequest authenticate(java.lang.String username,
                                 java.lang.String password,
                                 WS.Scheme scheme)

define client authentication for a server host provided credentials will be used during the request

参数：

username -

password -

返回：

the WSRequest for chaining.

authenticate

public WS.WSRequest authenticate(java.lang.String username,
                                 java.lang.String password)

define client authentication for a server host provided credentials will be used during the request the basic scheme will be used

参数：

username -

password -

返回：

the WSRequest for chaining.

oauth

public WS.WSRequest oauth(OAuth.ServiceInfo oauthInfo,
                          java.lang.String token,
                          java.lang.String secret)

Sign the request for do a call to a server protected by oauth

返回：

the WSRequest for chaining.

oauth

@Deprecated
public WS.WSRequest oauth(OAuth.ServiceInfo oauthInfo,
                                     OAuth.TokenPair oauthTokens)

已过时。

followRedirects

public WS.WSRequest followRedirects(boolean value)

Indicate if the WS should continue when hitting a 301 or 302

返回：

the WSRequest for chaining.

timeout

public WS.WSRequest timeout(java.lang.String timeout)

Set the value of the request timeout, i.e. the number of seconds before cutting the connection - default to 60 seconds

参数：

timeout - the timeout value, e.g. "30s", "1min"

返回：

the WSRequest for chaining

files

public WS.WSRequest files(java.io.File... files)

Add files to request. This will only work with POST or PUT.

参数：

files -

返回：

the WSRequest for chaining.

files

public WS.WSRequest files(WS.FileParam... fileParams)

Add fileParams aka File and Name parameter to the request. This will only work with POST or PUT.

参数：

fileParams -

返回：

the WSRequest for chaining.

body

public WS.WSRequest body(java.lang.Object body)

Add the given body to the request.

参数：

body -

返回：

the WSRequest for chaining.

setHeader

public WS.WSRequest setHeader(java.lang.String name,
                              java.lang.String value)

Add a header to the request

参数：

name - header name

value - header value

返回：

the WSRequest for chaining.

setParameter

public WS.WSRequest setParameter(java.lang.String name,
                                 java.lang.String value)

Add a parameter to the request

参数：

name - parameter name

value - parameter value

返回：

the WSRequest for chaining.

setParameter

public WS.WSRequest setParameter(java.lang.String name,
                                 java.lang.Object value)

headers

public WS.WSRequest headers(java.util.Map<java.lang.String,java.lang.String> headers)

Use the provided headers when executing request.

参数：

headers -

返回：

the WSRequest for chaining.

params

public WS.WSRequest params(java.util.Map<java.lang.String,java.lang.Object> parameters)

Add parameters to request. If POST or PUT, parameters are passed in body using x-www-form-urlencoded if alone, or form-data if there is files too. For any other method, those params are appended to the queryString.

返回：

the WSRequest for chaining.

setParameters

public WS.WSRequest setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Add parameters to request. If POST or PUT, parameters are passed in body using x-www-form-urlencoded if alone, or form-data if there is files too. For any other method, those params are appended to the queryString.

返回：

the WSRequest for chaining.

get

public abstract WS.HttpResponse get()

Execute a GET request synchronously.

getAsync

public F.Promise<WS.HttpResponse> getAsync()

Execute a GET request asynchronously.

post

public abstract WS.HttpResponse post()

Execute a POST request.

postAsync

public F.Promise<WS.HttpResponse> postAsync()

Execute a POST request asynchronously.

put

public abstract WS.HttpResponse put()

Execute a PUT request.

putAsync

public F.Promise<WS.HttpResponse> putAsync()

Execute a PUT request asynchronously.

delete

public abstract WS.HttpResponse delete()

Execute a DELETE request.

deleteAsync

public F.Promise<WS.HttpResponse> deleteAsync()

Execute a DELETE request asynchronously.

options

public abstract WS.HttpResponse options()

Execute a OPTIONS request.

optionsAsync

public F.Promise<WS.HttpResponse> optionsAsync()

Execute a OPTIONS request asynchronously.

head

public abstract WS.HttpResponse head()

Execute a HEAD request.

headAsync

public F.Promise<WS.HttpResponse> headAsync()

Execute a HEAD request asynchronously.

trace

public abstract WS.HttpResponse trace()

Execute a TRACE request.

traceAsync

public F.Promise<WS.HttpResponse> traceAsync()

Execute a TRACE request asynchronously.

basicAuthHeader

protected java.lang.String basicAuthHeader()

encode

protected java.lang.String encode(java.lang.String part)

createQueryString

protected java.lang.String createQueryString()