ws

Type Members

1. 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( ... )

2. trait DefaultBodyWritables extends AnyRef

   

   Default Writeable.

3. 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.

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

   

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

   

   A file body

6. 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

7. trait StandaloneWSClient extends Closeable

   

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

8. trait StandaloneWSRequest extends AnyRef

   

   A WS Request builder.

9. trait StandaloneWSResponse extends AnyRef

   

10. 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

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

    

    A streamed response containing a response header and a streamable body.

12. trait WSAuthScheme extends AnyRef

    

13. sealed trait WSBody extends AnyRef

    

    A body for the request

14. trait WSClient extends Closeable

    

    A Play specific WS client that can use Play specific classes in the request and response building.

    A Play specific WS client that can use Play specific classes in the request and response building.

    Typically, access this class through dependency injection, i.e.

    class MyService @Inject()(ws: WSClient) {
      val response: Future[WSResponse] = ws.url("http://example.com").get()
    }

    Please see the documentation at https://www.playframework.com/documentation/latest/ScalaWS for more details.

15. 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.

16. 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()

17. trait WSCookie extends AnyRef

    

    A WS Cookie.

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

18. trait WSProxyServer extends AnyRef

    

    A WS proxy.

19. trait WSRequest extends StandaloneWSRequest

    

    A WS Request builder.

20. trait WSRequestExecutor extends (StandaloneWSRequest) ⇒ Future[StandaloneWSResponse]

    

21. 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))))
      }
    }

22. trait WSResponse extends StandaloneWSResponse

    

    A WS Response that can use Play specific classes.

23. trait WSResponseHeaders extends AnyRef

    

    An HTTP response header (the body has not been retrieved yet)

24. trait WSSignatureCalculator extends AnyRef

    

    Sign a WS call with OAuth.