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
    → PekkoComponents
  2. abstract def configuration: Configuration

    The application's configuration.

    The application's configuration.

    Definition Classes
    → → 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
    → → 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. lazy val actorSystem: ActorSystem
    Definition Classes
    PekkoComponents
  2. lazy val application: Application
  3. lazy val classicActorSystemProvider: ClassicActorSystemProvider
    Definition Classes
    PekkoComponents
  4. lazy val cookieSigner: CookieSigner
  5. lazy val coordinatedShutdown: CoordinatedShutdown
    Definition Classes
    PekkoComponents
  6. lazy val csrfTokenSigner: CSRFTokenSigner
  7. lazy val defaultActionBuilder: DefaultActionBuilder
  8. lazy val defaultBodyParser: [AnyContent]
  9. 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.

  10. implicit lazy val executionContext: ExecutionContext
    Definition Classes
    PekkoComponents
  11. lazy val fileMimeTypes: FileMimeTypes
  12. lazy val httpConfiguration: HttpConfiguration
    Definition Classes
    → I18nComponents
  13. lazy val httpErrorHandler: HttpErrorHandler
  14. lazy val httpRequestHandler: HttpRequestHandler
  15. 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.

  16. lazy val langs: Langs
    Definition Classes
    I18nComponents
  17. implicit lazy val materializer: Materializer
    Definition Classes
    PekkoComponents
  18. lazy val messagesApi: MessagesApi
    Definition Classes
    I18nComponents
  19. lazy val playBodyParsers: PlayBodyParsers
  20. lazy val requestFactory: RequestFactory
  21. implicit lazy val scheduler: Scheduler
    Definition Classes
    PekkoTypedComponents
  22. lazy val tempFileCreator: TemporaryFileCreator
  23. lazy val tempFileReaper: TemporaryFileReaper
  24. 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. lazy val javaContextComponents: JavaContextComponents
    Annotations
    @deprecated
    Deprecated

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

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