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.

    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 cluster
    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

case class Environment(rootPath: File, classLoader: ClassLoader, mode: Mode) extends Product with Serializable

The environment for the application.

Captures concerns relating to the classloader and the filesystem for the application.

rootPath

The root path that the application is deployed at.

classLoader

The classloader that all application classes and resources can be loaded from.

mode

The mode of the application.

Source
Environment.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Environment
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Environment(rootPath: File, classLoader: ClassLoader, mode: Mode)

    rootPath

    The root path that the application is deployed at.

    classLoader

    The classloader that all application classes and resources can be loaded from.

    mode

    The mode of the application.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJava: play.Environment

    returns

    Returns the Java version for this environment.

  6. val classLoader: ClassLoader
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. 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

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

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val mode: Mode
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. 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

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

  21. val rootPath: File
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped