root
API
Generated with
root/play.api.test/ServerEndpointRecipe

ServerEndpointRecipe

play.api.test.ServerEndpointRecipe
See theServerEndpointRecipe companion object
@ApiMayChange
sealed trait ServerEndpointRecipe

A recipe for making a ServerEndpoint. Recipes are often used when describing which tests to run. The recipe can be used to start servers with the correct ServerEndpoints.

Attributes

See also
Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def configuredHttpPort: Option[Int]

The HTTP port to use when configuring the server.

The HTTP port to use when configuring the server.

Attributes

def configuredHttpsPort: Option[Int]

The HTTPS port to use when configuring the server.

The HTTPS port to use when configuring the server.

Attributes

def createEndpointFromServer(runningTestServer: TestServer): ServerEndpoint

Once a server has been started using this recipe, the running instance can be queried to create an endpoint. Usually this just involves asking the server what port it is using.

Once a server has been started using this recipe, the running instance can be queried to create an endpoint. Usually this just involves asking the server what port it is using.

Attributes

def description: String

A human-readable description of this endpoint.

A human-readable description of this endpoint.

Attributes

def serverConfiguration: Configuration

Any extra configuration to use when configuring the server. This configuration will be applied last so it will override any existing configuration.

Any extra configuration to use when configuring the server. This configuration will be applied last so it will override any existing configuration.

Attributes

def serverProvider: ServerProvider

The provider used to create the server instance.

The provider used to create the server instance.

Attributes

Generated with