c

play.api.libs.ws.ahc

AhcWSRequest

case class AhcWSRequest(underlying: StandaloneAhcWSRequest) extends WSRequest with WSBodyWritables with Product with Serializable

A WS Request backed by AsyncHTTPClient.

Source
AhcWSRequest.scala
Linear Supertypes
Serializable, Product, Equals, WSRequest, WSBodyWritables, XMLBodyWritables, JsonBodyWritables, DefaultBodyWritables, StandaloneWSRequest, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AhcWSRequest
  2. Serializable
  3. Product
  4. Equals
  5. WSRequest
  6. WSBodyWritables
  7. XMLBodyWritables
  8. JsonBodyWritables
  9. DefaultBodyWritables
  10. StandaloneWSRequest
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AhcWSRequest(underlying: StandaloneAhcWSRequest)

Type Members

  1. type Response = WSResponse
    Definition Classes
    → WSRequest → StandaloneWSRequest
  2. type Self = WSRequest
    Definition Classes
    → WSRequest → StandaloneWSRequest

Value Members

  1. def addCookies(cookies: WSCookie*): Self

    Returns this request with the given cookies, preserving the existing ones.

    Returns this request with the given cookies, preserving the existing ones.

    cookies

    the cookies to be used

    Definition Classes
    → WSRequest → StandaloneWSRequest
  2. def addHttpHeaders(hdrs: (String, String)*): Self
    Definition Classes
    StandaloneWSRequest
  3. def addQueryStringParameters(parameters: (String, String)*): Self
    Definition Classes
    StandaloneWSRequest
  4. def auth: Option[(String, String, WSAuthScheme)]

    The authentication this request should use

    The authentication this request should use

    Definition Classes
    → WSRequest → StandaloneWSRequest
  5. def body: WSBody

    The body of this request

    The body of this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  6. def body(objectMapper: ObjectMapper): BodyWritable[JsonNode]
    Definition Classes
    JsonBodyWritables
  7. implicit val bodyWritableOf_Multipart: BodyWritable[Source[Part[Source[ByteString, _]], _]]
    Definition Classes
    WSBodyWritables
  8. def calc: Option[WSSignatureCalculator]

    A calculator of the signature for this request

    A calculator of the signature for this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  9. def contentType: Option[String]
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  10. def cookies: Seq[WSCookie]

    The cookies for this request

    The cookies for this request

    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  11. def delete(): Future[Response]

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

    Definition Classes
    → WSRequest → StandaloneWSRequest
  12. def execute(): Future[Response]

    Execute this request

    Execute this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  13. def execute(method: String): Future[Response]

    Executes the given HTTP method.

    Executes the given HTTP method.

    method

    the HTTP method that will be executed

    returns

    a future with the response for this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  14. def followRedirects: Option[Boolean]

    Whether this request should follow redirects

    Whether this request should follow redirects

    Definition Classes
    → WSRequest → StandaloneWSRequest
  15. def get(): Future[Response]

    performs a get

    performs a get

    Definition Classes
    → WSRequest → StandaloneWSRequest
  16. def head(): Future[Response]

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    → WSRequest → StandaloneWSRequest
  17. def header(name: String): Option[String]
    Definition Classes
    StandaloneWSRequest
  18. def headerValues(name: String): Seq[String]
    Definition Classes
    StandaloneWSRequest
  19. def headers: Map[String, Seq[String]]

    The headers for this request

    The headers for this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  20. def method: String

    The method for this request

    The method for this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  21. def options(): Future[Response]

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

    Definition Classes
    → WSRequest → StandaloneWSRequest
  22. def patch[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously.

    body

    the payload wsBody submitted with this request

    returns

    a future with the response for the PATCH request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  23. def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    body

    the payload wsBody submitted with this request

    returns

    a future with the response for the POST request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def proxyServer: Option[WSProxyServer]

    The proxy server this request will use

    The proxy server this request will use

    Definition Classes
    → WSRequest → StandaloneWSRequest
  26. def put[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously.

    body

    the payload wsBody submitted with this request

    returns

    a future with the response for the PUT request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  27. def queryString: Map[String, Seq[String]]

    The query string for this request

    The query string for this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  28. def requestTimeout: Option[Duration]

    The timeout for the request

    The timeout for the request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  29. def sign(calc: WSSignatureCalculator): Self

    sets the signature calculator for the request

    sets the signature calculator for the request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  30. def stream(): Future[Response]
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  31. val underlying: StandaloneAhcWSRequest
  32. def uri: URI

    The URI for this request

    The URI for this request

    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  33. def url: String

    The base URL for this request

    The base URL for this request

    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  34. def virtualHost: Option[String]

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    → WSRequest → StandaloneWSRequest
  35. def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

    sets the authentication realm

    sets the authentication realm

    Definition Classes
    → WSRequest → StandaloneWSRequest
  36. def withBody[T](body: T)(implicit arg0: BodyWritable[T]): Self

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  37. def withCookies(cookies: WSCookie*): Self

    Returns this request with the given cookies, discarding the existing ones.

    Returns this request with the given cookies, discarding the existing ones.

    Definition Classes
    → WSRequest → StandaloneWSRequest
  38. def withDisableUrlEncoding(disableUrlEncoding: Boolean): Self
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  39. def withFollowRedirects(follow: Boolean): Self

    Sets whether redirects (301, 302) should be followed automatically

    Sets whether redirects (301, 302) should be followed automatically

    Definition Classes
    → WSRequest → StandaloneWSRequest
  40. def withHttpHeaders(headers: (String, String)*): Self

    Returns this request with the given headers, discarding the existing ones.

    Returns this request with the given headers, discarding the existing ones.

    headers

    the headers to be used

    Definition Classes
    → WSRequest → StandaloneWSRequest
  41. def withMethod(method: String): Self

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  42. def withProxyServer(proxyServer: WSProxyServer): Self

    Sets the proxy server to use in this request

    Sets the proxy server to use in this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  43. def withQueryStringParameters(parameters: (String, String)*): Self

    Returns this request with the given query string parameters, discarding the existing ones.

    Returns this request with the given query string parameters, discarding the existing ones.

    parameters

    the query string parameters

    Definition Classes
    → WSRequest → StandaloneWSRequest
  44. def withRequestFilter(filter: WSRequestFilter): Self

    Adds a filter to the request that can transform the request for subsequent filters.

    Adds a filter to the request that can transform the request for subsequent filters.

    Definition Classes
    → WSRequest → StandaloneWSRequest
  45. def withRequestTimeout(timeout: Duration): Self

    Sets the maximum time you expect the request to take.

    Sets the maximum time you expect the request to take. Use Duration.Inf to set an infinite request timeout. Warning: a stream consumption will be interrupted when this time is reached unless Duration.Inf is set.

    Definition Classes
    → WSRequest → StandaloneWSRequest
  46. def withUrl(url: String): WSRequest
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  47. def withVirtualHost(vh: String): Self

    Sets the virtual host to use in this request

    Sets the virtual host to use in this request

    Definition Classes
    → WSRequest → StandaloneWSRequest
  48. implicit val writableOf_File: BodyWritable[File]
    Definition Classes
    DefaultBodyWritables
  49. implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]
    Definition Classes
    DefaultBodyWritables
  50. implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]
    Definition Classes
    DefaultBodyWritables
  51. implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]
    Definition Classes
    DefaultBodyWritables
  52. implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]
    Definition Classes
    DefaultBodyWritables
  53. implicit val writeableOf_Bytes: BodyWritable[ByteString]
    Definition Classes
    DefaultBodyWritables
  54. implicit val writeableOf_Document: BodyWritable[Document]
    Definition Classes
    XMLBodyWritables
  55. implicit val writeableOf_JsValue: BodyWritable[JsValue]
    Definition Classes
    JsonBodyWritables
  56. implicit val writeableOf_NodeBuffer: BodyWritable[NodeBuffer]
    Definition Classes
    XMLBodyWritables
  57. implicit def writeableOf_NodeSeq[C <: NodeSeq]: BodyWritable[C]
    Definition Classes
    XMLBodyWritables
  58. implicit val writeableOf_String: BodyWritable[String]
    Definition Classes
    DefaultBodyWritables
  59. implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]
    Definition Classes
    DefaultBodyWritables
  60. implicit val writeableOf_WsBody: BodyWritable[WSBody]
    Definition Classes
    DefaultBodyWritables
  61. implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]
    Definition Classes
    DefaultBodyWritables
  62. implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]
    Definition Classes
    DefaultBodyWritables

