Trait/Object

play.api

Application

Related Docs: object Application | package api

Permalink

trait Application extends AnyRef

A Play application.

Application creation is handled by the framework engine.

If you need to create an ad-hoc application, for example in case of unit testing, you can easily achieve this using:

val application = new DefaultApplication(new File("."), this.getClass.getClassloader, None, Play.Mode.Dev)

This will create an application using the current classloader.

Annotations
@implicitNotFound( ... )
Source
Application.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Application
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def actorSystem: ActorSystem

    Permalink

    The default ActorSystem used by the application.

  2. abstract def classloader: ClassLoader

    Permalink

    The application's classloader

  3. abstract def configuration: Configuration

    Permalink
  4. abstract def environment: Environment

    Permalink

    The application's environment

  5. abstract def errorHandler: HttpErrorHandler

    Permalink

    The HTTP error handler

  6. implicit abstract def materializer: Materializer

    Permalink

    The default Materializer used by the application.

  7. abstract def path: File

    Permalink

    The absolute path hosting this application, mainly used by the getFile(path) helper method

  8. abstract def requestFactory: RequestFactory

    Permalink

    The factory used to create requests for this application.

  9. abstract def requestHandler: HttpRequestHandler

    Permalink

    The HTTP request handler

  10. abstract def stop(): Future[_]

    Permalink

    Stop the application.

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

Concrete 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def asJava: play.Application

    Permalink

    Return the application as a Java application.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. lazy val globalApplicationEnabled: Boolean

    Permalink

    Returns true if the global application is enabled for this app.

    Returns true if the global application is enabled for this app. If set to false, this changes the behavior of Play.start, Play.current, and Play.maybeApplication to disallow access to the global application instance, also affecting the deprecated Play APIs that use these.

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def injector: Injector

    Permalink

    Get the runtime injector for this application.

    Get the runtime injector for this application. In a runtime dependency injection based application, this can be used to obtain components as bound by the DI framework.

    returns

    The injector.

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def mode: Mode

    Permalink

    Dev, Prod or Test

  16. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. 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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#getExistingFile instead

  2. 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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#getFile instead

  3. 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/logback.xml configuration file:

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

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

    returns

    the resource URL, if found

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#resource instead

  4. 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/logback.xml configuration file:

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

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

    returns

    a stream, if found

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#resourceAsStream instead

Inherited from AnyRef

Inherited from Any

Ungrouped