Class

play.api.test

FakeApplication

Related Doc: package test

Permalink

case class FakeApplication(path: File = new java.io.File("."), classloader: ClassLoader = ..., additionalConfiguration: Map[String, _] = Map.empty, withGlobal: Option[GlobalSettings] = None, withRoutes: PartialFunction[(String, String), Handler] = PartialFunction.empty) extends Application with Product with Serializable

A Fake application.

path

The application path

classloader

The application classloader

additionalConfiguration

Additional configuration

withRoutes

A partial function of method name and path to a handler for handling the request

Annotations
@deprecated
Deprecated

(Since version 2.5.0) Use GuiceApplicationBuilder instead.

Source
Fakes.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Application, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FakeApplication
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Application
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FakeApplication(path: File = new java.io.File("."), classloader: ClassLoader = ..., additionalConfiguration: Map[String, _] = Map.empty, withGlobal: Option[GlobalSettings] = None, withRoutes: PartialFunction[(String, String), Handler] = PartialFunction.empty)

    Permalink

    path

    The application path

    classloader

    The application classloader

    additionalConfiguration

    Additional configuration

    withRoutes

    A partial function of method name and path to a handler for handling the request

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def actorSystem: ActorSystem

    Permalink

    The default ActorSystem used by the application.

    The default ActorSystem used by the application.

    Definition Classes
    FakeApplicationApplication
  5. val additionalConfiguration: Map[String, _]

    Permalink

    Additional configuration

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val classloader: ClassLoader

    Permalink

    The application classloader

    The application classloader

    Definition Classes
    FakeApplicationApplication
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def configuration: Configuration

    Permalink
    Definition Classes
    FakeApplicationApplication
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def errorHandler: HttpErrorHandler

    Permalink

    The HTTP error handler

    The HTTP error handler

    Definition Classes
    FakeApplicationApplication
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getExistingFile(relativePath: String): Option[File]

    Permalink

    Retrieves a file relative to the application root path.

    Retrieves a file relative to the application root path. This method returns an Option[File], using None if the file was not found.

    Note that it is up to you to manage the files in the application root path in production. By default, there will be nothing available in the application root path.

    For example, to retrieve some deployment specific data file:

    val myDataFile = application.getExistingFile("data/data.xml")
    relativePath

    the relative path of the file to fetch

    returns

    an existing file

    Definition Classes
    Application
  15. def getFile(relativePath: String): File

    Permalink

    Retrieves a file relative to the application root path.

    Retrieves a file relative to the application root path.

    Note that it is up to you to manage the files in the application root path in production. By default, there will be nothing available in the application root path.

    For example, to retrieve some deployment specific data file:

    val myDataFile = application.getFile("data/data.xml")
    relativePath

    relative path of the file to fetch

    returns

    a file instance; it is not guaranteed that the file exists

    Definition Classes
    Application
  16. def injector: Injector

    Permalink

    Get the injector for this application.

    Get the injector for this application.

    returns

    The injector.

    Definition Classes
    FakeApplicationApplication
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. implicit def materializer: Materializer

    Permalink

    The default Materializer used by the application.

    The default Materializer used by the application.

    Definition Classes
    FakeApplicationApplication
  19. def mode: Mode.Mode

    Permalink

    Dev, Prod or Test

    Dev, Prod or Test

    Definition Classes
    FakeApplicationApplication
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. val path: File

    Permalink

    The application path

    The application path

    Definition Classes
    FakeApplicationApplication
  24. def requestHandler: HttpRequestHandler

    Permalink

    The HTTP request handler

    The HTTP request handler

    Definition Classes
    FakeApplicationApplication
  25. def resource(name: String): Option[URL]

    Permalink

    Scans the application classloader to retrieve a resource.

    Scans the application classloader to retrieve a resource.

    The conf directory is included on the classpath, so this may be used to look up resources, relative to the conf directory.

    For example, to retrieve the conf/logger.xml configuration file:

    val maybeConf = application.resource("logger.xml")
    name

    the absolute name of the resource (from the classpath root)

    returns

    the resource URL, if found

    Definition Classes
    Application
  26. def resourceAsStream(name: String): Option[InputStream]

    Permalink

    Scans the application classloader to retrieve a resource’s contents as a stream.

    Scans the application classloader to retrieve a resource’s contents as a stream.

    The conf directory is included on the classpath, so this may be used to look up resources, relative to the conf directory.

    For example, to retrieve the conf/logger.xml configuration file:

    val maybeConf = application.resourceAsStream("logger.xml")
    name

    the absolute name of the resource (from the classpath root)

    returns

    a stream, if found

    Definition Classes
    Application
  27. def stop(): Future[_]

    Permalink

    Stop the application.

    Stop the application. The returned future will be redeemed when all stop hooks have been run.

    Definition Classes
    FakeApplicationApplication
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. val withRoutes: PartialFunction[(String, String), Handler]

    Permalink

    A partial function of method name and path to a handler for handling the request

Deprecated Value Members

  1. def global: GlobalSettings

    Permalink
    Definition Classes
    FakeApplicationApplication
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0) Use dependency injection

  2. def routes: Router

    Permalink

    The router used by this application.

    The router used by this application.

    Definition Classes
    Application
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4.0) Either use HttpRequestHandler, or have the router injected

  3. val withGlobal: Option[GlobalSettings]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0) Use dependency injection

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Application

Inherited from AnyRef

Inherited from Any

Ungrouped