play.api.libs.ws.ning

NingWSRequestHolder

case class NingWSRequestHolder(client: NingWSClient, 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]) extends WSRequestHolder with Product with Serializable

A WS Request builder.

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

Instance Constructors

  1. new NingWSRequestHolder(client: NingWSClient, 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])

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, WSAuthScheme)]

    The authentication this request should use

    The authentication this request should use

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  8. val body: WSBody

    The body of this request

    The body of this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  9. val calc: Option[WSSignatureCalculator]

    A calculator of the signature for this request

    A calculator of the signature for this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  10. val client: NingWSClient

  11. def clone(): AnyRef

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

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

    Definition Classes
    WSRequestHolder
  13. final def eq(arg0: AnyRef): Boolean

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

    Execute this request

    Execute this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  15. def execute(method: String): Future[WSResponse]

    Definition Classes
    WSRequestHolder
  16. def finalize(): Unit

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

    Whether this request should follow redirects

    Whether this request should follow redirects

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

    performs a get

    performs a get

    consumer

    that's handling the response

    Definition Classes
    WSRequestHolder
  19. def get(): Future[WSResponse]

    performs a get

    performs a get

    Definition Classes
    WSRequestHolder
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def getStream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    performs a get

    performs a get

    Definition Classes
    WSRequestHolder
  22. def head(): Future[WSResponse]

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    WSRequestHolder
  23. val headers: Map[String, Seq[String]]

    The headers for this request

    The headers for this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. val method: String

    The method for this request

    The method for this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  26. final def ne(arg0: AnyRef): Boolean

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

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

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

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

    Definition Classes
    WSRequestHolder
  30. 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
    WSRequestHolder
  31. def patch[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[WSResponse]

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously.

    Definition Classes
    WSRequestHolder
  32. def patchAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ct: ContentTypeOf[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequestHolder
  33. def post(body: File): Future[WSResponse]

    Perform a POST on the request asynchronously.

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

    Definition Classes
    WSRequestHolder
  34. def post[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[WSResponse]

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    Definition Classes
    WSRequestHolder
  35. def postAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ct: ContentTypeOf[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequestHolder
  36. val proxyServer: Option[WSProxyServer]

    The proxy server this request will use

    The proxy server this request will use

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  37. 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
    WSRequestHolder
  38. def put[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[WSResponse]

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously.

    Definition Classes
    WSRequestHolder
  39. def putAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ct: ContentTypeOf[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a PUT with supplied body

    performs a PUT with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequestHolder
  40. val queryString: Map[String, Seq[String]]

    The query string for this request

    The query string for this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  41. val requestTimeout: Option[Int]

    The timeout for the request

    The timeout for the request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  42. def sign(calc: WSSignatureCalculator): WSRequestHolder

    sets the signature calculator for the request

    sets the signature calculator for the request

    calc

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  43. def stream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    Execute this request and stream the response body in an enumerator

    Execute this request and stream the response body in an enumerator

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  45. val url: String

    The URL for this request

    The URL for this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  46. val virtualHost: Option[String]

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  47. final def wait(): Unit

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

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

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

    sets the authentication realm

    sets the authentication realm

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  51. def withBody(body: WSBody): NingWSRequestHolder

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  52. def withBody[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): WSRequestHolder

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    WSRequestHolder
  53. def withFollowRedirects(follow: Boolean): NingWSRequestHolder

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

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

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  54. def withHeaders(hdrs: (String, String)*): NingWSRequestHolder

    adds any number of HTTP headers

    adds any number of HTTP headers

    hdrs

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  55. def withMethod(method: String): NingWSRequestHolder

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  56. def withProxyServer(proxyServer: WSProxyServer): NingWSRequestHolder

    Sets the proxy server to use in this request

    Sets the proxy server to use in this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  57. def withQueryString(parameters: (String, String)*): NingWSRequestHolder

    adds any number of query string parameters to the

    adds any number of query string parameters to the

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  58. def withRequestTimeout(timeout: Int): NingWSRequestHolder

    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.

    Definition Classes
    NingWSRequestHolderWSRequestHolder
  59. def withVirtualHost(vh: String): NingWSRequestHolder

    Sets the virtual host to use in this request

    Sets the virtual host to use in this request

    Definition Classes
    NingWSRequestHolderWSRequestHolder

Deprecated Value Members

  1. def withTimeout(timeout: Int): WSRequestHolder

    Definition Classes
    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 WSRequestHolder

Inherited from AnyRef

Inherited from Any

Ungrouped