ws - play.api.libs.ws

Type Members

class BodyReadable[+R] extends AnyRef

Annotations
@implicitNotFound( ... )
class BodyWritable[-A] extends AnyRef

This is a type class pattern for writing different types of bodies to a WS request.
This is a type class pattern for writing different types of bodies to a WS request.

Annotations
@implicitNotFound( ... )
trait DefaultBodyReadables extends AnyRef

Defines common BodyReadable for a response backed by org.asynchttpclient.Response.
trait DefaultBodyWritables extends AnyRef

Default BodyWritable for a request body, for use with requests that take a body such as PUT, POST and PATCH.
Default BodyWritable for a request body, for use with requests that take a body such as PUT, POST and PATCH.
```
class MyClass extends DefaultBodyWritables {
  def postBody() = {
    val getBody: String = ...
    ws.url(...).post(getBody).map { response => ... }
  }
}
```
case class DefaultWSCookie(name: String, value: String, domain: Option[String] = None, path: Option[String] = None, maxAge: Option[Long] = None, secure: Boolean = false, httpOnly: Boolean = false) extends WSCookie with Product with Serializable
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 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 SourceBody(source: Source[ByteString, _]) extends WSBody with Product with Serializable

A body containing a source of bytes
A body containing a source of bytes
source
A flow of the bytes of the body
trait StandaloneWSClient extends Closeable

The WSClient holds the configuration information needed to build a request, and provides a way to get a request holder.
trait StandaloneWSRequest extends AnyRef

A WS Request builder.
trait StandaloneWSResponse extends AnyRef

A WS HTTP response.
trait WSAuthScheme extends AnyRef
sealed trait WSBody extends AnyRef

A body for the request.
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: SSLConfigSettings = SSLConfigSettings()) extends Product with Serializable

WS client config
WS client config
connectionTimeout
The maximum time to wait when connecting to the remote host (default is 120 seconds).
idleTimeout
The maximum time the request can stay idle (connection is established but waiting for more data) (default is 120 seconds).
requestTimeout
The total time you accept a request to take (it will be interrupted even if the remote host is still sending data) (default is 120 seconds).
followRedirects
Configures the client to follow 301 and 302 redirects (default is true).
useProxyProperties
To use the JVM system’s HTTP proxy settings (http.proxyHost, http.proxyPort) (default is true).
userAgent
To configure the User-Agent header field (default is None).
compressionEnabled
Set it to true to use gzip/deflater encoding (default is false).
ssl
use custom SSL / TLS configuration, see https://typesafehub.github.io/ssl-config/ for documentation.
class WSConfigParser extends Provider[WSClientConfig]

This class creates a WSClientConfig object from a Typesafe Config object.
This class creates a WSClientConfig object from a Typesafe Config object.
You can create a client config from an application.conf file by running
```
val wsClientConfig = new WSConfigParser(ConfigFactory.load(), this.classLoader).parse()
```
Annotations
@Singleton()
trait WSCookie extends AnyRef

A WS Cookie.
trait WSProxyServer extends AnyRef

A WS proxy.
trait WSRequestExecutor extends (StandaloneWSRequest) ⇒ Future[StandaloneWSResponse]

trait WSRequestFilter extends (WSRequestExecutor) ⇒ WSRequestExecutor

A request filter.

A request filter. Override this trait to implement your own filters:

class HeaderAppendingFilter(key: String, value: String) extends WSRequestFilter {
  override def apply(executor: WSRequestExecutor): WSRequestExecutor = {
    WSRequestExecutor(r => executor(r.withHeaders((key, value))))
  }
}

trait WSSignatureCalculator extends AnyRef

Sign a WS call with OAuth.

Value Members

object BodyReadable
object BodyWritable
object DefaultBodyReadables extends DefaultBodyReadables
object DefaultBodyWritables extends DefaultBodyWritables
object EmptyBody extends WSBody with Product with Serializable
object WSAuthScheme
object WSRequestExecutor
object WSRequestFilter
implicit val readableAsByteArray: BodyReadable[Array[Byte]]

Converts a response body into Array[Byte].
Converts a response body into Array[Byte].
```
val byteArray = response.body[Array[Byte]]
```
Definition Classes
DefaultBodyReadables
implicit val readableAsByteBuffer: BodyReadable[ByteBuffer]

Converts a response body into a read only ByteBuffer.
Converts a response body into a read only ByteBuffer.
```
val buffer = response.body[ByteBuffer]
```
Definition Classes
DefaultBodyReadables
implicit val readableAsByteString: BodyReadable[ByteString]

Converts a response body into an akka.util.ByteString:
Converts a response body into an akka.util.ByteString:
```
val byteString = response.body[ByteString]
```
Definition Classes
DefaultBodyReadables
implicit val readableAsSource: BodyReadable[Source[ByteString, _]]

