server

Type Members

class AkkaHttpServer extends Server

Starts a Play server using Akka HTTP.
trait AkkaHttpServerComponents extends ServerComponents

Components for building a simple Akka HTTP Server.
class AkkaHttpServerProvider extends ServerProvider

Knows how to create an AkkaHttpServer.
trait DefaultAkkaHttpServerComponents extends AkkaHttpServerComponents with api.BuiltInComponents with NoHttpFiltersComponents

A convenient helper trait for constructing an AkkaHttpServer, for example:
A convenient helper trait for constructing an AkkaHttpServer, for example:
```
val components = new DefaultAkkaHttpServerComponents {
  override lazy val router = {
    case GET(p"/") => Action(parse.json) { body =>
      Ok("Hello")
    }
  }
}
val server = components.server
```
trait DefaultNettyServerComponents extends NettyServerComponents with api.BuiltInComponents with NoHttpFiltersComponents

A convenient helper trait for constructing an NettyServer, for example:
A convenient helper trait for constructing an NettyServer, for example:
```
val components = new DefaultNettyServerComponents {
  override lazy val router = {
    case GET(p"/") => Action(parse.json) { body =>
      Ok("Hello")
    }
  }
}
val server = components.server
```
class NettyServer extends Server

creates a Server implementation based Netty
trait NettyServerComponents extends ServerComponents

Cake for building a simple Netty server.
class NettyServerProvider extends ServerProvider

The Netty server provider
sealed trait NettyTransport extends AnyRef
class RealServerProcess extends ServerProcess

A ServerProcess that wraps a real JVM process.
A ServerProcess that wraps a real JVM process. Calls have a real effect on the JVM, e.g. exit calls System.exit.
final class SelfSignedSSLEngineProvider extends SSLEngineProvider

An SSLEngineProvider which simply references the values in the SelfSigned object.
An SSLEngineProvider which simply references the values in the SelfSigned object.

Annotations
@ApiMayChange()
trait Server extends ReloadableServer

Provides generic server behaviour for Play applications.
trait ServerComponents extends AnyRef

Components to create a Server instance.
case class ServerConfig(rootDir: File, port: Option[Int], sslPort: Option[Int], address: String, mode: api.Mode, properties: Properties, configuration: Configuration) extends Product with Serializable

Common configuration for servers such as NettyServer.
Common configuration for servers such as NettyServer.
rootDir
The root directory of the server. Used to find default locations of files, log directories, etc.
port
The HTTP port to use.
sslPort
The HTTPS port to use.
address
The socket address to bind to.
mode
The run mode: dev, test or prod.
final case class ServerEndpoint(description: String, scheme: String, host: String, port: Int, expectedHttpVersions: Set[String], expectedServerAttr: Option[String], ssl: Option[ClientSsl]) extends Product with Serializable

Contains information about which port and protocol can be used to connect to the server.
Contains information about which port and protocol can be used to connect to the server. This class is used to abstract out the details of connecting to different backends and protocols. Most tests will operate the same no matter which endpoint they are connected to.

Annotations
@ApiMayChange()
final case class ServerEndpoints(endpoints: Seq[ServerEndpoint]) extends Product with Serializable

Wrapper for a sequence of ServerEndpoints.
Wrapper for a sequence of ServerEndpoints. Has a few convenience methods. Also can be used as an implicit parameter to pass around server endpoint information.

Annotations
@ApiMayChange()
class ServerListenException extends Exception

This exception is thrown when the server is unable to listen on a port
trait ServerProcess extends AnyRef

Abstracts a JVM process so it can be mocked for testing or to isolate pseudo-processes within a VM.
Abstracts a JVM process so it can be mocked for testing or to isolate pseudo-processes within a VM. Code using this class should use the methods in this class instead of methods like System.getProperties(), System.exit(), etc.
trait ServerProvider extends AnyRef

