Class

play.api.libs.ws.ahc

AhcWSRequest

Related Doc: package ahc

Permalink

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, Serializable, Product, Equals, WSRequest, WSBodyWritables, XMLBodyWritables, JsonBodyWritables, DefaultBodyWritables, StandaloneWSRequest, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AhcWSRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. WSRequest
  7. WSBodyWritables
  8. XMLBodyWritables
  9. JsonBodyWritables
  10. DefaultBodyWritables
  11. StandaloneWSRequest
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AhcWSRequest(underlying: StandaloneAhcWSRequest)

    Permalink

Type Members

  1. type Response = WSResponse

    Permalink
    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  2. type Self = WSRequest

    Permalink
    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addCookies(cookies: WSCookie*): Self

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  5. def addHttpHeaders(hdrs: (String, String)*): Self

    Permalink
    Definition Classes
    StandaloneWSRequest
  6. def addQueryStringParameters(parameters: (String, String)*): Self

    Permalink
    Definition Classes
    StandaloneWSRequest
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def auth: Option[(String, String, WSAuthScheme)]

    Permalink

    The authentication this request should use

    The authentication this request should use

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  9. def body: WSBody

    Permalink

    The body of this request

    The body of this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  10. def body(objectMapper: ObjectMapper): BodyWritable[JsonNode]

    Permalink
    Definition Classes
    JsonBodyWritables
  11. implicit val bodyWritableOf_Multipart: BodyWritable[Source[Part[Source[ByteString, _]], _]]

    Permalink
    Definition Classes
    WSBodyWritables
  12. def calc: Option[WSSignatureCalculator]

    Permalink

    A calculator of the signature for this request

    A calculator of the signature for this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def contentType: Option[String]

    Permalink
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  15. def cookies: Seq[WSCookie]

    Permalink

    The cookies for this request

    The cookies for this request

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

    Permalink

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def execute(): Future[Response]

    Permalink

    Execute this request

    Execute this request

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

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def followRedirects: Option[Boolean]

    Permalink

    Whether this request should follow redirects

    Whether this request should follow redirects

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  22. def get(): Future[Response]

    Permalink

    performs a get

    performs a get

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  24. def head(): Future[Response]

    Permalink

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  25. def header(name: String): Option[String]

    Permalink
    Definition Classes
    StandaloneWSRequest
  26. def headerValues(name: String): Seq[String]

    Permalink
    Definition Classes
    StandaloneWSRequest
  27. def headers: Map[String, Seq[String]]

    Permalink

    The headers for this request

    The headers for this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def method: String

    Permalink

    The method for this request

    The method for this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def options(): Future[Response]

    Permalink

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

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

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  35. def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  36. def proxyServer: Option[WSProxyServer]

    Permalink

    The proxy server this request will use

    The proxy server this request will use

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

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  38. def queryString: Map[String, Seq[String]]

    Permalink

    The query string for this request

    The query string for this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  39. def requestTimeout: Option[Int]

    Permalink

    The timeout for the request

    The timeout for the request

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

    Permalink

    sets the signature calculator for the request

    sets the signature calculator for the request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  41. def stream(): Future[Response]

    Permalink
    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  43. val underlying: StandaloneAhcWSRequest

    Permalink
  44. def uri: URI

    Permalink

    The URI for this request

    The URI for this request

    Definition Classes
    AhcWSRequest → StandaloneWSRequest
  45. def url: String

    Permalink

    The base URL for this request

    The base URL for this request

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

    Permalink

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  47. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

    Permalink

    sets the authentication realm

    sets the authentication realm

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

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  52. def withCookies(cookies: WSCookie*): Self

    Permalink

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

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

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  53. def withFollowRedirects(follow: Boolean): Self

    Permalink

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

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

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  54. def withHttpHeaders(headers: (String, String)*): Self

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  55. def withMethod(method: String): Self

    Permalink

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  56. def withProxyServer(proxyServer: WSProxyServer): Self

    Permalink

    Sets the proxy server to use in this request

    Sets the proxy server to use in this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  57. def withQueryStringParameters(parameters: (String, String)*): Self

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  58. def withRequestFilter(filter: WSRequestFilter): Self

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  59. def withRequestTimeout(timeout: Duration): Self

    Permalink

    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
    AhcWSRequestWSRequest → StandaloneWSRequest
  60. def withVirtualHost(vh: String): Self

    Permalink

    Sets the virtual host to use in this request

    Sets the virtual host to use in this request

    Definition Classes
    AhcWSRequestWSRequest → StandaloneWSRequest
  61. implicit val writableOf_File: BodyWritable[File]

    Permalink
    Definition Classes
    DefaultBodyWritables
  62. implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  63. implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  64. implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  65. implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]

    Permalink
    Definition Classes
    DefaultBodyWritables
  66. implicit val writeableOf_Bytes: BodyWritable[ByteString]

    Permalink
    Definition Classes
    DefaultBodyWritables
  67. implicit val writeableOf_Document: BodyWritable[Document]

    Permalink
    Definition Classes
    XMLBodyWritables
  68. implicit val writeableOf_JsValue: BodyWritable[JsValue]

    Permalink
    Definition Classes
    JsonBodyWritables
  69. implicit val writeableOf_NodeBuffer: BodyWritable[NodeBuffer]

    Permalink
    Definition Classes
    XMLBodyWritables
  70. implicit def writeableOf_NodeSeq[C <: NodeSeq]: BodyWritable[C]

    Permalink
    Definition Classes
    XMLBodyWritables
  71. implicit val writeableOf_String: BodyWritable[String]

    Permalink
    Definition Classes
    DefaultBodyWritables
  72. implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]

    Permalink
    Definition Classes
    DefaultBodyWritables
  73. implicit val writeableOf_WsBody: BodyWritable[WSBody]

    Permalink
    Definition Classes
    DefaultBodyWritables
  74. implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  75. implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]

    Permalink
    Definition Classes
    DefaultBodyWritables

Deprecated Value Members

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

    Permalink

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously.

    Definition Classes
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use patch(bodyWritable)

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

    Permalink

    Perform a PATCH on the request asynchronously.

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

    Definition Classes
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use patch(bodyWritable)

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

    Permalink

    Performs a POST on the request asynchronously.

    Performs a POST on the request asynchronously.

    Definition Classes
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use post(BodyWritable)

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

    Permalink

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    Definition Classes
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use post(BodyWritable)

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

    Permalink

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously.

    Definition Classes
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use put(BodyWritable)

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

    Permalink

    Perform a PUT on the request asynchronously.

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

    Definition Classes
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use put(BodyWritable)

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

    Permalink

    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
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use addHttpHeaders or withHttpHeaders

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

    Permalink

    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
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use addQueryStringParameters or withQueryStringParameters

Inherited from Serializable

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