WSRequest (Play 2.4.8)

All Known Subinterfaces:

WSRequestHolder

All Known Implementing Classes:

NingWSRequest
```
public interface WSRequest
```
This is the main interface to building a WS request in Java.
Note that this interface does not expose properties that are only exposed after building the request: notably, the URL, headers and query parameters are shown before an OAuth signature is calculated.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`F.Promise<WSResponse>`	`delete()` Perform a DELETE on the request asynchronously.
`F.Promise<WSResponse>`	`execute()` Execute an arbitrary method on the request asynchronously.
`F.Promise<WSResponse>`	`execute(java.lang.String method)` Execute an arbitrary method on the request asynchronously.
`F.Promise<WSResponse>`	`get()` Perform a GET on the request asynchronously.
`WSSignatureCalculator`	`getCalculator()`
`java.lang.Boolean`	`getFollowRedirects()`
`java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>`	`getHeaders()`
`java.lang.String`	`getPassword()`
`java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>`	`getQueryParameters()`
`long`	`getRequestTimeout()` Gets the original request timeout in milliseconds, passed into the request as input.
`WSAuthScheme`	`getScheme()`
`java.lang.String`	`getUrl()`
`java.lang.String`	`getUsername()`
`F.Promise<WSResponse>`	`head()` Perform a HEAD on the request asynchronously.
`F.Promise<WSResponse>`	`options()` Perform an OPTIONS on the request asynchronously.
`F.Promise<WSResponse>`	`patch(java.io.File body)` Perform a PATCH on the request asynchronously.
`F.Promise<WSResponse>`	`patch(java.io.InputStream body)` Perform a PATCH on the request asynchronously.
`F.Promise<WSResponse>`	`patch(com.fasterxml.jackson.databind.JsonNode body)` Perform a PATCH on the request asynchronously.
`F.Promise<WSResponse>`	`patch(java.lang.String body)` Perform a PATCH on the request asynchronously.
`F.Promise<WSResponse>`	`post(java.io.File body)` Perform a POST on the request asynchronously.
`F.Promise<WSResponse>`	`post(java.io.InputStream body)` Perform a POST on the request asynchronously.
`F.Promise<WSResponse>`	`post(com.fasterxml.jackson.databind.JsonNode body)` Perform a POST on the request asynchronously.
`F.Promise<WSResponse>`	`post(java.lang.String body)` Perform a POST on the request asynchronously.
`F.Promise<WSResponse>`	`put(java.io.File body)` Perform a PUT on the request asynchronously.
`F.Promise<WSResponse>`	`put(java.io.InputStream body)` Perform a PUT on the request asynchronously.
`F.Promise<WSResponse>`	`put(com.fasterxml.jackson.databind.JsonNode body)` Perform a PUT on the request asynchronously.
`F.Promise<WSResponse>`	`put(java.lang.String body)` Perform a PUT on the request asynchronously.
`WSRequest`	`setAuth(java.lang.String userInfo)` Sets the authentication header for the current request using BASIC authentication.
`WSRequest`	`setAuth(java.lang.String username, java.lang.String password)` Sets the authentication header for the current request using BASIC authentication.
`WSRequest`	`setAuth(java.lang.String username, java.lang.String password, WSAuthScheme scheme)` Sets the authentication header for the current request.
`WSRequest`	`setBody(java.io.File body)` Set the body this request should use.
`WSRequest`	`setBody(java.io.InputStream body)` Set the body this request should use.
`WSRequest`	`setBody(com.fasterxml.jackson.databind.JsonNode body)` Set the body this request should use.
`WSRequest`	`setBody(java.lang.String body)` Set the body this request should use.
`WSRequest`	`setContentType(java.lang.String contentType)` Set the content type.
`WSRequest`	`setFollowRedirects(java.lang.Boolean followRedirects)` Sets whether redirects (301, 302) should be followed automatically.
`WSRequest`	`setHeader(java.lang.String name, java.lang.String value)` Adds a header to the request.
`WSRequest`	`setMethod(java.lang.String method)` Set the HTTP method this request should use, where the no args execute() method is invoked.
`WSRequest`	`setQueryParameter(java.lang.String name, java.lang.String value)` Sets a query parameter with the given name, this can be called repeatedly.
`WSRequest`	`setQueryString(java.lang.String query)` Sets the query string to query.
`WSRequest`	`setRequestTimeout(long timeout)` Sets the request timeout in milliseconds.
`WSRequest`	`setVirtualHost(java.lang.String virtualHost)` Sets the virtual host as a "hostname:port" string.
`WSRequest`	`sign(WSSignatureCalculator calculator)` Sets an (OAuth) signature calculator.

