c

play.api

BuiltInComponentsFromContext

abstract class BuiltInComponentsFromContext extends ContextBasedBuiltInComponents

This helper class provides all the built-in component dependencies by trading them for a single dependency - the application loader context.

Source
ApplicationLoader.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BuiltInComponentsFromContext
  2. ContextBasedBuiltInComponents
  3. BuiltInComponents
  4. PekkoTypedComponents
  5. PekkoComponents
  6. I18nComponents
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BuiltInComponentsFromContext(context: Context)

Abstract Value Members

  1. 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])
      }
    }
    Definition Classes
    BuiltInComponents
  2. abstract def router: Router

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

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

    Definition Classes
    BuiltInComponents

Concrete Value Members

  1. lazy val actorSystem: ActorSystem
    Definition Classes
    PekkoComponents
  2. lazy val application: Application
    Definition Classes
    BuiltInComponents
  3. 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
  4. lazy val classicActorSystemProvider: ClassicActorSystemProvider
    Definition Classes
    PekkoComponents
  5. def configuration: Configuration

    The application's configuration.

    The application's configuration.

    Definition Classes
    → → → I18nComponents
  6. val context: Context
    Definition Classes
    ContextBasedBuiltInComponents
  7. lazy val controllerComponents: ControllerComponents
  8. lazy val cookieSigner: CookieSigner
    Definition Classes
    BuiltInComponents
  9. lazy val coordinatedShutdown: CoordinatedShutdown
    Definition Classes
    PekkoComponents
  10. lazy val csrfTokenSigner: CSRFTokenSigner
    Definition Classes
    BuiltInComponents
  11. lazy val defaultActionBuilder: DefaultActionBuilder
    Definition Classes
    BuiltInComponents
  12. lazy val defaultBodyParser: [AnyContent]
    Definition Classes
    BuiltInComponents
  13. 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.

    Definition Classes
    BuiltInComponents
  14. def environment: Environment

    The application's environment, e.g.

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

    Definition Classes
    → → → I18nComponents
  15. implicit lazy val executionContext: ExecutionContext
    Definition Classes
    PekkoComponents
  16. lazy val fileMimeTypes: FileMimeTypes
    Definition Classes
    BuiltInComponents
  17. lazy val httpConfiguration: HttpConfiguration
    Definition Classes
    I18nComponents
  18. lazy val httpErrorHandler: HttpErrorHandler
    Definition Classes
    BuiltInComponents
  19. lazy val httpRequestHandler: HttpRequestHandler
    Definition Classes
    BuiltInComponents
  20. 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.

    Definition Classes
    BuiltInComponents
  21. lazy val langs: Langs
    Definition Classes
    I18nComponents
  22. implicit lazy val materializer: Materializer
    Definition Classes
    PekkoComponents
  23. lazy val messagesApi: MessagesApi
    Definition Classes
    I18nComponents
  24. lazy val playBodyParsers: PlayBodyParsers
    Definition Classes
    BuiltInComponents
  25. lazy val requestFactory: RequestFactory
    Definition Classes
    BuiltInComponents
  26. implicit lazy val scheduler: Scheduler
    Definition Classes
    PekkoTypedComponents
  27. lazy val tempFileCreator: TemporaryFileCreator
    Definition Classes
    BuiltInComponents
  28. lazy val tempFileReaper: TemporaryFileReaper
    Definition Classes
    BuiltInComponents
  29. 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.

    Definition Classes
    BuiltInComponents

Deprecated Value Members

  1. lazy val javaContextComponents: JavaContextComponents
    Definition Classes
    BuiltInComponents
    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.

    Definition Classes
    BuiltInComponents
    Annotations
    @deprecated
    Deprecated

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