Class/Object

play.api.libs.ws.ahc

AhcWSRequest

Related Docs: object AhcWSRequest | package ahc

Permalink

case class AhcWSRequest(client: AhcWSClient, url: String, method: String, body: WSBody, headers: Map[String, Seq[String]], queryString: Map[String, Seq[String]], calc: Option[WSSignatureCalculator], auth: Option[(String, String, WSAuthScheme)], followRedirects: Option[Boolean], requestTimeout: Option[Int], virtualHost: Option[String], proxyServer: Option[WSProxyServer], disableUrlEncoding: Option[Boolean], filters: Seq[WSRequestFilter] = Nil)(implicit materializer: Materializer) extends WSRequest with Product with Serializable

A Ahc WS Request.

Source
AhcWS.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, WSRequest, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AhcWSRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. WSRequest
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AhcWSRequest(client: AhcWSClient, url: String, method: String, body: WSBody, headers: Map[String, Seq[String]], queryString: Map[String, Seq[String]], calc: Option[WSSignatureCalculator], auth: Option[(String, String, WSAuthScheme)], followRedirects: Option[Boolean], requestTimeout: Option[Int], virtualHost: Option[String], proxyServer: Option[WSProxyServer], disableUrlEncoding: Option[Boolean], filters: Seq[WSRequestFilter] = Nil)(implicit materializer: Materializer)

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val auth: Option[(String, String, WSAuthScheme)]

    Permalink

    The authentication this request should use

    The authentication this request should use

    Definition Classes
    AhcWSRequestWSRequest
  6. val body: WSBody

    Permalink

    The body of this request

    The body of this request

    Definition Classes
    AhcWSRequestWSRequest
  7. def buildRequest(): Request

    Permalink

    Creates and returns an AHC request, running all operations on it.

  8. val calc: Option[WSSignatureCalculator]

    Permalink

    A calculator of the signature for this request

    A calculator of the signature for this request

    Definition Classes
    AhcWSRequestWSRequest
  9. val client: AhcWSClient

    Permalink
  10. def clone(): AnyRef

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

    Permalink
  12. def delete(): Future[WSResponse]

    Permalink

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

    Definition Classes
    WSRequest
  13. val disableUrlEncoding: Option[Boolean]

    Permalink
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def execute(): Future[WSResponse]

    Permalink

    Execute this request

    Execute this request

    Definition Classes
    AhcWSRequestWSRequest
  16. def execute(method: String): Future[WSResponse]

    Permalink
    Definition Classes
    WSRequest
  17. def filterWSRequestExecutor(next: WSRequestExecutor): WSRequestExecutor

    Permalink
    Attributes
    protected
  18. val filters: Seq[WSRequestFilter]

    Permalink
  19. def finalize(): Unit

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

    Permalink

    Whether this request should follow redirects

    Whether this request should follow redirects

    Definition Classes
    AhcWSRequestWSRequest
  21. def get(): Future[WSResponse]

    Permalink

    performs a get

    performs a get

    Definition Classes
    WSRequest
  22. def getBody: Option[ByteString]

    Permalink

    Returns the body as an array of bytes.

  23. final def getClass(): Class[_]

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

    Permalink

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    WSRequest
  25. val headers: Map[String, Seq[String]]

    Permalink

    The headers for this request

    The headers for this request

    Definition Classes
    AhcWSRequestWSRequest
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. val method: String

    Permalink

    The method for this request

    The method for this request

    Definition Classes
    AhcWSRequestWSRequest
  28. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  31. def options(): Future[WSResponse]

    Permalink

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

    Definition Classes
    WSRequest
  32. 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
    WSRequest
  33. 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
    WSRequest
  34. def patch[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Permalink

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously.

    Definition Classes
    WSRequest
  35. def post(body: Source[Part[Source[ByteString, _]], _]): Future[WSResponse]

    Permalink

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    Definition Classes
    WSRequest
  36. def post(body: File): Future[WSResponse]

    Permalink

    Perform a POST on the request asynchronously.

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

    Definition Classes
    WSRequest
  37. def post[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Permalink

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    Definition Classes
    WSRequest
  38. val proxyServer: Option[WSProxyServer]

    Permalink

    The proxy server this request will use

    The proxy server this request will use

    Definition Classes
    AhcWSRequestWSRequest
  39. 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
    WSRequest
  40. 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
    WSRequest
  41. def put[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Permalink

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously.

    Definition Classes
    WSRequest
  42. val queryString: Map[String, Seq[String]]

    Permalink

    The query string for this request

    The query string for this request

    Definition Classes
    AhcWSRequestWSRequest
  43. def requestHeader(name: String): Option[String]

    Permalink

    Returns the HTTP header given by name, using the request builder.

    Returns the HTTP header given by name, using the request builder. This may be signed, so may return extra headers that were not directly input.

  44. def requestHeaders: Map[String, Seq[String]]

    Permalink

    Returns the current headers of the request, using the request builder.

    Returns the current headers of the request, using the request builder. This may be signed, so may return extra headers that were not directly input.

  45. def requestQueryParams: Map[String, Seq[String]]

    Permalink

    Returns the current query string parameters, using the request builder.

    Returns the current query string parameters, using the request builder. This may be signed, so may not return the same parameters that were input.

  46. val requestTimeout: Option[Int]

    Permalink

    The timeout for the request

    The timeout for the request

    Definition Classes
    AhcWSRequestWSRequest
  47. def requestUrl: String

    Permalink

    Returns the current URL, using the request builder.

    Returns the current URL, using the request builder. This may be signed by OAuth, as opposed to request.url.

  48. def sign(calc: WSSignatureCalculator): WSRequest

    Permalink

    sets the signature calculator for the request

    sets the signature calculator for the request

    Definition Classes
    AhcWSRequestWSRequest
  49. def stream(): Future[StreamedResponse]

    Permalink

    Execute this request and stream the response body.

    Execute this request and stream the response body.

    Definition Classes
    AhcWSRequestWSRequest
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  51. lazy val uri: URI

    Permalink

    The URI for this request

    The URI for this request

    Definition Classes
    WSRequest
  52. val url: String

    Permalink

    The base URL for this request

    The base URL for this request

    Definition Classes
    AhcWSRequestWSRequest
  53. val virtualHost: Option[String]

    Permalink

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    AhcWSRequestWSRequest
  54. final def wait(): Unit

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

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

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

    Permalink

    sets the authentication realm

    sets the authentication realm

    Definition Classes
    AhcWSRequestWSRequest
  58. def withBody(body: WSBody): WSRequest

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    AhcWSRequestWSRequest
  59. def withBody[T](body: T)(implicit wrt: Writeable[T]): WSRequest

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    WSRequest
  60. def withFollowRedirects(follow: Boolean): WSRequest

    Permalink

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

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

    Definition Classes
    AhcWSRequestWSRequest
  61. def withHeaders(hdrs: (String, String)*): WSRequest

    Permalink

    adds any number of HTTP headers

    adds any number of HTTP headers

    Definition Classes
    AhcWSRequestWSRequest
  62. def withMethod(method: String): WSRequest

    Permalink

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    AhcWSRequestWSRequest
  63. def withProxyServer(proxyServer: WSProxyServer): WSRequest

    Permalink

    Sets the proxy server to use in this request

    Sets the proxy server to use in this request

    Definition Classes
    AhcWSRequestWSRequest
  64. def withQueryString(parameters: (String, String)*): WSRequest

    Permalink

    adds any number of query string parameters to this request

    adds any number of query string parameters to this request

    Definition Classes
    AhcWSRequestWSRequest
  65. def withRequestFilter(filter: WSRequestFilter): WSRequest

    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
  66. def withRequestTimeout(timeout: Duration): WSRequest

    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
  67. def withVirtualHost(vh: String): WSRequest

    Permalink

    Sets the virtual host to use in this request

    Sets the virtual host to use in this request

    Definition Classes
    AhcWSRequestWSRequest

Deprecated Value Members

  1. def get[A](consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    Permalink

    performs a get

    performs a get

    consumer

    that's handling the response

    Definition Classes
    WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version Use WS.withMethod("GET").stream()) 2.5.0

  2. def getStream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    Permalink

    performs a get

    performs a get

    Definition Classes
    WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version Use WS.withMethod("GET").stream()) 2.5.0

  3. def patchAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    Permalink

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version Use WS.withMethod("PATCH").stream()) 2.5.0

  4. def postAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    Permalink

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version Use WS.withMethod("POST").stream()) 2.5.0

  5. def putAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    Permalink

    performs a PUT with supplied body

    performs a PUT with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version Use WS.withMethod("PUT").stream()) 2.5.0

  6. def streamWithEnumerator(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    Permalink

    Execute this request and stream the response body.

    Execute this request and stream the response body.

    Definition Classes
    AhcWSRequestWSRequest
    Annotations
    @deprecated
    Deprecated

    (Since version Use stream() instead.) 2.5

    Note

    This method used to be named stream, but it was renamed because the method's signature was changed and the JVM doesn't allow overloading on the return type.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WSRequest

Inherited from AnyRef

Inherited from Any

Ungrouped