play.api.libs.ws.WS

WSRequestHolder

case class WSRequestHolder(url: String, headers: Map[String, Seq[String]], queryString: Map[String, Seq[String]], calc: Option[SignatureCalculator], auth: Option[(String, String, AuthScheme)], followRedirects: Option[Boolean], requestTimeout: Option[Int], virtualHost: Option[String]) extends Product with Serializable

A WS Request builder.

Source
WS.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WSRequestHolder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WSRequestHolder(url: String, headers: Map[String, Seq[String]], queryString: Map[String, Seq[String]], calc: Option[SignatureCalculator], auth: Option[(String, String, AuthScheme)], followRedirects: Option[Boolean], requestTimeout: Option[Int], virtualHost: Option[String])

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val auth: Option[(String, String, AuthScheme)]

  8. val calc: Option[SignatureCalculator]

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def delete(): Future[Response]

    Perform a DELETE on the request asynchronously.

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def execute(method: String): Future[Response]

    Execute an arbitrary method on the request asynchronously.

    Execute an arbitrary method on the request asynchronously.

    method

    The method to execute

  13. def finalize(): Unit

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

  15. def get[A](consumer: (ResponseHeaders) ⇒ Iteratee[Array[Byte], A]): Future[Iteratee[Array[Byte], A]]

    performs a get with supplied body

    performs a get with supplied body

    consumer

    that's handling the response

  16. def get(): Future[Response]

    performs a get with supplied body

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

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

    Perform a HEAD on the request asynchronously.

  19. val headers: Map[String, Seq[String]]

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

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

    Perform a OPTIONS on the request asynchronously.

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

    Perform a POST on the request asynchronously.

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

  26. def post[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[Response]

    Perform a POST on the request asynchronously.

  27. def postAndRetrieveStream[A, T](body: T)(consumer: (ResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[Iteratee[Array[Byte], A]]

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

  28. def put(body: File): Future[Response]

    Perform a PUT on the request asynchronously.

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

  29. def put[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[Response]

    Perform a PUT on the request asynchronously.

  30. def putAndRetrieveStream[A, T](body: T)(consumer: (ResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[Iteratee[Array[Byte], A]]

    performs a PUT with supplied body

    performs a PUT with supplied body

    consumer

    that's handling the response

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

  32. val requestTimeout: Option[Int]

  33. def sign(calc: SignatureCalculator): WSRequestHolder

    sets the signature calculator for the request

    sets the signature calculator for the request

    calc

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  35. val url: String

  36. val virtualHost: Option[String]

  37. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withAuth(username: String, password: String, scheme: AuthScheme): WSRequestHolder

    sets the authentication realm

  41. def withFollowRedirects(follow: Boolean): WSRequestHolder

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

  42. def withHeaders(hdrs: (String, String)*): WSRequestHolder

    adds any number of HTTP headers

    adds any number of HTTP headers

    hdrs

  43. def withQueryString(parameters: (String, String)*): WSRequestHolder

    adds any number of query string parameters to the

  44. def withRequestTimeout(timeout: Int): WSRequestHolder

    Sets the maximum time in millisecond you accept the request to take.

    Sets the maximum time in millisecond you accept the request to take. Warning: a stream consumption will be interrupted when this time is reached.

  45. def withVirtualHost(vh: String): WSRequestHolder

Deprecated Value Members

  1. def withTimeout(timeout: Int): WSRequestHolder

    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) use withRequestTimeout instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped