StandaloneWSRequest (Play 2.6.0-M4)

All Known Subinterfaces:

WSRequest

All Known Implementing Classes:

AhcWSRequest, StandaloneAhcWSRequest
```
public interface 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
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`delete()` Perform a DELETE on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`execute()` Execute an arbitrary method on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`execute(java.lang.String method)` Execute an arbitrary method on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`get()` Perform a GET on the request asynchronously.
`WSSignatureCalculator`	`getCalculator()`
`java.lang.String`	`getContentType()`
`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()`
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`head()` Perform a HEAD on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`options()` Perform an OPTIONS on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`patch(java.io.File body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`patch(java.io.InputStream body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`patch(com.fasterxml.jackson.databind.JsonNode body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`patch(java.lang.String body)` Perform a PATCH on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`post(java.io.File body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`post(java.io.InputStream body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`post(com.fasterxml.jackson.databind.JsonNode body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`post(java.lang.String body)` Perform a POST on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`put(java.io.File body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`put(java.io.InputStream body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`put(com.fasterxml.jackson.databind.JsonNode body)` Perform a PUT on the request asynchronously.
`java.util.concurrent.CompletionStage<? extends StandaloneWSResponse>`	`put(java.lang.String body)` Perform a PUT on the request asynchronously.
`StandaloneWSRequest`	`setAuth(java.lang.String userInfo)` Sets the authentication header for the current request using BASIC authentication.
`StandaloneWSRequest`	`setAuth(java.lang.String username, java.lang.String password)` Sets the authentication header for the current request using BASIC authentication.
`StandaloneWSRequest`	`setAuth(java.lang.String username, java.lang.String password, WSAuthScheme scheme)` Sets the authentication header for the current request.
`StandaloneWSRequest`	`setBody(java.io.File body)` Set the body this request should use.
`StandaloneWSRequest`	`setBody(java.io.InputStream body)` Deprecated. use `setBody(Source)` instead.
`StandaloneWSRequest`	`setBody(com.fasterxml.jackson.databind.JsonNode body)` Set the body this request should use.
`<U> StandaloneWSRequest`	`setBody(akka.stream.javadsl.Source<akka.util.ByteString,U> body)` Set the body this request should use.
`StandaloneWSRequest`	`setBody(java.lang.String body)` Set the body this request should use.
`StandaloneWSRequest`	`setContentType(java.lang.String contentType)` Set the content type.
`StandaloneWSRequest`	`setFollowRedirects(boolean followRedirects)` Sets whether redirects (301, 302) should be followed automatically.
`StandaloneWSRequest`	`setHeader(java.lang.String name, java.lang.String value)` Adds a header to the request.
`StandaloneWSRequest`	`setMethod(java.lang.String method)` Sets the HTTP method this request should use, where the no args execute() method is invoked.
`StandaloneWSRequest`	`setQueryParameter(java.lang.String name, java.lang.String value)` Sets a query parameter with the given name, this can be called repeatedly.
`StandaloneWSRequest`	`setQueryString(java.lang.String query)` Sets the query string to query.
`StandaloneWSRequest`	`setRequestFilter(WSRequestFilter filter)` Adds a request filter.
`StandaloneWSRequest`	`setRequestTimeout(long timeout)` Sets the request timeout in milliseconds.
`StandaloneWSRequest`	`setVirtualHost(java.lang.String virtualHost)` Sets the virtual host as a "hostname:port" string.
`StandaloneWSRequest`	`sign(WSSignatureCalculator calculator)` Sets an (OAuth) signature calculator.
`java.util.concurrent.CompletionStage<? extends StreamedResponse>`	`stream()` Execute this request and stream the response body.

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

Interface StandaloneWSRequest

Method Summary

Method Detail

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

getUrl

getHeaders

getQueryParameters

getUsername

getPassword

getScheme

getCalculator

getRequestTimeout

getFollowRedirects

getContentType