AhcWSRequest (Play 2.5.0)

java.lang.Object
- play.libs.ws.ahc.AhcWSRequest

All Implemented Interfaces:

WSRequest
```
public class AhcWSRequest
extends java.lang.Object
implements WSRequest
```
provides the User facing API for building WS request.

Constructor Summary

Constructors
Constructor and Description

AhcWSRequest(AhcWSClient client, java.lang.String url, akka.stream.Materializer materializer)

Constructors
Constructor and Description
`AhcWSRequest(AhcWSClient client, java.lang.String url, akka.stream.Materializer materializer)`

Method Summary

All Methods Instance Methods Concrete 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.
`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()`
`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(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(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(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(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(akka.stream.javadsl.Source<akka.util.ByteString,?> 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.
`AhcWSRequest`	`setHeader(java.lang.String name, java.lang.String value)` Sets a header with the given name, this can be called repeatedly.
`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 a query string
`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<StreamedResponse>`	`stream()` Execute this request and stream the response body.
`WSRequest`	`withRequestFilter(WSRequestFilter filter)` Adds a request filter.

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

- Constructor Detail
  - AhcWSRequest
```
public AhcWSRequest(AhcWSClient client,
                    java.lang.String url,
                    akka.stream.Materializer materializer)
```
- Method Detail
  - setHeader
```
public AhcWSRequest setHeader(java.lang.String name,
                              java.lang.String value)
```
    Sets a header with the given name, this can be called repeatedly.
    
    Specified by:
    
    setHeader in interface WSRequest
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    the receiving WSRequest, with the new header set.
  - setQueryString
```
public WSRequest setQueryString(java.lang.String query)
```
    Sets a query string
    
    Specified by:
    
    setQueryString in interface WSRequest
    
    Parameters:
    
    query -
    
    Returns:
    
    the modified WSRequest.
  - setQueryParameter
```
public WSRequest setQueryParameter(java.lang.String name,
                                   java.lang.String value)
```
    Description copied from interface: WSRequest
    
    Sets a query parameter with the given name, this can be called repeatedly. Duplicate query parameters are allowed.
    
    Specified by:
    
    setQueryParameter in interface WSRequest
    
    Parameters:
    
    name - the query parameter name
    
    value - the query parameter value
    
    Returns:
    
    the modified WSRequest.
  - setAuth
```
public WSRequest setAuth(java.lang.String userInfo)
```
    Description copied from interface: WSRequest
    
    Sets the authentication header for the current request using BASIC authentication.
    
    Specified by:
    
    setAuth in interface WSRequest
    
    Parameters:
    
    userInfo - a string formed as "username:password".
    
    Returns:
    
    the modified WSRequest.
  - setAuth
```
public WSRequest setAuth(java.lang.String username,
                         java.lang.String password)
```
    Description copied from interface: WSRequest
    
    Sets the authentication header for the current request using BASIC authentication.
    
    Specified by:
    
    setAuth in interface WSRequest
    
    Parameters:
    
    username - the basic auth username
    
    password - the basic auth password
  - setAuth
```
public WSRequest setAuth(java.lang.String username,
                         java.lang.String password,
                         WSAuthScheme scheme)
```
    Description copied from interface: WSRequest
    
    Sets the authentication header for the current request.
    
    Specified by:
    
    setAuth in interface WSRequest
    
    Parameters:
    
    username - the username
    
    password - the password
    
    scheme - authentication scheme
  - sign
```
public WSRequest sign(WSSignatureCalculator calculator)
```
    Description copied from interface: WSRequest
    
    Sets an (OAuth) signature calculator.
    
    Specified by:
    
    sign in interface WSRequest
    
    Parameters:
    
    calculator - the signature calculator
    
    Returns:
    
    the modified WSRequest
  - setFollowRedirects
```
public WSRequest setFollowRedirects(java.lang.Boolean followRedirects)
```
    Description copied from interface: WSRequest
    
    Sets whether redirects (301, 302) should be followed automatically.
    
    Specified by:
    
    setFollowRedirects in interface WSRequest
    
    Parameters:
    
    followRedirects - true if the request should follow redirects
    
    Returns:
    
    the modified WSRequest
  - setVirtualHost
```
public WSRequest setVirtualHost(java.lang.String virtualHost)
```
    Description copied from interface: WSRequest
    
    Sets the virtual host as a "hostname:port" string.
    
    Specified by:
    
    setVirtualHost in interface WSRequest
    
    Parameters:
    
    virtualHost - the virtual host
    
    Returns:
    
    the modified WSRequest
  - setRequestTimeout
```
public WSRequest setRequestTimeout(long timeout)
```
    Description copied from interface: WSRequest
    
    Sets the request timeout in milliseconds.
    
    Specified by:
    
    setRequestTimeout in interface WSRequest
    
    Parameters:
    
    timeout - the request timeout in milliseconds. A value of -1 indicates an infinite request timeout.
    
    Returns:
    
    the modified WSRequest.
  - setContentType
