WSRequest (Play 2.6.3)

All Superinterfaces:

play.libs.ws.StandaloneWSRequest

All Known Implementing Classes:

AhcWSRequest
```
public interface WSRequest
extends play.libs.ws.StandaloneWSRequest
```
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 Deprecated Methods
Modifier and Type	Method and Description
`WSRequest`	`addCookie(Http.Cookie cookie)` Adds a cookie to the request
`WSRequest`	`addCookie(play.libs.ws.WSCookie cookie)` Adds a cookie to the request
`WSRequest`	`addCookies(play.libs.ws.WSCookie... cookies)` Sets several cookies on the request.
`WSRequest`	`addHeader(java.lang.String name, java.lang.String value)` Adds a header to the request.
`WSRequest`	`addQueryParameter(java.lang.String name, java.lang.String value)` Sets a query parameter with the given name, this can be called repeatedly.
`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.
`play.libs.ws.WSSignatureCalculator`	`getCalculator()`
`boolean`	`getFollowRedirects()` If the `setFollowRedirects(boolean)` method has been called, then returns true.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getHeaders()`
`java.lang.String`	`getPassword()`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getQueryParameters()`
`long`	`getRequestTimeout()` Deprecated. use `getRequestTimeoutDuration()`
`java.time.Duration`	`getRequestTimeoutDuration()` Deprecated. use `getRequestTimeoutDuration()`
`play.libs.ws.WSAuthScheme`	`getScheme()`
`java.lang.String`	`getUrl()`
`java.lang.String`	`getUsername()`
`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<WSResponse>`	`patch(play.libs.ws.BodyWritable body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`patch(org.w3c.dom.Document body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<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(play.libs.ws.BodyWritable body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`post(org.w3c.dom.Document body)` Perform a POST 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)` Deprecated. use `post(BodyWritable)`
`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(play.libs.ws.BodyWritable body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<WSResponse>`	`put(org.w3c.dom.Document body)` Perform a PUT 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, play.libs.ws.WSAuthScheme scheme)` Sets the authentication header for the current request.
`WSRequest`	`setBody(play.libs.ws.BodyWritable body)` Set the body this request should use.
`WSRequest`	`setBody(java.io.File body)` Set the body this request should use.
`WSRequest`	`setBody(java.io.InputStream body)` Deprecated. use `setBody(BodyWritable)`
`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`	`setCookies(java.util.List<play.libs.ws.WSCookie> cookies)` Sets all the cookies on the request.
`WSRequest`	`setFollowRedirects(boolean followRedirects)` Sets whether redirects (301, 302) should be followed automatically.
`WSRequest`	`setHeader(java.lang.String name, java.lang.String value)` Deprecated. use `addHeader(String, String)`
`WSRequest`	`setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)` Sets all of the headers on 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`	`setQueryParameter(java.lang.String name, java.lang.String value)` Deprecated. use `addQueryParameter(String, String)`
`WSRequest`	`setQueryString(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params)` Sets the query string to query.
`WSRequest`	`setQueryString(java.lang.String query)` Sets the query string to query.
`WSRequest`	`setRequestFilter(play.libs.ws.WSRequestFilter filter)` Adds a request filter.
`WSRequest`	`setRequestTimeout(java.time.Duration timeout)` Sets the request timeout in milliseconds.
`WSRequest`	`setRequestTimeout(long timeout)` Deprecated. use `setRequestTimeout(Duration)`
`WSRequest`	`setVirtualHost(java.lang.String virtualHost)` Sets the virtual host as a "hostname:port" string.
`WSRequest`	`sign(play.libs.ws.WSSignatureCalculator calculator)` Sets an (OAuth) signature calculator.
`java.util.concurrent.CompletionStage<WSResponse>`	`stream()` Execute this request and stream the response body.

Methods inherited from interface play.libs.ws.StandaloneWSRequest
getContentType, getHeader, getHeaderValues

- Method Detail
  - get
```
java.util.concurrent.CompletionStage<WSResponse> get()
```
    Perform a GET on the request asynchronously.
    
    Specified by:
    
    get in interface play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(play.libs.ws.BodyWritable body)
