Class

play.api.libs.ws.ahc

StandaloneAhcWSRequest

Related Doc: package ahc

Permalink

case class StandaloneAhcWSRequest(client: StandaloneAhcWSClient, url: String, method: String = "GET", body: WSBody = EmptyBody, headers: Map[String, Seq[String]] = TreeMap()(CaseInsensitiveOrdered), queryString: Map[String, Seq[String]] = Map.empty, calc: Option[WSSignatureCalculator] = None, auth: Option[(String, String, WSAuthScheme)] = None, followRedirects: Option[Boolean] = None, requestTimeout: Option[Int] = None, virtualHost: Option[String] = None, proxyServer: Option[WSProxyServer] = None, disableUrlEncoding: Option[Boolean] = None, filters: Seq[WSRequestFilter] = Nil)(implicit materializer: Materializer) extends StandaloneWSRequest with AhcUtilities with Product with Serializable

A Ahc WS Request.

Source
StandaloneAhcWSRequest.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AhcUtilities, StandaloneWSRequest, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandaloneAhcWSRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AhcUtilities
  7. StandaloneWSRequest
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StandaloneAhcWSRequest(client: StandaloneAhcWSClient, url: String, method: String = "GET", body: WSBody = EmptyBody, headers: Map[String, Seq[String]] = TreeMap()(CaseInsensitiveOrdered), queryString: Map[String, Seq[String]] = Map.empty, calc: Option[WSSignatureCalculator] = None, auth: Option[(String, String, WSAuthScheme)] = None, followRedirects: Option[Boolean] = None, requestTimeout: Option[Int] = None, virtualHost: Option[String] = None, proxyServer: Option[WSProxyServer] = None, disableUrlEncoding: Option[Boolean] = None, filters: Seq[WSRequestFilter] = Nil)(implicit materializer: Materializer)

    Permalink

Type Members

  1. type Response = StandaloneWSResponse

    Permalink
  2. type Self = StandaloneWSRequest

    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
    StandaloneAhcWSRequestStandaloneWSRequest
  6. val body: WSBody

    Permalink

    The body of this request

    The body of this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  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
    StandaloneAhcWSRequestStandaloneWSRequest
  9. val client: StandaloneAhcWSClient

    Permalink
  10. def clone(): AnyRef

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

    Permalink

    The content type for this request, if any is defined.

    The content type for this request, if any is defined.

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  12. def delete(): Future[Response]

    Permalink

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

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

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

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

    Permalink

    Execute this request

    Execute this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  16. def execute(method: String): Future[Response]

    Permalink
  17. def filterWSRequestExecutor(next: WSRequestExecutor): WSRequestExecutor

    Permalink
    Attributes
    protected
  18. def finalize(): Unit

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

    Permalink

    Whether this request should follow redirects

    Whether this request should follow redirects

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  20. def get(): Future[Response]

    Permalink

    performs a get

    performs a get

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  21. def getBody: Option[ByteString]

    Permalink

    Returns the body as an array of bytes.

    Returns the body as an array of bytes. This is an AHC specific method.

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

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

    Permalink

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  24. val headers: Map[String, Seq[String]]

    Permalink

    The headers for this request

    The headers for this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  25. def headersToMap(headers: HttpHeaders): TreeMap[String, Seq[String]]

    Permalink
    Definition Classes
    AhcUtilities
  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
    StandaloneAhcWSRequestStandaloneWSRequest
  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[Response]

    Permalink

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  32. def patch(body: File): Future[Response]

    Permalink

    Perform a PATCH on the request asynchronously.

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

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  33. def patch[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

  34. def post(body: File): Future[Response]

    Permalink

    Perform a POST on the request asynchronously.

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

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  35. def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

  36. val proxyServer: Option[WSProxyServer]

    Permalink

    The proxy server this request will use

    The proxy server this request will use

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  37. def put(body: File): Future[Response]

    Permalink

    Perform a PUT on the request asynchronously.

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

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  38. def put[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

  39. val queryString: Map[String, Seq[String]]

    Permalink

    The query string for this request

    The query string for this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  40. 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.

  41. 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.

  42. 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.

  43. val requestTimeout: Option[Int]

    Permalink

    The timeout for the request

    The timeout for the request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  44. 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. This is an AHC specific method.

  45. def sign(calc: WSSignatureCalculator): Self

    Permalink

    sets the signature calculator for the request

    sets the signature calculator for the request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  46. def stream(): Future[StreamedResponse]

    Permalink

    Execute this request and stream the response body.

    Execute this request and stream the response body.

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  48. lazy val uri: URI

    Permalink

    The URI for this request

    The URI for this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  49. val url: String

    Permalink

    The base URL for this request

    The base URL for this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  50. val virtualHost: Option[String]

    Permalink

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  51. final def wait(): Unit

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

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

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

    Permalink

    sets the authentication realm

    sets the authentication realm

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  55. 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
    StandaloneAhcWSRequestStandaloneWSRequest
  56. def withBody(body: WSBody): Self

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  57. def withBody(body: File): Self

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  58. 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
    StandaloneAhcWSRequestStandaloneWSRequest
  59. def withHeaders(hdrs: (String, String)*): Self

    Permalink

    adds any number of HTTP headers

    adds any number of HTTP headers

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  60. def withMethod(method: String): Self

    Permalink

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  61. 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
    StandaloneAhcWSRequestStandaloneWSRequest
  62. def withQueryString(parameters: (String, String)*): Self

    Permalink

    adds any number of query string parameters to this request

    adds any number of query string parameters to this request

    Definition Classes
    StandaloneAhcWSRequestStandaloneWSRequest
  63. 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
    StandaloneAhcWSRequestStandaloneWSRequest
  64. 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
    StandaloneAhcWSRequestStandaloneWSRequest
  65. 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
    StandaloneAhcWSRequestStandaloneWSRequest

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AhcUtilities

Inherited from StandaloneWSRequest

Inherited from AnyRef

Inherited from Any

Ungrouped