```
public WSRequest setContentType(java.lang.String contentType)
```
    Description copied from interface: WSRequest
    
    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 WSRequest
    
    Parameters:
    
    contentType - The content type
    
    Returns:
    
    the modified WSRequest
  - setMethod
```
public WSRequest setMethod(java.lang.String method)
```
    Description copied from interface: WSRequest
    
    Set the HTTP method this request should use, where the no args execute() method is invoked.
    
    Specified by:
    
    setMethod in interface WSRequest
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
public WSRequest setBody(java.lang.String body)
```
    Description copied from interface: WSRequest
    
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface WSRequest
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
public WSRequest setBody(com.fasterxml.jackson.databind.JsonNode body)
```
    Description copied from interface: WSRequest
    
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface WSRequest
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
public WSRequest setBody(java.io.InputStream body)
```
    Description copied from interface: WSRequest
    
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface WSRequest
    
    Parameters:
    
    body - Deprecated
    
    Returns:
    
    Deprecated
  - setBody
```
public WSRequest setBody(java.io.File body)
```
    Description copied from interface: WSRequest
    
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface WSRequest
    
    Returns:
    
    the modified WSRequest.
  - setBody
```
public WSRequest setBody(akka.stream.javadsl.Source<akka.util.ByteString,?> body)
```
    Description copied from interface: WSRequest
    
    Set the body this request should use.
    
    Specified by:
    
    setBody in interface WSRequest
  - getUrl
```
public java.lang.String getUrl()
```
    Specified by:
    
    getUrl in interface WSRequest
    
    Returns:
    
    the URL of the request. This has not passed through an internal request builder and so will not be signed.
  - getHeaders
```
public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getHeaders()
```
    Specified by:
    
    getHeaders in interface WSRequest
    
    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
```
public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getQueryParameters()
```
    Specified by:
    
    getQueryParameters in interface WSRequest
    
    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
```
public java.lang.String getUsername()
```
    Specified by:
    
    getUsername in interface WSRequest
    
    Returns:
    
    the auth username, null if not an authenticated request.
  - getPassword
```
public java.lang.String getPassword()
```
    Specified by:
    
    getPassword in interface WSRequest
    
    Returns:
    
    the auth password, null if not an authenticated request
  - getScheme
```
public WSAuthScheme getScheme()
```
    Specified by:
    
    getScheme in interface WSRequest
    
    Returns:
    
    the auth scheme, null if not an authenticated request.
  - getCalculator
```
public WSSignatureCalculator getCalculator()
```
    Specified by:
    
    getCalculator in interface WSRequest
    
    Returns:
    
    the signature calculator (example: OAuth), null if none is set.
  - getRequestTimeout
```
public long getRequestTimeout()
```
    Description copied from interface: WSRequest
    
    Gets the original request timeout in milliseconds, passed into the request as input.
    
    Specified by:
    
    getRequestTimeout in interface WSRequest
    
    Returns:
    
    the timeout
  - getFollowRedirects
```
public java.lang.Boolean getFollowRedirects()
```
    Specified by:
    
    getFollowRedirects in interface WSRequest
    
    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.
  - get
```
public java.util.concurrent.CompletionStage<WSResponse> get()
```
    Description copied from interface: WSRequest
    
    Perform a GET on the request asynchronously.
    
    Specified by:
    
    get in interface WSRequest
    
    Returns:
    
    a promise to the response
  - patch
```
public java.util.concurrent.CompletionStage<WSResponse> patch(java.lang.String body)
```
    Description copied from interface: WSRequest
    
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface WSRequest
    
    Parameters:
    
    body - represented as String
    
    Returns:
    
    a promise to the response
  - patch
```
public java.util.concurrent.CompletionStage<WSResponse> patch(com.fasterxml.jackson.databind.JsonNode body)
```
    Description copied from interface: WSRequest
    
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface WSRequest
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - patch
```
public java.util.concurrent.CompletionStage<WSResponse> patch(java.io.InputStream body)
```
    Description copied from interface: WSRequest
    
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface WSRequest
    
    Parameters:
    
    body - represented as an InputStream
    
    Returns:
    
    a promise to the response
  - patch
```
public java.util.concurrent.CompletionStage<WSResponse> patch(java.io.File body)
```
    Description copied from interface: WSRequest
    
    Perform a PATCH on the request asynchronously.
    
    Specified by:
    
    patch in interface WSRequest
    
    Parameters:
    
    body - represented as a File
    
    Returns:
    
    a promise to the response
  - post
```
public java.util.concurrent.CompletionStage<WSResponse> post(java.lang.String body)
```
    Description copied from interface: WSRequest
    
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface WSRequest
    
    Parameters:
    
    body - represented as String
    
    Returns:
    
    a promise to the response
  - post
```
public java.util.concurrent.CompletionStage<WSResponse> post(com.fasterxml.jackson.databind.JsonNode body)
```
    Description copied from interface: WSRequest
    
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface WSRequest
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - post
```
public java.util.concurrent.CompletionStage<WSResponse> post(java.io.InputStream body)
```
    Description copied from interface: WSRequest
    
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface WSRequest
    
    Parameters:
    
    body - represented as an InputStream
    
    Returns:
    
    a promise to the response
  - post
```
public java.util.concurrent.CompletionStage<WSResponse> post(java.io.File body)
```
    Description copied from interface: WSRequest
    
    Perform a POST on the request asynchronously.
    
    Specified by:
    
    post in interface WSRequest
    
    Parameters:
    
    body - represented as a File
    
    Returns:
    
    a promise to the response
  - put
```
public java.util.concurrent.CompletionStage<WSResponse> put(java.lang.String body)
```
    Description copied from interface: WSRequest
    
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface WSRequest
    
    Parameters:
    
    body - represented as String
    
    Returns:
    
    a promise to the response
  - put
```
public java.util.concurrent.CompletionStage<WSResponse> put(com.fasterxml.jackson.databind.JsonNode body)
```
    Description copied from interface: WSRequest
    
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface WSRequest
    
    Parameters:
    
    body - represented as JSON
    
    Returns:
    
    a promise to the response
  - put
```
public java.util.concurrent.CompletionStage<WSResponse> put(java.io.InputStream body)
```
    Description copied from interface: WSRequest
    
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface WSRequest
    
    Parameters:
    
    body - represented as an InputStream
    
    Returns:
    
    a promise to the response
  - put
```
public java.util.concurrent.CompletionStage<WSResponse> put(java.io.File body)
```
    Description copied from interface: WSRequest
    
    Perform a PUT on the request asynchronously.
    
    Specified by:
    
    put in interface WSRequest
    
    Parameters:
    
    body - represented as a File
    
    Returns:
    
    a promise to the response
  - delete
```
public java.util.concurrent.CompletionStage<WSResponse> delete()
```
    Description copied from interface: WSRequest
    
    Perform a DELETE on the request asynchronously.
    
    Specified by:
    
    delete in interface WSRequest
    
    Returns:
    
    a promise to the response
  - head
```
public java.util.concurrent.CompletionStage<WSResponse> head()
```
    Description copied from interface: WSRequest
    
    Perform a HEAD on the request asynchronously.
    
    Specified by:
    
    head in interface WSRequest
    
    Returns:
    
    a promise to the response
  - options
```
public java.util.concurrent.CompletionStage<WSResponse> options()
```
    Description copied from interface: WSRequest
    
    Perform an OPTIONS on the request asynchronously.
    
    Specified by:
    
    options in interface WSRequest
    
    Returns:
    
    a promise to the response
  - execute
```
public java.util.concurrent.CompletionStage<WSResponse> execute(java.lang.String method)
```
    Description copied from interface: WSRequest
    
    Execute an arbitrary method on the request asynchronously.
    
    Specified by:
    
    execute in interface WSRequest
    
    Parameters:
    
    method - The method to execute
    
    Returns:
    
    a promise to the response
  - execute
```
public java.util.concurrent.CompletionStage<WSResponse> execute()
```
    Description copied from interface: WSRequest
    
    Execute an arbitrary method on the request asynchronously. Should be used with setMethod().
    
    Specified by:
    
    execute in interface WSRequest
    
    Returns:
    
    a promise to the response
  - stream
```
public java.util.concurrent.CompletionStage<StreamedResponse> stream()
```
    Description copied from interface: WSRequest
    
    Execute this request and stream the response body.
    
    Specified by:
    
    stream in interface WSRequest
    
    Returns:
    
    a promise to the streaming response
  - withRequestFilter
```
public WSRequest withRequestFilter(WSRequestFilter filter)
```
    Description copied from interface: WSRequest
    
    Adds a request filter.
    
    Specified by:
    
    withRequestFilter in interface WSRequest
    
    Parameters:
    
    filter - a tranforming filter.
    
    Returns:
    
    the modified request.

Class AhcWSRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AhcWSRequest

Method Detail

setHeader

setQueryString

setQueryParameter

setAuth

setAuth

setAuth

sign

setFollowRedirects

setVirtualHost

setRequestTimeout

setContentType

setMethod

setBody

setBody

setBody

setBody

setBody

getUrl

getHeaders

getQueryParameters

getUsername

getPassword

getScheme

getCalculator

getRequestTimeout

getFollowRedirects

get

patch

patch

patch

patch

post

post

post

post

put

put

put

put

delete

head

options

execute

execute

stream

withRequestFilter