An object that knows how to obtain a server.
An object that knows how to obtain a server. Instantiating a ServerProvider object should be fast and side-effect free. Any actual work that a ServerProvider needs to do should be delayed until the createServer method is called.
final case class ServerStartException(message: String, cause: Option[Throwable] = None) extends Exception with Product with Serializable

Indicates an issue with starting a server, e.g.
Indicates an issue with starting a server, e.g. a problem reading its configuration.
trait WebSocketable extends AnyRef

Value Members

object AkkaHttpServer extends ServerFromRouter

Creates an AkkaHttpServer from a given router using BuiltInComponents:

val server = AkkaHttpServer.fromRouterWithComponents(ServerConfig(port = Some(9002))) { components =>
  import play.api.mvc.Results._
  import components.{ defaultActionBuilder => Action }
  {
    case GET(p"/") => Action {
      Ok("Hello")
    }
  }
}

Use this together with Sird Router.

object DevServerStart

Used to start servers in 'dev' mode, a mode where the application is reloaded whenever its source changes.
object Jdk extends NettyTransport with Product with Serializable
object Native extends NettyTransport with Product with Serializable

object NettyServer extends ServerFromRouter

Create a Netty server zfrom a given router using BuiltInComponents:

val server = NettyServer.fromRouterWithComponents(ServerConfig(port = Some(9002))) { components =>
  import play.api.mvc.Results._
  import components.{ defaultActionBuilder => Action }
  {
    case GET(p"/") => Action {
      Ok("Hello")
    }
  }
}

Use this together with Sird Router.

object ProdServerStart

Used to start servers in 'prod' mode, the mode that is used in production.
Used to start servers in 'prod' mode, the mode that is used in production. The application is loaded and started immediately.
object SelfSigned

Contains a statically initialized self-signed certificate.
Contains a statically initialized self-signed certificate.

Annotations
@ApiMayChange()
object Server

Utilities for creating a server that runs around a block of code.
object ServerConfig extends Serializable
object ServerEndpoint extends Serializable

Annotations
@ApiMayChange()
object ServerProvider
package akkahttp
package common
package netty
package ssl

package server

Type Members

class AkkaHttpServer extends Server

trait AkkaHttpServerComponents extends ServerComponents

class AkkaHttpServerProvider extends ServerProvider

trait DefaultAkkaHttpServerComponents extends AkkaHttpServerComponents with api.BuiltInComponents with NoHttpFiltersComponents

trait DefaultNettyServerComponents extends NettyServerComponents with api.BuiltInComponents with NoHttpFiltersComponents

class NettyServer extends Server

trait NettyServerComponents extends ServerComponents

class NettyServerProvider extends ServerProvider

sealed trait NettyTransport extends AnyRef

class RealServerProcess extends ServerProcess

final class SelfSignedSSLEngineProvider extends SSLEngineProvider

trait Server extends ReloadableServer

trait ServerComponents extends AnyRef

case class ServerConfig(rootDir: File, port: Option[Int], sslPort: Option[Int], address: String, mode: api.Mode, properties: Properties, configuration: Configuration) extends Product with Serializable

final case class ServerEndpoint(description: String, scheme: String, host: String, port: Int, expectedHttpVersions: Set[String], expectedServerAttr: Option[String], ssl: Option[ClientSsl]) extends Product with Serializable

final case class ServerEndpoints(endpoints: Seq[ServerEndpoint]) extends Product with Serializable

class ServerListenException extends Exception

trait ServerProcess extends AnyRef

trait ServerProvider extends AnyRef

final case class ServerStartException(message: String, cause: Option[Throwable] = None) extends Exception with Product with Serializable

trait WebSocketable extends AnyRef

Value Members

object AkkaHttpServer extends ServerFromRouter

object DevServerStart

object Jdk extends NettyTransport with Product with Serializable

object Native extends NettyTransport with Product with Serializable

object NettyServer extends ServerFromRouter

object ProdServerStart

object SelfSigned

object Server

object ServerConfig extends Serializable

object ServerEndpoint extends Serializable

object ServerProvider

package akkahttp

package common

package netty

package ssl

Ungrouped