WSRequest (Play 2.6.0-M4)

All Superinterfaces:

StandaloneWSRequest

All Known Implementing Classes:

AhcWSRequest
```
public interface WSRequest
extends StandaloneWSRequest
```
An enhanced WSRequest that can use Play specific classes.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.util.concurrent.CompletionStage<WSResponse>`	`delete()` Perform a DELETE on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`execute()` Execute an arbitrary method on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`execute(java.lang.String method)` Execute an arbitrary method on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`get()` Perform a GET on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`head()` Perform a HEAD on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`options()` Perform an OPTIONS on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends WSResponse>`	`patch(java.io.File body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`patch(java.io.InputStream body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`patch(com.fasterxml.jackson.databind.JsonNode body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`patch(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`patch(java.lang.String body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`post(java.io.File body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`post(java.io.InputStream body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`post(com.fasterxml.jackson.databind.JsonNode body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`post(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`post(java.lang.String body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`put(java.io.File body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`put(java.io.InputStream body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`put(com.fasterxml.jackson.databind.JsonNode body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`put(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<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)` Deprecated. use `setBody(Source)` instead.
`WSRequest`	`setBody(com.fasterxml.jackson.databind.JsonNode body)` Set the body this request should use.
`<U> WSRequest`	`setBody(akka.stream.javadsl.Source<akka.util.ByteString,U> 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(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)` Sets the HTTP method this request should use, where the no args execute() method is invoked.
`WSRequest`	`setMultipartBody(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)` Set the multipart body this request should use.
`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`	`setRequestFilter(WSRequestFilter filter)` Adds a request filter.
`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.
`java.util.concurrent.CompletionStage<? extends StreamedResponse>`	`stream()` Execute this request and stream the response body.

Methods inherited from interface play.libs.ws.StandaloneWSRequest
getCalculator, getContentType, getFollowRedirects, getHeaders, getPassword, getQueryParameters, getRequestTimeout, getScheme, getUrl, getUsername

- Method Detail
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as a MultipartFormData.Part
    
    Returns:
    
    a promise to the response
  - post
```
java.util.concurrent.CompletionStage<WSResponse> post(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
```
    Perform a POST on the request asynchronously.
    
    Parameters:
    
    body - represented as a MultipartFormData.Part
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
```
    Perform a PUT on the request asynchronously.
    
    Parameters:
    
    body - represented as a MultipartFormData.Part
    
    Returns:
    
    a promise to the response
  - setMultipartBody
```
WSRequest setMultipartBody(akka.stream.javadsl.Source<? super Http.MultipartFormData.Part<akka.stream.javadsl.Source<akka.util.ByteString,?>>,?> body)
```
    Set the multipart body this request should use.
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - get
```
java.util.concurrent.CompletionStage<WSResponse> get()
```
    Perform a GET on the request asynchronously.
    
    Specified by:
    
    get in interface StandaloneWSRequest
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(java.lang.String body)
```
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as String
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(com.fasterxml.jackson.databind.JsonNode body)
```
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(java.io.InputStream body)
```
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as an InputStream
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<? extends WSResponse> patch(java.io.File body)
```
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as a File
    
    Returns:
    
    a promise to the response
  - post
```
java.util.concurrent.CompletionStage<WSResponse> post(java.lang.String body)
```
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as String
    
    Returns:
    
    a promise to the response
  - post
```
java.util.concurrent.CompletionStage<WSResponse> post(com.fasterxml.jackson.databind.JsonNode body)
```
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - post
```
java.util.concurrent.CompletionStage<WSResponse> post(java.io.InputStream body)
```
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as an InputStream
    
    Returns:
    
    a promise to the response
  - post
```
java.util.concurrent.CompletionStage<WSResponse> post(java.io.File body)
```
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as a File
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(java.lang.String body)
```
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as String
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(com.fasterxml.jackson.databind.JsonNode body)
```
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(java.io.InputStream body)
```
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as an InputStream
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(java.io.File body)
```
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface StandaloneWSRequest
    
    Parameters:
    
    body - represented as a File
    
    Returns:
    
    a promise to the response
  - delete
```
java.util.concurrent.CompletionStage<WSResponse> delete()
```
    Perform a DELETE on the request asynchronously.
    
    Specified by:
    
    delete in interface StandaloneWSRequest
    
    Returns:
    
    a promise to the response
  - head
```
java.util.concurrent.CompletionStage<WSResponse> head()
```
    Perform a HEAD on the request asynchronously.
    
    Specified by:
    
    head in interface StandaloneWSRequest
    
    Returns:
    
    a promise to the response
  - options
```
java.util.concurrent.CompletionStage<WSResponse> options()
```
    Perform an OPTIONS on the request asynchronously.
    
    Specified by:
    
    options in interface StandaloneWSRequest
    
    Returns:
    
    a promise to the response
  - execute
```
java.util.concurrent.CompletionStage<WSResponse> execute(java.lang.String method)
```
    Execute an arbitrary method on the request asynchronously.
    
    Specified by:
    
    execute in interface StandaloneWSRequest
    
    Parameters:
    
    method - The method to execute
    
    Returns:
    
    a promise to the response
  - execute
```
java.util.concurrent.CompletionStage<WSResponse> execute()
```
    Execute an arbitrary method on the request asynchronously. Should be used with setMethod().
    
    Specified by:
    
    execute in interface StandaloneWSRequest
    
    Returns:
    
    a promise to the response
  - stream
```
java.util.concurrent.CompletionStage<? extends StreamedResponse> stream()
```
    Execute this request and stream the response body.
    
    Specified by:
    
    stream in interface StandaloneWSRequest
    
    Returns:
    
    a promise to the streaming response
  - setMethod
```
WSRequest setMethod(java.lang.String method)
```
    Sets the HTTP method this request should use, where the no args execute() method is invoked.
    
    Specified by:
    
    setMethod in interface StandaloneWSRequest
    
    Parameters:
    
    method - the HTTP method.
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
WSRequest setBody(java.lang.String body)
```
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface StandaloneWSRequest
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
WSRequest setBody(com.fasterxml.jackson.databind.JsonNode body)
```
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface StandaloneWSRequest
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
@Deprecated
WSRequest setBody(java.io.InputStream body)
```
    Deprecated. use setBody(Source) instead.
    
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface StandaloneWSRequest
    
    Parameters:
    
    body - Deprecated
    
    Returns:
    
    Deprecated
  - setBody
```
WSRequest setBody(java.io.File body)
```
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface StandaloneWSRequest
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
<U> WSRequest setBody(akka.stream.javadsl.Source<akka.util.ByteString,U> body)
```
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface StandaloneWSRequest
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - 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.
    
    Specified by:
    
    setHeader in interface StandaloneWSRequest
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    the modified WSRequest.
  - setQueryString
```
WSRequest setQueryString(java.lang.String query)
```
    Sets the query string to query.
    
    Specified by:
    
    setQueryString in interface StandaloneWSRequest
    
    Parameters:
    
    query - the fully formed query string
    
    Returns:
    
    the modified WSRequest.
  - 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.
    
    Specified by:
    
    setQueryParameter in interface StandaloneWSRequest
    
    Parameters:
    
    name - the query parameter name
    
    value - the query parameter value
    
    Returns:
    
    the modified WSRequest.
  - setAuth
```
WSRequest setAuth(java.lang.String userInfo)
```
    Sets the authentication header for the current request using BASIC authentication.
    
    Specified by:
    
    setAuth in interface StandaloneWSRequest
    
    Parameters:
    
    userInfo - a string formed as "username:password".
    
    Returns:
    
    the modified WSRequest.
  - setAuth
```
WSRequest setAuth(java.lang.String username,
                  java.lang.String password)
```
    Sets the authentication header for the current request using BASIC authentication.
    
    Specified by:
    
    setAuth in interface StandaloneWSRequest
    
    Parameters:
    
    username - the basic auth username
    
    password - the basic auth password
    
    Returns:
    
    the modified WSRequest.
  - setAuth
```
WSRequest setAuth(java.lang.String username,
                  java.lang.String password,
                  WSAuthScheme scheme)
```
    Sets the authentication header for the current request.
    
    Specified by:
    
    setAuth in interface StandaloneWSRequest
    
    Parameters:
    
    username - the username
    
    password - the password
    
    scheme - authentication scheme
    
    Returns:
    
    the modified WSRequest.
  - sign
```
WSRequest sign(WSSignatureCalculator calculator)
```
    Sets an (OAuth) signature calculator.
    
    Specified by:
    
    sign in interface StandaloneWSRequest
    
    Parameters:
    
    calculator - the signature calculator
    
    Returns:
    
    the modified WSRequest
  - setFollowRedirects
```
WSRequest setFollowRedirects(boolean followRedirects)
```
    Sets whether redirects (301, 302) should be followed automatically.
    
    Specified by:
    
    setFollowRedirects in interface StandaloneWSRequest
    
    Parameters:
    
    followRedirects - true if the request should follow redirects
    
    Returns:
    
    the modified WSRequest
  - setVirtualHost
```
WSRequest setVirtualHost(java.lang.String virtualHost)
```
    Sets the virtual host as a "hostname:port" string.
    
    Specified by:
    
    setVirtualHost in interface StandaloneWSRequest
    
    Parameters:
    
    virtualHost - the virtual host
    
    Returns:
    
    the modified WSRequest
  - setRequestTimeout
```
WSRequest setRequestTimeout(long timeout)
```
    Sets the request timeout in milliseconds.
    
    Specified by:
    
    setRequestTimeout in interface StandaloneWSRequest
    
    Parameters:
    
    timeout - the request timeout in milliseconds. A value of -1 indicates an infinite request timeout.
    
    Returns:
    
    the modified WSRequest.
  - setRequestFilter
```
WSRequest setRequestFilter(WSRequestFilter filter)
```
    Adds a request filter.
    
    Specified by:
    
    setRequestFilter in interface StandaloneWSRequest
    
    Parameters:
    
    filter - a transforming filter.
    
    Returns:
    
    the modified request.
  - 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.
    
    Specified by:
    
    setContentType in interface StandaloneWSRequest
    
    Parameters:
    
    contentType - The content type
    
    Returns:
    
    the modified WSRequest

Interface WSRequest

Method Summary

Methods inherited from interface play.libs.ws.StandaloneWSRequest

Method Detail

patch

post

put

setMultipartBody

get

patch

patch

patch

patch

post

post

post

post

put

put

put

put

delete

head

options

execute

execute

stream

setMethod

setBody

setBody

setBody

setBody

setBody

setHeader

setQueryString

setQueryParameter

setAuth

setAuth

setAuth

sign

setFollowRedirects

setVirtualHost

setRequestTimeout

setRequestFilter

setContentType