sealed trait ServerEndpointRecipe extends AnyRef

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.

Annotations
@ApiMayChange()
Source
ServerEndpointRecipe.scala
See also

ServerEndpointRecipe.withEndpoint()

Linear Supertypes
AnyRef, Any
Known Subclasses
HttpServerEndpointRecipe, HttpsServerEndpointRecipe
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerEndpointRecipe
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def configuredHttpPort: Option[Int]

    The HTTP port to use when configuring the server.

  2. abstract def configuredHttpsPort: Option[Int]

    The HTTPS port to use when configuring the server.

  3. abstract def createEndpointFromServer(runningTestServer: TestServer): ServerEndpoint

    Once a server has been started using this recipe, the running instance can be queried to create an endpoint.

    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.

  4. abstract def description: String

    A human-readable description of this endpoint.

  5. abstract def serverConfiguration: Configuration

    Any extra configuration to use when configuring the server.

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

  6. abstract def serverProvider: ServerProvider

    The provider used to create the server instance.

  7. abstract def withDescription(newDescription: String): ServerEndpointRecipe
  8. abstract def withExtraServerConfiguration(extraConfig: Map[String, Any]): ServerEndpointRecipe
  9. abstract def withServerProvider(newProvider: ServerProvider): ServerEndpointRecipe