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.
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 WSRequestExecutor extends AnyRef
trait WSRequestFilter extends AnyRef
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.

Value Members

object EmptyBody extends WSBody with Product with Serializable

An empty body
object WSAuthScheme
package ahc
package ning
package ssl

Deprecated Value Members

object WS

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

Usage example:

class MyService @Inject() (ws: WSClient) {
  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:

import play.api.libs.ws._
import play.api.libs.ws.ahc._
import akka.stream.Materializer
import play.api.ApplicationLifecycle
import javax.inject.Inject
import scala.concurrent.Future

class MyService @Inject() (lifecycle: ApplicationLifecycle)(implicit mat: Materializer) {
  private val client = new AhcWSClient(new AhcConfigBuilder().build())
  client.url("http://example.com/feed").get()
  lifecycle.addStopHook(() =>
    // Make sure you close the client after use, otherwise you'll leak threads and connections
    client.close()
    Future.successful(())
  }
}

Or call the client directly:

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

val configuration = play.api.Configuration(ConfigFactory.parseString(
"""
  |play.ws.ssl.trustManager = ...
""".stripMargin))
val parser = new DefaultWSConfigParser(configuration, app.classloader)
val builder = new AhcConfigBuilder(parser.parse())
val secureClient: WSClient = new AhcWSClient(builder.build())
val response = secureClient.url("https://secure.com").get()
secureClient.close() // must explicitly manage lifecycle

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

Annotations: @deprecated
Deprecated: (Since version 2.5.0) Inject WSClient into your component

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 WSRequestExecutor extends AnyRef

trait WSRequestFilter extends AnyRef

trait WSRequestMagnet extends AnyRef

trait WSResponse extends AnyRef

trait WSResponseHeaders extends AnyRef

trait WSSignatureCalculator extends AnyRef

Value Members

object EmptyBody extends WSBody with Product with Serializable

object WSAuthScheme

package ahc

package ning

package ssl

Deprecated Value Members

object WS

Ungrouped