Packages

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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  2. type Self = WSRequest
    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  5. def addHttpHeaders(hdrs: (String, String)*): Self
    Definition Classes
    StandaloneWSRequest
  6. def addQueryStringParameters(parameters: (String, String)*): Self
    Definition Classes
    StandaloneWSRequest
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def auth: Option[(String, String, WSAuthScheme)]

    The authentication this request should use

    The authentication this request should use

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  9. def body: WSBody

    The body of this request

    The body of this request

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

    A calculator of the signature for this request

    A calculator of the signature for this request

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  14. def contentType: Option[String]
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  15. def cookies: Seq[WSCookie]

    The cookies for this request

    The cookies for this request

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

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def execute(): Future[Response]

    Execute this request

    Execute this request

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  19. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  20. def followRedirects: Option[Boolean]

    Whether this request should follow redirects

    Whether this request should follow redirects

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

    performs a get

    performs a get

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def head(): Future[Response]

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  24. def header(name: String): Option[String]
    Definition Classes
    StandaloneWSRequest
  25. def headerValues(name: String): Seq[String]
    Definition Classes
    StandaloneWSRequest
  26. def headers: Map[String, Seq[String]]

    The headers for this request

    The headers for this request

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def method: String

    The method for this request

    The method for this request

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. def options(): Future[Response]

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  33. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  34. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  35. def productElementNames: Iterator[String]
    Definition Classes
    Product
  36. def proxyServer: Option[WSProxyServer]

    The proxy server this request will use

    The proxy server this request will use

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  37. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  38. def queryString: Map[String, Seq[String]]

    The query string for this request

    The query string for this request

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

    The timeout for the request

    The timeout for the request

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

    sets the signature calculator for the request

    sets the signature calculator for the request

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  41. def stream(): Future[Response]
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. val underlying: StandaloneAhcWSRequest
  44. def uri: URI

    The URI for this request

    The URI for this request

    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  45. def url: String

    The base URL for this request

    The base URL for this request

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

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

    sets the authentication realm

    sets the authentication realm

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

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  52. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  53. def withDisableUrlEncoding(disableUrlEncoding: Boolean): Self
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  54. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  55. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  56. def withMethod(method: String): Self

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    AhcWSRequest → WSRequest → StandaloneWSRequest
  57. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  58. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  59. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  60. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  61. def withUrl(url: String): WSRequest
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  62. 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
    AhcWSRequest → WSRequest → StandaloneWSRequest
  63. implicit val writableOf_File: BodyWritable[File]
    Definition Classes
    DefaultBodyWritables
  64. implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]
    Definition Classes
    DefaultBodyWritables
  65. implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]
    Definition Classes
    DefaultBodyWritables
  66. implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]
    Definition Classes
    DefaultBodyWritables
  67. implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]
    Definition Classes
    DefaultBodyWritables
  68. implicit val writeableOf_Bytes: BodyWritable[ByteString]
    Definition Classes
    DefaultBodyWritables
  69. implicit val writeableOf_Document: BodyWritable[Document]
    Definition Classes
    XMLBodyWritables
  70. implicit val writeableOf_JsValue: BodyWritable[JsValue]
    Definition Classes
    JsonBodyWritables
  71. implicit val writeableOf_NodeBuffer: BodyWritable[NodeBuffer]
    Definition Classes
    XMLBodyWritables
  72. implicit def writeableOf_NodeSeq[C <: NodeSeq]: BodyWritable[C]
    Definition Classes
    XMLBodyWritables
  73. implicit val writeableOf_String: BodyWritable[String]
    Definition Classes
    DefaultBodyWritables
  74. implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]
    Definition Classes
    DefaultBodyWritables
  75. implicit val writeableOf_WsBody: BodyWritable[WSBody]
    Definition Classes
    DefaultBodyWritables
  76. implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]
    Definition Classes
    DefaultBodyWritables
  77. implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]
    Definition Classes
    DefaultBodyWritables

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. 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
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use patch(bodyWritable)

  3. 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
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use patch(bodyWritable)

  4. 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
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use post(BodyWritable)

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

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    Definition Classes
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use post(BodyWritable)

  6. 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
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use put(BodyWritable)

  7. 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
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use put(BodyWritable)

  8. 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
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use addHttpHeaders or withHttpHeaders

  9. 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
    AhcWSRequest → WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use addQueryStringParameters or withQueryStringParameters

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WSRequest

Inherited from WSBodyWritables

Inherited from XMLBodyWritables

Inherited from JsonBodyWritables

Inherited from DefaultBodyWritables

Inherited from StandaloneWSRequest

Inherited from AnyRef

Inherited from Any

Ungrouped