Converts a response body into Source[ByteString, NotUsed].
Converts a response body into Source[ByteString, NotUsed].

Definition Classes
DefaultBodyReadables
implicit val readableAsString: BodyReadable[String]

Converts a response body into a String:
Converts a response body into a String:
```
val string = response.body[String]
```
Definition Classes
DefaultBodyReadables
implicit val writableOf_File: BodyWritable[File]

Creates an SourceBody with "application/octet-stream" content type from a file.
Creates an SourceBody with "application/octet-stream" content type from a file.

Definition Classes
DefaultBodyWritables
implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]

Creates an SourceBody with "application/octet-stream" content type from an inputstream.
Creates an SourceBody with "application/octet-stream" content type from an inputstream.

Definition Classes
DefaultBodyWritables
implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]

Creates an SourceBody with "application/octet-stream" content type from a file.
Creates an SourceBody with "application/octet-stream" content type from a file.

Definition Classes
DefaultBodyWritables
implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]

Creates an InMemoryBody with "application/octet-stream" content type from an array of bytes.
Creates an InMemoryBody with "application/octet-stream" content type from an array of bytes.

Definition Classes
DefaultBodyWritables
implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]

Creates an InMemoryBody with "application/octet-stream" content type from a bytebuffer.
Creates an InMemoryBody with "application/octet-stream" content type from a bytebuffer.

Definition Classes
DefaultBodyWritables
implicit val writeableOf_Bytes: BodyWritable[ByteString]

Creates an InMemoryBody with "application/octet-stream" content type.
Creates an InMemoryBody with "application/octet-stream" content type.

Definition Classes
DefaultBodyWritables
implicit val writeableOf_String: BodyWritable[String]

Creates an InMemoryBody with "text/plain" content type.
Creates an InMemoryBody with "text/plain" content type.

Definition Classes
DefaultBodyWritables
implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]

Creates an InMemoryBody with "text/plain" content type from a StringBuilder
Creates an InMemoryBody with "text/plain" content type from a StringBuilder

Definition Classes
DefaultBodyWritables
implicit val writeableOf_WsBody: BodyWritable[WSBody]

Creates a BodyWritable with an identity function, with "application/octet-stream" content type.
Creates a BodyWritable with an identity function, with "application/octet-stream" content type.

Definition Classes
DefaultBodyWritables
implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]

Creates an InMemoryBody with "application/x-www-form-urlencoded" content type.
Creates an InMemoryBody with "application/x-www-form-urlencoded" content type.

Definition Classes
DefaultBodyWritables
implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]

Definition Classes
DefaultBodyWritables

ws

package ws

Type Members

class BodyReadable[+R] extends AnyRef

class BodyWritable[-A] extends AnyRef

trait DefaultBodyReadables extends AnyRef

trait DefaultBodyWritables extends AnyRef

case class DefaultWSCookie(name: String, value: String, domain: Option[String] = None, path: Option[String] = None, maxAge: Option[Long] = None, secure: Boolean = false, httpOnly: Boolean = false) extends WSCookie with Product with Serializable

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

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

trait StandaloneWSClient extends Closeable

trait StandaloneWSRequest extends AnyRef

trait StandaloneWSResponse extends AnyRef

trait WSAuthScheme extends AnyRef

sealed trait WSBody extends AnyRef

class WSConfigParser extends Provider[WSClientConfig]

trait WSCookie extends AnyRef

trait WSProxyServer extends AnyRef

trait WSRequestExecutor extends (StandaloneWSRequest) ⇒ Future[StandaloneWSResponse]

trait WSRequestFilter extends (WSRequestExecutor) ⇒ WSRequestExecutor

trait WSSignatureCalculator extends AnyRef

Value Members

object BodyReadable

object BodyWritable

object DefaultBodyReadables extends DefaultBodyReadables

object DefaultBodyWritables extends DefaultBodyWritables

object EmptyBody extends WSBody with Product with Serializable

object WSAuthScheme

object WSRequestExecutor

object WSRequestFilter

implicit val readableAsByteArray: BodyReadable[Array[Byte]]

implicit val readableAsByteBuffer: BodyReadable[ByteBuffer]

implicit val readableAsByteString: BodyReadable[ByteString]

implicit val readableAsSource: BodyReadable[Source[ByteString, _]]

implicit val readableAsString: BodyReadable[String]

implicit val writableOf_File: BodyWritable[File]

implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]

implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]

implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]

implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]

implicit val writeableOf_Bytes: BodyWritable[ByteString]

implicit val writeableOf_String: BodyWritable[String]

implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]

implicit val writeableOf_WsBody: BodyWritable[WSBody]

implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]

implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]

Inherited from DefaultBodyWritables

Inherited from DefaultBodyReadables

Inherited from AnyRef

Inherited from Any

Ungrouped