object Server
Utilities for creating a server that runs around a block of code.
- Source
- Server.scala
- Alphabetic
- By Inheritance
- Server
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
withApplication[T](application: api.Application, config: ServerConfig = ...)(block: (Port) ⇒ T)(implicit provider: ServerProvider): T
Run a block of code with a server for the given application.
Run a block of code with a server for the given application.
The passed in block takes the port that the application is running on. By default, this will be a random ephemeral port. This can be changed by passing in an explicit port with the config parameter.
- application
The application for the server to server.
- config
The configuration for the server. Defaults to test config with the http port bound to a random ephemeral port.
- block
The block of code to run.
- provider
The server provider.
- returns
The result of the block of code.
-
def
withApplicationFromContext[T](config: ServerConfig = ...)(appProducer: (Context) ⇒ api.Application)(block: (Port) ⇒ T)(implicit provider: ServerProvider): T
Run a block of code with a server for the application containing routes.
Run a block of code with a server for the application containing routes.
The passed in block takes the port that the application is running on. By default, this will be a random ephemeral port. This can be changed by passing in an explicit port with the config parameter.
An easy way to set up an application with given routes is to use play.api.BuiltInComponentsFromContext with any extra components needed:
Server.withApplicationFromContext(ServerConfig(mode = Mode.Prod, port = Some(0))) { context => new BuiltInComponentsFromContext(context) with AssetsComponents with play.filters.HttpFiltersComponents { override def router: Router = Router.from { case req => assets.versioned("/testassets", req.path) } }.application } { withClient(block)(_) }
- config
The configuration for the server. Defaults to test config with the http port bound to a random ephemeral port.
- appProducer
A function that takes an ApplicationLoader.Context and produces play.api.Application
- block
The block of code to run.
- provider
The server provider.
- returns
The result of the block of code.
-
def
withRouter[T](config: ServerConfig = ...)(routes: PartialFunction[RequestHeader, Handler])(block: (Port) ⇒ T)(implicit provider: ServerProvider): T
Run a block of code with a server for the given routes.
Run a block of code with a server for the given routes.
The passed in block takes the port that the application is running on. By default, this will be a random ephemeral port. This can be changed by passing in an explicit port with the config parameter.
- config
The configuration for the server. Defaults to test config with the http port bound to a random ephemeral port.
- routes
The routes for the server to server.
- block
The block of code to run.
- provider
The server provider.
- returns
The result of the block of code.
-
def
withRouterFromComponents[T](config: ServerConfig = ...)(routes: (api.BuiltInComponents) ⇒ PartialFunction[RequestHeader, Handler])(block: (Port) ⇒ T)(implicit provider: ServerProvider): T
Run a block of code with a server for the given routes, obtained from the application components
Run a block of code with a server for the given routes, obtained from the application components
The passed in block takes the port that the application is running on. By default, this will be a random ephemeral port. This can be changed by passing in an explicit port with the config parameter.
- config
The configuration for the server. Defaults to test config with the http port bound to a random ephemeral port.
- routes
A function that obtains the routes from the server from the application components.
- block
The block of code to run.
- provider
The server provider.
- returns
The result of the block of code.
- object ServerStoppedReason extends Reason with Product with Serializable