Packages

  • package root
    Definition Classes
    root
  • package play

    Play framework.

    Play framework.

    Play

    http://www.playframework.com

    Definition Classes
    root
  • package api

    Contains the public API for Scala developers.

    Contains the public API for Scala developers.

    Access the current Play application 
    import play.api.Play.current
    Read configuration 
    val poolSize = configuration.getInt("engine.pool.size")
    Use the logger 
    Logger.info("Hello!")
    Define a Plugin 
    class MyPlugin(app: Application) extends Plugin
    Create adhoc applications (for testing) 
    val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)
    Definition Classes
    play
  • package cache

    Contains the Cache access API.

    Contains the Cache access API.

    Definition Classes
    api
  • package controllers
    Definition Classes
    api
  • package data

    Contains data manipulation helpers (typically HTTP form handling)

    Contains data manipulation helpers (typically HTTP form handling)

    import play.api.data._
import play.api.data.Forms._

val taskForm = Form(
  tuple(
    "name" -> text(minLength = 3),
    "dueDate" -> date("yyyy-MM-dd"),
    "done" -> boolean
  )
)
    Definition Classes
    api
  • package db

    Contains the JDBC database access API.

    Contains the JDBC database access API.

    Example, retrieving a connection from the 'customers' datasource:

    val conn = db.getConnection("customers")
    Definition Classes
    api
  • package http

    Contains standard HTTP constants.

    Contains standard HTTP constants. For example:

    val text = ContentTypes.TEXT
val ok = Status.OK
val accept = HeaderNames.ACCEPT
    Definition Classes
    api
  • package i18n

    Contains the internationalisation API.

    Contains the internationalisation API.

    For example, translating a message:

    val msgString = Messages("items.found", items.size)
    Definition Classes
    api
  • package inject

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection support is built on JSR-330, which provides a specification for declaring how dependencies get wired to components. JSR-330 however does not address how components are provided to or located by a DI container. Play's API seeks to address this in a DI container agnostic way.

    The reason for providing this abstraction is so that Play, the modules it provides, and third party modules can all express their bindings in a way that is not specific to any one DI container.

    Components are bound in the DI container. Each binding is identified by a BindingKey, which is typically an interface that the component implements, and may be optionally qualified by a JSR-330 qualifier annotation. A binding key is bound to a BindingTarget, which describes how the implementation of the interface that the binding key represents is constructed or provided. Bindings may also be scoped using JSR-330 scope annotations.

    Bindings are provided by instances of Module.

    Out of the box, Play provides an implementation of this abstraction using Guice.

    Definition Classes
    api
    See also

    The Module class for information on how to provide bindings.

  • package internal
    Definition Classes
    api
  • package libs

    Contains various APIs that are useful while developing web applications.

    Contains various APIs that are useful while developing web applications.

    Definition Classes
    api
  • package mvc

    Contains the Controller/Action/Result API to handle HTTP requests.

    Contains the Controller/Action/Result API to handle HTTP requests.

    For example, a typical controller:

    class HomeController @Inject() (val controllerComponents: ControllerComponents) extends BaseController {

  def index = Action {
    Ok("It works!")
  }

}
    Definition Classes
    api
  • package routing
    Definition Classes
    api
  • package templates
    Definition Classes
    api
  • package test

    Contains test helpers.

    Contains test helpers.

    Definition Classes
    api
  • Application
  • ApplicationLoader
  • BuiltInComponents
  • BuiltInComponentsFromContext
  • ConfigLoader
  • Configuration
  • DefaultApplication
  • DefaultMarkerContext
  • Environment
  • Logger
  • LoggerConfigurator
  • LoggerLike
  • Logging
  • LowPriorityMarkerContextImplicits
  • MarkerContext
  • MarkerContexts
  • Mode
  • NoHttpFiltersComponents
  • OptionalDevContext
  • OptionalSourceMapper
  • OptionalSourceMapperProvider
  • Play
  • UnexpectedException
c

play.api

DefaultApplication

class DefaultApplication extends Application

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

Instance Constructors

  1. new DefaultApplication(environment: Environment, applicationLifecycle: ApplicationLifecycle, injector: Injector, configuration: Configuration, requestFactory: RequestFactory, requestHandler: HttpRequestHandler, errorHandler: HttpErrorHandler, actorSystem: ActorSystem, materializer: Materializer)
  2. new DefaultApplication(environment: Environment, applicationLifecycle: ApplicationLifecycle, injector: Injector, configuration: Configuration, requestFactory: RequestFactory, requestHandler: HttpRequestHandler, errorHandler: HttpErrorHandler, actorSystem: ActorSystem, materializer: Materializer, coordinatedShutdown: CoordinatedShutdown)
    Annotations
    @Inject()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val actorSystem: ActorSystem

    The default ActorSystem used by the application.

    The default ActorSystem used by the application.

    Definition Classes
    DefaultApplication → Application
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asJava: play.Application

    Return the application as a Java application.

    Return the application as a Java application.

    Definition Classes
    Application
  7. def classloader: ClassLoader

    The application's classloader

    The application's classloader

    Definition Classes
    DefaultApplication → Application
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val configuration: Configuration
    Definition Classes
    DefaultApplication → Application
  10. val coordinatedShutdown: CoordinatedShutdown

    The default CoordinatedShutdown to stop the Application

    The default CoordinatedShutdown to stop the Application

    Definition Classes
    DefaultApplication → Application
  11. val environment: Environment

    The application's environment

    The application's environment

    Definition Classes
    DefaultApplication → Application
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. val errorHandler: HttpErrorHandler

    The HTTP error handler

    The HTTP error handler

    Definition Classes
    DefaultApplication → Application
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. lazy val globalApplicationEnabled: Boolean

    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.

    Definition Classes
    Application
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. val injector: Injector

    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.

    Definition Classes
    DefaultApplication → Application
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val materializer: Materializer

    The default Materializer used by the application.

    The default Materializer used by the application.

    Definition Classes
    DefaultApplication → Application
  22. def mode: Mode

    Dev, Prod or Test

    Dev, Prod or Test

    Definition Classes
    Application
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def path: File

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

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

    Definition Classes
    DefaultApplication → Application
  27. val requestFactory: RequestFactory

    The factory used to create requests for this application.

    The factory used to create requests for this application.

    Definition Classes
    DefaultApplication → Application
  28. val requestHandler: HttpRequestHandler

    The HTTP request handler

    The HTTP request handler

    Definition Classes
    DefaultApplication → Application
  29. def stop(): Future[_]

    Stop the application.

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

    Definition Classes
    DefaultApplication → Application
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def getExistingFile(relativePath: String): Option[File]

    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
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#getExistingFile instead

  2. def getFile(relativePath: String): File

    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
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#getFile instead

  3. def resource(name: String): Option[URL]

    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

    Definition Classes
    Application
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#resource instead

  4. def resourceAsStream(name: String): Option[InputStream]

    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

    Definition Classes
    Application
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Environment#resourceAsStream instead

Inherited from Application

Inherited from AnyRef

Inherited from Any

Ungrouped