Deprecated Value Members

  1. def patch(body: Source[Part[Source[ByteString, _]], _]): Future[WSResponse]

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously.

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use patch(bodyWritable)

  2. def patch(body: File): Future[WSResponse]

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously. Request body won't be chunked

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use patch(bodyWritable)

  3. def post(body: Source[Part[Source[ByteString, _]], _]): Future[WSResponse]

    Performs a POST on the request asynchronously.

    Performs a POST on the request asynchronously.

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use post(BodyWritable)

  4. def post(body: File): Future[WSResponse]

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use post(BodyWritable)

  5. def put(body: Source[Part[Source[ByteString, _]], _]): Future[WSResponse]

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously.

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use put(BodyWritable)

  6. def put(body: File): Future[WSResponse]

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously. Request body won't be chunked

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use put(BodyWritable)

  7. def withHeaders(hdrs: (String, String)*): Self

    Returns this request with the given headers, adding to the existing ones.

    Returns this request with the given headers, adding to the existing ones.

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use addHttpHeaders or withHttpHeaders

  8. def withQueryString(parameters: (String, String)*): Self

    Returns this request with the given query string parameters, adding to the existing ones.

    Returns this request with the given query string parameters, adding to the existing ones.

    parameters

    the query string parameters

    Definition Classes
    → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use addQueryStringParameters or withQueryStringParameters