```
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    body - represented as BodyWritable
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(java.lang.String body)
```
    Perform a PATCH on the request asynchronously.
    
    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.
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(org.w3c.dom.Document body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as a Document
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(java.io.InputStream body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as an InputStream
    
    Returns:
    
    a promise to the response
  - patch
```
java.util.concurrent.CompletionStage<WSResponse> patch(java.io.File body)
```
    Perform a PATCH on the request asynchronously.
    
    Parameters:
    
    body - represented as a File
    
    Returns:
    
    a promise to the response
  - 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(play.libs.ws.BodyWritable body)
```
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    body - represented as body writable
    
    Returns:
    
    a promise to the response
  - post
```
java.util.concurrent.CompletionStage<WSResponse> post(java.lang.String body)
```
    Perform a POST on the request asynchronously.
    
    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.
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - post
```
java.util.concurrent.CompletionStage<WSResponse> post(org.w3c.dom.Document body)
```
    Perform a POST on the request asynchronously.
    
    Parameters:
    
    body - represented as a Document
    
    Returns:
    
    a promise to the response
  - post
```
@Deprecated
java.util.concurrent.CompletionStage<WSResponse> post(java.io.InputStream body)
```
    Deprecated. use post(BodyWritable)
    
    Perform a POST on the request asynchronously.
    
    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.
    
    Parameters:
    
    body - represented as a File
    
    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(play.libs.ws.BodyWritable body)
```
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    body - represented as BodyWritable
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(java.lang.String body)
```
    Perform a PUT on the request asynchronously.
    
    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.
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(org.w3c.dom.Document body)
```
    Perform a PUT on the request asynchronously.
    
    Parameters:
    
    body - represented as a Document
    
    Returns:
    
    a promise to the response
  - put
```
java.util.concurrent.CompletionStage<WSResponse> put(java.io.InputStream body)
```
    Perform a PUT on the request asynchronously.
    
    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.
    
    Parameters:
    
    body - represented as a File
    
    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
  - delete
```
java.util.concurrent.CompletionStage<WSResponse> delete()
```
    Perform a DELETE on the request asynchronously.
    
    Specified by:
    
    delete in interface play.libs.ws.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 play.libs.ws.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 play.libs.ws.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 play.libs.ws.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 play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    a promise to the response
  - stream
```
java.util.concurrent.CompletionStage<WSResponse> stream()
```
    Execute this request and stream the response body.
    
    Specified by:
    
    stream in interface play.libs.ws.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 play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    method - the HTTP method.
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
WSRequest setBody(play.libs.ws.BodyWritable body)
```
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
WSRequest setBody(java.lang.String body)
```
    Set the body this request should use.
    
    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.
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
@Deprecated
WSRequest setBody(java.io.InputStream body)
```
    Deprecated. use setBody(BodyWritable)
    
    Set the body this request should use.
    
    Parameters:
    
    body - Deprecated
    
    Returns:
    
    Deprecated
  - setBody
```
WSRequest setBody(java.io.File body)
```
    Set the body this request should use.
    
    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.
    
    Parameters:
    
    body - the body of the request.
    
    Returns:
    
    the modified WSRequest.
  - addHeader
```
WSRequest addHeader(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:
    
    addHeader in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    the modified WSRequest.
  - setHeader
```
@Deprecated
WSRequest setHeader(java.lang.String name,
                                java.lang.String value)
```
    Deprecated. use addHeader(String, String)
    
    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.
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    the modified WSRequest.
  - setHeaders
```
WSRequest setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)
```
    Sets all of the headers on the request.
    
    Specified by:
    
    setHeaders in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    headers - the headers
    
    Returns:
    
    the modified WSRequest.
  - setQueryString
```
WSRequest setQueryString(java.lang.String query)
```
    Sets the query string to query.
    
    Specified by:
    
    setQueryString in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    query - the fully formed query string
    
    Returns:
    
    the modified WSRequest.
  - setQueryString
```
WSRequest setQueryString(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params)
```
    Sets the query string to query.
    
    Specified by:
    
    setQueryString in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    params - the query string parameters
    
    Returns:
    
    the modified WSRequest.
  - addQueryParameter
```
WSRequest addQueryParameter(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:
    
    addQueryParameter in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    name - the query parameter name
    
    value - the query parameter value
    
    Returns:
    
    the modified WSRequest.
  - setQueryParameter
```
@Deprecated
WSRequest setQueryParameter(java.lang.String name,
                                        java.lang.String value)
```
    Deprecated. use addQueryParameter(String, String)
    
    Sets a query parameter with the given name, this can be called repeatedly. Duplicate query parameters are allowed.
    
    Parameters:
    
    name - the query parameter name
    
    value - the query parameter value
    
    Returns:
    
    the modified WSRequest.
  - addCookie
```
WSRequest addCookie(play.libs.ws.WSCookie cookie)
```
    Adds a cookie to the request
    
    Specified by:
    
    addCookie in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    cookie - the cookie to add.
    
    Returns:
    
    the modified request
  - addCookie
```
WSRequest addCookie(Http.Cookie cookie)
```
    Adds a cookie to the request
    
    Parameters:
    
    cookie - the cookie to add.
    
    Returns:
    
    the modified request
  - addCookies
```
WSRequest addCookies(play.libs.ws.WSCookie... cookies)
```
    Sets several cookies on the request.
    
    Specified by:
    
    addCookies in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    cookies - the cookies.
    
    Returns:
    
    the modified request
  - setCookies
```
WSRequest setCookies(java.util.List<play.libs.ws.WSCookie> cookies)
```
    Sets all the cookies on the request.
    
    Specified by:
    
    setCookies in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    cookies - all the cookies.
    
    Returns:
    
    the modified request
  - setAuth
```
WSRequest setAuth(java.lang.String userInfo)
```
    Sets the authentication header for the current request using BASIC authentication.
    
    Specified by:
    
    setAuth in interface play.libs.ws.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 play.libs.ws.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,
                  play.libs.ws.WSAuthScheme scheme)
```
    Sets the authentication header for the current request.
    
    Specified by:
    
    setAuth in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    username - the username
    
    password - the password
    
    scheme - authentication scheme
    
    Returns:
    
    the modified WSRequest.
  - sign
```
WSRequest sign(play.libs.ws.WSSignatureCalculator calculator)
```
    Sets an (OAuth) signature calculator.
    
    Specified by:
    
    sign in interface play.libs.ws.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 play.libs.ws.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 play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    virtualHost - the virtual host
    
    Returns:
    
    the modified WSRequest
  - setRequestTimeout
```
WSRequest setRequestTimeout(java.time.Duration timeout)
```
    Sets the request timeout in milliseconds.
    
    Specified by:
    
    setRequestTimeout in interface play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    timeout - the request timeout in milliseconds. A value of -1 indicates an infinite request timeout.
    
    Returns:
    
    the modified WSRequest.
  - setRequestTimeout
```
@Deprecated
WSRequest setRequestTimeout(long timeout)
```
    Deprecated. use setRequestTimeout(Duration)
    
    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.
  - setRequestFilter
```
WSRequest setRequestFilter(play.libs.ws.WSRequestFilter filter)
```
    Adds a request filter.
    
    Specified by:
    
    setRequestFilter in interface play.libs.ws.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 play.libs.ws.StandaloneWSRequest
    
    Parameters:
    
    contentType - The content type
    
    Returns:
    
    the modified WSRequest
  - getUrl
```
java.lang.String getUrl()
```
    Specified by:
    
    getUrl in interface play.libs.ws.StandaloneWSRequest
    
    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.List<java.lang.String>> getHeaders()
```
    Specified by:
    
    getHeaders in interface play.libs.ws.StandaloneWSRequest
    
    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.List<java.lang.String>> getQueryParameters()
```
    Specified by:
    
    getQueryParameters in interface play.libs.ws.StandaloneWSRequest
    
    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()
```
    Specified by:
    
    getUsername in interface play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    the auth username, null if not an authenticated request.
  - getPassword
```
java.lang.String getPassword()
```
    Specified by:
    
    getPassword in interface play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    the auth password, null if not an authenticated request
  - getScheme
```
play.libs.ws.WSAuthScheme getScheme()
```
    Specified by:
    
    getScheme in interface play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    the auth scheme, null if not an authenticated request.
  - getCalculator
```
play.libs.ws.WSSignatureCalculator getCalculator()
```
    Specified by:
    
    getCalculator in interface play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    the signature calculator (example: OAuth), null if none is set.
  - getRequestTimeoutDuration
```
java.time.Duration getRequestTimeoutDuration()
```
    Deprecated. use getRequestTimeoutDuration()
    
    Gets the original request timeout.
    
    Specified by:
    
    getRequestTimeoutDuration in interface play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    the timeout
  - getRequestTimeout
```
@Deprecated
long getRequestTimeout()
```
    Deprecated. use getRequestTimeoutDuration()
    
    Gets the original request timeout in milliseconds, passed into the request as input.
    
    Returns:
    
    the timeout
  - getFollowRedirects
```
boolean getFollowRedirects()
```
    If the setFollowRedirects(boolean) method has been called, then returns true.
    
    Specified by:
    
    getFollowRedirects in interface play.libs.ws.StandaloneWSRequest
    
    Returns:
    
    true if the request is configured to follow redirect, false otherwise.

Interface WSRequest

Method Summary

Methods inherited from interface play.libs.ws.StandaloneWSRequest

Method Detail

get

patch

patch

patch

patch

patch

patch

patch

post

post

post

post

post

post

post

put

put

put

put

put

put

put

delete

head

options

execute

execute

stream

setMethod

setBody

setBody

setBody

setBody

setBody

setBody

addHeader

setHeader

setHeaders

setQueryString

setQueryString

addQueryParameter

setQueryParameter

addCookie

addCookie

addCookies

setCookies

setAuth

setAuth

setAuth

sign

setFollowRedirects

setVirtualHost

setRequestTimeout

setRequestTimeout

setRequestFilter

setContentType

getUrl

getHeaders

getQueryParameters

getUsername

getPassword

getScheme

getCalculator

getRequestTimeoutDuration

getRequestTimeout

getFollowRedirects