root
API
Generated with
root/play.core.server

play.core.server

package play.core.server

Members list

Packages

package play.core.server.common
package play.core.server.ssl

Type members

Classlikes

object DevServerStart

Used to start servers in 'dev' mode, a mode where the application is reloaded whenever its source changes.

Used to start servers in 'dev' mode, a mode where the application is reloaded whenever its source changes.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class DevServerStart(mkServerActorSystem: Configuration => ActorSystem, additionalSettings: Map[String, AnyRef])

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ProdServerStart

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class RealServerProcess(val args: Seq[String]) extends ServerProcess

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
object SelfSigned

Contains a statically initialized self-signed certificate.

Contains a statically initialized self-signed certificate.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
SelfSigned.type
final class SelfSignedSSLEngineProvider(serverConfig: ServerConfig, appProvider: ApplicationProvider) extends SSLEngineProvider

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
trait Server extends ReloadableServer

Provides generic server behaviour for Play applications.

Provides generic server behaviour for Play applications.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Server

Utilities for creating a server that runs around a block of code.

Utilities for creating a server that runs around a block of code.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Server.type
trait ServerComponents

Components to create a Server instance.

Components to create a Server instance.

Attributes

Supertypes
class Object
trait Matchable
class Any
case class ServerConfig(rootDir: File, port: Option[Int], sslPort: Option[Int], address: String, mode: Mode, properties: Properties, configuration: Configuration)

Common configuration for servers such as NettyServer.

Common configuration for servers such as NettyServer.

Value parameters

address

The socket address to bind to.

configuration

The configuration to use for loading the server. This is not the same as application configuration. This configuration is usually loaded from a server.conf file, whereas the application configuration is usually loaded from an application.conf file.

mode

The run mode: dev, test or prod.

port

The HTTP port to use.

rootDir

The root directory of the server. Used to find default locations of files, log directories, etc.

sslPort

The HTTPS port to use.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ServerConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ServerEndpoint(description: String, scheme: String, host: String, port: Int, protocols: Set[String], serverAttribute: Option[String], ssl: Option[SSLContext])

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.

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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ServerEndpoints(endpoints: Seq[ServerEndpoint])

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ServerEndpoints

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
class ServerListenException(protocol: String, address: SocketAddress) extends Exception

This exception is thrown when the server is unable to listen on a port

This exception is thrown when the server is unable to listen on a port

Attributes

Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait ServerProcess

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.

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.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ServerProvider

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.

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ServerProvider

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final case class ServerStartException(message: String, cause: Option[Throwable]) extends Exception

Indicates an issue with starting a server, e.g. a problem reading its configuration.

Indicates an issue with starting a server, e.g. a problem reading its configuration.

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait WebSocketable

Attributes

Supertypes
class Object
trait Matchable
class Any
Generated with