- Method Detail
  - get
```
F.Promise<WSResponse> get()
```
    Perform a GET on the request asynchronously.
  - patch
```
F.Promise<WSResponse> patch(java.lang.String body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as String
  - patch
```
F.Promise<WSResponse> patch(com.fasterxml.jackson.databind.JsonNode body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as JSON
  - patch
```
F.Promise<WSResponse> patch(java.io.InputStream body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as an InputStream
  - patch
```
F.Promise<WSResponse> patch(java.io.File body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as a File
  - post
```
F.Promise<WSResponse> post(java.lang.String body)
```
    Perform a POST on the request asynchronously.
    
    Parameters:
    
    body - represented as String
  - post
```
F.Promise<WSResponse> post(com.fasterxml.jackson.databind.JsonNode body)
```
    Perform a POST on the request asynchronously.
    
    Parameters:
    
    body - represented as JSON
  - post
```
F.Promise<WSResponse> post(java.io.InputStream body)
```
    Perform a POST on the request asynchronously.
    
    Parameters:
    
    body - represented as an InputStream
  - post
```
F.Promise<WSResponse> post(java.io.File body)
```
    Perform a POST on the request asynchronously.
    
    Parameters:
    
    body - represented as a File
  - put
```
F.Promise<WSResponse> put(java.lang.String body)
```
    Perform a PUT on the request asynchronously.
    
    Parameters:
    
    body - represented as String
  - put
```
F.Promise<WSResponse> put(com.fasterxml.jackson.databind.JsonNode body)
```
    Perform a PUT on the request asynchronously.
    
    Parameters:
    
    body - represented as JSON
  - put
```
F.Promise<WSResponse> put(java.io.InputStream body)
```
    Perform a PUT on the request asynchronously.
    
    Parameters:
    
    body - represented as an InputStream
  - put
```
F.Promise<WSResponse> put(java.io.File body)
```
    Perform a PUT on the request asynchronously.
    
    Parameters:
    
    body - represented as a File
  - delete
```
F.Promise<WSResponse> delete()
```
    Perform a DELETE on the request asynchronously.
  - head
```
F.Promise<WSResponse> head()
```
    Perform a HEAD on the request asynchronously.
  - options
```
F.Promise<WSResponse> options()
```
    Perform an OPTIONS on the request asynchronously.
  - execute
```
F.Promise<WSResponse> execute(java.lang.String method)
```
    Execute an arbitrary method on the request asynchronously.
    
    Parameters:
    
    method - The method to execute
  - execute
```
F.Promise<WSResponse> execute()
```
    Execute an arbitrary method on the request asynchronously. Should be used with setMethod().
  - setMethod
```
WSRequest setMethod(java.lang.String method)
```
    Set the HTTP method this request should use, where the no args execute() method is invoked.
  - setBody
```
WSRequest setBody(java.lang.String body)
```
    Set the body this request should use.
  - setBody
```
WSRequest setBody(com.fasterxml.jackson.databind.JsonNode body)
```
    Set the body this request should use.
  - setBody
```
WSRequest setBody(java.io.InputStream body)
```
    Set the body this request should use.
  - setBody
```
WSRequest setBody(java.io.File body)
```
    Set the body this request should use.
  - setHeader
```
WSRequest setHeader(java.lang.String name,
                    java.lang.String value)
```
    Adds a header to the request. Note that duplicate headers are allowed by the HTTP specification, and removing a header is not available through this API.
  - setQueryString
```
WSRequest setQueryString(java.lang.String query)
```
    Sets the query string to query.
  - setQueryParameter
```
WSRequest setQueryParameter(java.lang.String name,
                            java.lang.String value)
```
    Sets a query parameter with the given name, this can be called repeatedly. Duplicate query parameters are allowed.
    
    Parameters:
    
    name -
    
    value -
  - setAuth
```
WSRequest setAuth(java.lang.String userInfo)
```
    Sets the authentication header for the current request using BASIC authentication.
    
    Parameters:
    
    userInfo -
  - setAuth
```
WSRequest setAuth(java.lang.String username,
                  java.lang.String password)
```
    Sets the authentication header for the current request using BASIC authentication.
    
    Parameters:
    
    username -
    
    password -
  - setAuth
```
WSRequest setAuth(java.lang.String username,
                  java.lang.String password,
                  WSAuthScheme scheme)
```
    Sets the authentication header for the current request.
    
    Parameters:
    
    username -
    
    password -
    
    scheme - authentication scheme
  - sign
```
WSRequest sign(WSSignatureCalculator calculator)
```
    Sets an (OAuth) signature calculator.
  - setFollowRedirects
```
WSRequest setFollowRedirects(java.lang.Boolean followRedirects)
```
    Sets whether redirects (301, 302) should be followed automatically.
    
    Parameters:
    
    followRedirects -
  - setVirtualHost
```
WSRequest setVirtualHost(java.lang.String virtualHost)
```
    Sets the virtual host as a "hostname:port" string.
  - setRequestTimeout
```
WSRequest setRequestTimeout(long timeout)
```
    Sets the request timeout in milliseconds.
    
    Parameters:
    
    timeout - the request timeout in milliseconds. A value of -1 indicates an infinite request timeout.
    
    Returns:
    
    the modified WSRequest.
  - setContentType
```
WSRequest setContentType(java.lang.String contentType)
```
    Set the content type. If the request body is a String, and no charset parameter is included, then it will default to UTF-8.
    
    Parameters:
    
    contentType - The content type
  - getUrl
```
java.lang.String getUrl()
```
    Returns:
    
    the URL of the request. This has not passed through an internal request builder and so will not be signed.
  - getHeaders
```
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getHeaders()
```
    Returns:
    
    the headers (a copy to prevent side-effects). This has not passed through an internal request builder and so will not be signed.
  - getQueryParameters
```
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getQueryParameters()
```
    Returns:
    
    the query parameters (a copy to prevent side-effects). This has not passed through an internal request builder and so will not be signed.
  - getUsername
```
java.lang.String getUsername()
```
    Returns:
    
    the auth username, null if not an authenticated request.
  - getPassword
```
java.lang.String getPassword()
```
    Returns:
    
    the auth password, null if not an authenticated request
  - getScheme
```
WSAuthScheme getScheme()
```
    Returns:
    
    the auth scheme, null if not an authenticated request.
  - getCalculator
```
WSSignatureCalculator getCalculator()
```
    Returns:
    
    the signature calculator (example: OAuth), null if none is set.
  - getRequestTimeout
```
long getRequestTimeout()
```
    Gets the original request timeout in milliseconds, passed into the request as input.
  - getFollowRedirects
```
java.lang.Boolean getFollowRedirects()
```
    Returns:
    
    true if the request is configure to follow redirect, false if it is configure not to, null if nothing is configured and the global client preference should be used instead.

Interface WSRequest

Method Summary

Method Detail

get

patch

patch

patch

patch

post

post

post

post

put

put

put

put

delete

head

options

execute

execute

setMethod

setBody

setBody

setBody

setBody

setHeader

setQueryString

setQueryParameter

setAuth

setAuth

setAuth

sign

setFollowRedirects

setVirtualHost

setRequestTimeout

setContentType

getUrl

getHeaders

getQueryParameters

getUsername

getPassword

getScheme

getCalculator

getRequestTimeout

getFollowRedirects