ws - play.api.libs.ws

Type Members

case class DefaultWSProxyServer(host: String, port: Int, protocol: Option[String] = None, principal: Option[String] = None, password: Option[String] = None, ntlmDomain: Option[String] = None, encoding: Option[String] = None, nonProxyHosts: Option[Seq[String]] = None) extends WSProxyServer with Product with Serializable

A WS proxy.
case class DefaultWSResponseHeaders(status: Int, headers: Map[String, Seq[String]]) extends WSResponseHeaders with Product with Serializable
case class FileBody(file: File) extends WSBody with Product with Serializable

A file body
case class InMemoryBody(bytes: ByteString) extends WSBody with Product with Serializable

An in memory body
An in memory body
bytes
The bytes of the body
case class StreamedBody(bytes: Source[ByteString, _]) extends WSBody with Product with Serializable

A streamed body
A streamed body
bytes
A flow of the bytes of the body
case class StreamedResponse(headers: WSResponseHeaders, body: Source[ByteString, _]) extends Product with Serializable

A streamed response containing a response header and a streamable body.
trait WSAPI extends AnyRef

The base WS API trait.
The base WS API trait. Plugins should extend this.
trait WSAuthScheme extends AnyRef
sealed trait WSBody extends AnyRef

A body for the request
trait WSClient extends Closeable

The WSClient holds the configuration information needed to build a request, and provides a way to get a request holder.
case class WSClientConfig(connectionTimeout: Duration = 2.minutes, idleTimeout: Duration = 2.minutes, requestTimeout: Duration = 2.minutes, followRedirects: Boolean = true, useProxyProperties: Boolean = true, userAgent: Option[String] = None, compressionEnabled: Boolean = false, ssl: SSLConfig = SSLConfig()) extends Product with Serializable

WS client config
class WSConfigParser extends Provider[WSClientConfig]

This class creates a DefaultWSClientConfig object from the play.api.Configuration.
This class creates a DefaultWSClientConfig object from the play.api.Configuration.

Annotations
@Singleton()
trait WSCookie extends AnyRef

A WS Cookie.
A WS Cookie. This is a trait so that we are not tied to a specific client.
trait WSProxyServer extends AnyRef

A WS proxy.
trait WSRequest extends AnyRef

A WS Request builder.
trait WSRequestMagnet extends AnyRef

WSRequestMagnet magnet.
WSRequestMagnet magnet. Please see the companion object for implicit definitions.

See also
The magnet pattern
trait WSResponse extends AnyRef
trait WSResponseHeaders extends AnyRef

An HTTP response header (the body has not been retrieved yet)
trait WSSignatureCalculator extends AnyRef

Sign a WS call with OAuth.
type WSRequestHolder = WSRequest

Annotations
@deprecated
Deprecated
(Since version 2.4.0) Use WSRequest

Value Members

object EmptyBody extends WSBody with Product with Serializable

An empty body

object WS

Asynchronous API to to query web services, as an http client.

Usage example:

WS.url("http://example.com/feed").get()
WS.url("http://example.com/item").post("content")

When greater flexibility is needed, you can also create clients explicitly and pass them into WS:

implicit val client = new NingWSClient(builder.build())
WS.url("http://example.com/feed").get()

Or call the client directly:

import com.typesafe.config.ConfigFactory
import play.api.libs.ws._
import play.api.libs.ws.ning._

val configuration = play.api.Configuration(ConfigFactory.parseString(
"""
  |ws.ssl.trustManager = ...
""".stripMargin))
val parser = new DefaultWSConfigParser(configuration, Play.current.classloader)
val builder = new NingAsyncHttpClientConfigBuilder(parser.parse())
val secureClient: WSClient = new NingWSClient(builder.build())
val response = secureClient.url("https://secure.com").get()

Note that the resolution of URL is done through the magnet pattern defined in WSRequestMagnet.

The value returned is a Future[WSResponse], and you should use Play's asynchronous mechanisms to use this response.

object WSAuthScheme
package ning
package ssl

ws

package ws

Type Members

case class DefaultWSResponseHeaders(status: Int, headers: Map[String, Seq[String]]) extends WSResponseHeaders with Product with Serializable

case class FileBody(file: File) extends WSBody with Product with Serializable

case class InMemoryBody(bytes: ByteString) extends WSBody with Product with Serializable

case class StreamedBody(bytes: Source[ByteString, _]) extends WSBody with Product with Serializable

case class StreamedResponse(headers: WSResponseHeaders, body: Source[ByteString, _]) extends Product with Serializable

trait WSAPI extends AnyRef

trait WSAuthScheme extends AnyRef

sealed trait WSBody extends AnyRef

trait WSClient extends Closeable

class WSConfigParser extends Provider[WSClientConfig]

trait WSCookie extends AnyRef

trait WSProxyServer extends AnyRef

trait WSRequest extends AnyRef

trait WSRequestMagnet extends AnyRef

trait WSResponse extends AnyRef

trait WSResponseHeaders extends AnyRef

trait WSSignatureCalculator extends AnyRef

type WSRequestHolder = WSRequest

Value Members

object EmptyBody extends WSBody with Product with Serializable

object WS

object WSAuthScheme

package ning

package ssl

Inherited from AnyRef

Inherited from Any

Ungrouped