WS.WSRequest (Play! API)

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

Direct Known Subclasses:

WSAsync.WSAsyncRequest, WSUrlFetch.WSUrlfetchRequest

Enclosing class:

WS
```
public abstract static class WS.WSRequest
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`Object`	`body` The body of this request
`String`	`encoding`
`WS.FileParam[]`	`fileParams`
`boolean`	`followRedirects` Sets whether redirects (301, 302) should be followed automatically
`Map<String,String>`	`headers`
`String`	`mimeType`
`OAuth.ServiceInfo`	`oauthInfo`
`String`	`oauthSecret`
`String`	`oauthToken`
`Map<String,Object>`	`parameters`
`String`	`password`
`WS.Scheme`	`scheme`
`Integer`	`timeout` timeout: value in seconds
`String`	`url`
`String`	`username`
`String`	`virtualHost` The virtual host this request will use

Constructor Summary

Constructors
Constructor and Description

WSRequest()

WSRequest(String url, String encoding)

Constructors
Constructor and Description
`WSRequest()`
`WSRequest(String url, String encoding)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`WS.WSRequest`	`authenticate(String username, 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(String username, String password, WS.Scheme scheme)` define client authentication for a server host provided credentials will be used during the request
`protected String`	`basicAuthHeader()`
`WS.WSRequest`	`body(Object body)` Add the given body to the request.
`protected String`	`createQueryString()`
`abstract WS.HttpResponse`	`delete()` Execute a DELETE request.
`F.Promise<WS.HttpResponse>`	`deleteAsync()` Execute a DELETE request asynchronously.
`protected String`	`encode(String part)`
`WS.WSRequest`	`files(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(Map<String,String> headers)` Use the provided headers when executing request.
`WS.WSRequest`	`mimeType(String mimeType)` Add a MimeType to the web service request.
`WS.WSRequest`	`oauth(OAuth.ServiceInfo oauthInfo, OAuth.TokenPair oauthTokens)` Deprecated.
`WS.WSRequest`	`oauth(OAuth.ServiceInfo oauthInfo, String token, 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(Map<String,Object> parameters)` Add parameters to request.
`abstract WS.HttpResponse`	`patch()` Execute a PATCH request.
`F.Promise<WS.HttpResponse>`	`patchAsync()` Execute a PATCH request asynchronously.
`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(String name, String value)` Add a header to the request
`WS.WSRequest`	`setParameter(String name, Object value)`
`WS.WSRequest`	`setParameter(String name, String value)` Add a parameter to the request
`WS.WSRequest`	`setParameters(Map<String,String> parameters)` Add parameters to request.
`WS.WSRequest`	`timeout(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.
`WS.WSRequest`	`withVirtualHost(String virtualHost)` Sets the virtual host to use in this request

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - url
```
public String url
```
  - virtualHost
```
public String virtualHost
```
    The virtual host this request will use
  - encoding
```
public final String encoding
```
  - username
```
public String username
```
  - password
```
public String password
```
  - scheme
```
public WS.Scheme scheme
```
  - body
```
public Object body
```
    The body of this request
  - fileParams
```
public WS.FileParam[] fileParams
```
  - headers
```
public Map<String,String> headers
```
  - parameters
```
public Map<String,Object> parameters
```
  - mimeType
```
public String mimeType
```
  - followRedirects
```
public boolean followRedirects
```
    Sets whether redirects (301, 302) should be followed automatically
  - timeout
```
public Integer timeout
```
    timeout: value in seconds
  - oauthInfo
```
public OAuth.ServiceInfo oauthInfo
```
  - oauthToken
```
public String oauthToken
```
  - oauthSecret
```
public String oauthSecret
```
- Constructor Detail
  - WSRequest
```
public WSRequest()
```
  - WSRequest
```
public WSRequest(String url,
                 String encoding)
```
- Method Detail
  - withVirtualHost
```
public WS.WSRequest withVirtualHost(String virtualHost)
```
    Sets the virtual host to use in this request
  - mimeType
```
public WS.WSRequest mimeType(String mimeType)
```
    Add a MimeType to the web service request.
    
    Parameters:
    
    mimeType -
    
    Returns:
    
    the WSRequest for chaining.
  - authenticate
```
public WS.WSRequest authenticate(String username,
                                 String password,
                                 WS.Scheme scheme)
```
    define client authentication for a server host provided credentials will be used during the request
    
    Parameters:
    
    username -
    
    password -
    
    Returns:
    
    the WSRequest for chaining.
  - authenticate
```
public WS.WSRequest authenticate(String username,
                                 String password)
```
    define client authentication for a server host provided credentials will be used during the request the basic scheme will be used
    
    Parameters:
    
    username -
    
    password -
    
    Returns:
    
    the WSRequest for chaining.
  - oauth
```
public WS.WSRequest oauth(OAuth.ServiceInfo oauthInfo,
                          String token,
                          String secret)
```
    Sign the request for do a call to a server protected by oauth
    
    Returns:
    
    the WSRequest for chaining.
  - oauth
```
@Deprecated
public WS.WSRequest oauth(OAuth.ServiceInfo oauthInfo,
                                       OAuth.TokenPair oauthTokens)
```
    Deprecated.
  - followRedirects
```
public WS.WSRequest followRedirects(boolean value)
```
    Indicate if the WS should continue when hitting a 301 or 302
    
    Returns:
    
    the WSRequest for chaining.
  - timeout
```
public WS.WSRequest timeout(String timeout)
```
    Set the value of the request timeout, i.e. the number of seconds before cutting the connection - default to 60 seconds
    
    Parameters:
    
    timeout - the timeout value, e.g. "30s", "1min"
    
    Returns:
    
    the WSRequest for chaining
  - files
```
public WS.WSRequest files(File... files)
```
    Add files to request. This will only work with POST or PUT.
    
    Parameters:
    
    files -
    
    Returns:
    
    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.
    
    Parameters:
    
    fileParams -
    
    Returns:
    
    the WSRequest for chaining.
  - body
```
public WS.WSRequest body(Object body)
```
    Add the given body to the request.
    
    Parameters:
    
    body -
    
    Returns:
    
    the WSRequest for chaining.
  - setHeader
```
public WS.WSRequest setHeader(String name,
                              String value)
```
    Add a header to the request
    
    Parameters:
    
    name - header name
    
    value - header value
    
    Returns:
    
    the WSRequest for chaining.
  - setParameter
```
public WS.WSRequest setParameter(String name,
                                 String value)
```
    Add a parameter to the request
    
    Parameters:
    
    name - parameter name
    
    value - parameter value
    
    Returns:
    
    the WSRequest for chaining.
  - setParameter
```
public WS.WSRequest setParameter(String name,
                                 Object value)
```
  - headers
```
public WS.WSRequest headers(Map<String,String> headers)
```
    Use the provided headers when executing request.
    
    Parameters:
    
    headers -
    
    Returns:
    
    the WSRequest for chaining.
  - params
```
public WS.WSRequest params(Map<String,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.
    
    Returns:
    
    the WSRequest for chaining.
  - setParameters
```
public WS.WSRequest setParameters(Map<String,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.
    
    Returns:
    
    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.
  - patch
```
public abstract WS.HttpResponse patch()
```
    Execute a PATCH request.
  - patchAsync
```
public F.Promise<WS.HttpResponse> patchAsync()
```
    Execute a PATCH 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 String basicAuthHeader()
```
  - encode
```
protected String encode(String part)
```
  - createQueryString
```
protected String createQueryString()
```

Class WS.WSRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

url

virtualHost

encoding

username

password

scheme

body

fileParams

headers

parameters

mimeType

followRedirects

timeout

oauthInfo

oauthToken

oauthSecret

Constructor Detail

WSRequest

WSRequest

Method Detail

withVirtualHost

mimeType

authenticate

authenticate

oauth

oauth

followRedirects

timeout

files

files

body

setHeader

setParameter

setParameter

headers

params

setParameters

get

getAsync

patch

patchAsync

post

postAsync

put

putAsync

delete

deleteAsync

options

optionsAsync

head

headAsync

trace

traceAsync

basicAuthHeader

encode

createQueryString