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
  • ContextBasedBuiltInComponents
  • DefaultApplication
  • DefaultMarkerContext
  • Environment
  • Logger
  • LoggerConfigurator
  • LoggerLike
  • Logging
  • LowPriorityMarkerContextImplicits
  • MarkerContext
  • MarkerContexts
  • Mode
  • NoHttpFiltersComponents
  • OptionalDevContext
  • OptionalSourceMapper
  • OptionalSourceMapperProvider
  • Play
  • UnexpectedException
t

play.api

BuiltInComponents

trait BuiltInComponents extends I18nComponents with PekkoComponents with PekkoTypedComponents

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BuiltInComponents
  2. PekkoTypedComponents
  3. PekkoComponents
  4. I18nComponents
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def applicationLifecycle: ApplicationLifecycle

    A registry to receive application lifecycle events, e.g.

    A registry to receive application lifecycle events, e.g. to close resources when the application stops.

    Definition Classes
    BuiltInComponents → PekkoComponents
  2. abstract def configuration: Configuration

    The application's configuration.

    The application's configuration.

    Definition Classes
    BuiltInComponents → PekkoComponents → I18nComponents
  3. abstract def environment: Environment

    The application's environment, e.g.

    The application's environment, e.g. it's ClassLoader and root path.

    Definition Classes
    BuiltInComponents → PekkoComponents → I18nComponents
  4. abstract def httpFilters: Seq[EssentialFilter]

    List of filters, typically provided by mixing in play.filters.HttpFiltersComponents or play.api.NoHttpFiltersComponents.

    List of filters, typically provided by mixing in play.filters.HttpFiltersComponents or play.api.NoHttpFiltersComponents.

    In most cases you will want to mixin HttpFiltersComponents and append your own filters:

    class MyComponents(context: ApplicationLoader.Context)
  extends BuiltInComponentsFromContext(context)
  with play.filters.HttpFiltersComponents {

  lazy val loggingFilter = new LoggingFilter()
  override def httpFilters = {
    super.httpFilters :+ loggingFilter
  }
}

    If you want to filter elements out of the list, you can do the following:

    class MyComponents(context: ApplicationLoader.Context)
  extends BuiltInComponentsFromContext(context)
  with play.filters.HttpFiltersComponents {
  override def httpFilters = {
    super.httpFilters.filterNot(_.getClass == classOf[CSRFFilter])
  }
}
  5. abstract def router: Router

    The router that's used to pass requests to the correct handler.

Concrete 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. def Action: DefaultActionBuilder

    Alias method to defaultActionBuilder.

    Alias method to defaultActionBuilder. This just helps to keep the idiom of using Action when creating Routers using the built in components.

    returns

    the default action builder.

    Attributes
    protected
  5. lazy val actorSystem: ActorSystem
    Definition Classes
    PekkoComponents
  6. lazy val application: Application
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. lazy val classicActorSystemProvider: ClassicActorSystemProvider
    Definition Classes
    PekkoComponents
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. lazy val cookieSigner: CookieSigner
  11. lazy val coordinatedShutdown: CoordinatedShutdown
    Definition Classes
    PekkoComponents
  12. lazy val csrfTokenSigner: CSRFTokenSigner
  13. lazy val defaultActionBuilder: DefaultActionBuilder
  14. lazy val defaultBodyParser: BodyParser[AnyContent]
  15. def devContext: Option[DevContext]

    Helper to interact with the Play build environment.

    Helper to interact with the Play build environment. Only available in dev mode.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit lazy val executionContext: ExecutionContext
    Definition Classes
    PekkoComponents
  19. lazy val fileMimeTypes: FileMimeTypes
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. lazy val httpConfiguration: HttpConfiguration
    Definition Classes
    BuiltInComponents → I18nComponents
  23. lazy val httpErrorHandler: HttpErrorHandler
  24. lazy val httpRequestHandler: HttpRequestHandler
  25. lazy val injector: Injector

    The runtime Injector instance provided to the DefaultApplication.

    The runtime Injector instance provided to the DefaultApplication. This injector is set up to allow existing (deprecated) legacy APIs to function. It is not set up to support injecting arbitrary Play components.

  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. lazy val langs: Langs
    Definition Classes
    I18nComponents
  28. implicit lazy val materializer: Materializer
    Definition Classes
    PekkoComponents
  29. lazy val messagesApi: MessagesApi
    Definition Classes
    I18nComponents
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  33. def parse: PlayBodyParsers

    Alias method to playBodyParsers.

    Alias method to playBodyParsers.

    Attributes
    protected
  34. lazy val playBodyParsers: PlayBodyParsers
  35. lazy val requestFactory: RequestFactory
  36. implicit lazy val scheduler: Scheduler
    Definition Classes
    PekkoTypedComponents
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. lazy val tempFileCreator: TemporaryFileCreator
  39. lazy val tempFileReaper: TemporaryFileReaper
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. def webCommands: WebCommands

    Commands that intercept requests before the rest of the application handles them.

    Commands that intercept requests before the rest of the application handles them. Used by Evolutions.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. lazy val javaContextComponents: JavaContextComponents
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) Use the corresponding methods that provide MessagesApi, Langs, FileMimeTypes or HttpConfiguration

  3. def sourceMapper: Option[SourceMapper]

    Helper to locate the source code for the application.

    Helper to locate the source code for the application. Only available in dev mode.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Use devContext.map(_.sourceMapper) instead

Inherited from PekkoTypedComponents

Inherited from PekkoComponents

Inherited from I18nComponents

Inherited from AnyRef

Inherited from Any

Ungrouped