root
API
Generated with
root/play/play.api/BuiltInComponents

BuiltInComponents

play.api.BuiltInComponents
trait BuiltInComponents extends I18nComponents, PekkoComponents, PekkoTypedComponents

Helper to provide the Play built in components.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Abstract methods

def applicationLifecycle: ApplicationLifecycle

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

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

Attributes

def configuration: Configuration

The application's configuration.

The application's configuration.

Attributes

def environment: Environment

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

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

Attributes

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])
 }
}

Attributes

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.

Attributes

Concrete methods

protected def Action: DefaultActionBuilder

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

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

Attributes

Returns

the default action builder.

def devContext: Option[DevContext]

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

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

Attributes

protected def parse: PlayBodyParsers

Alias method to playBodyParsers.

Alias method to playBodyParsers.

Attributes

def webCommands: WebCommands

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

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

Attributes

Deprecated methods

def sourceMapper: Option[SourceMapper]

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

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

Attributes

Deprecated
true

Concrete fields

lazy val injector: Injector

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.

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.

Attributes

Deprecated fields

lazy val javaContextComponents: JavaContextComponents

Attributes

Deprecated
true

Inherited fields

lazy val actorSystem: ActorSystem

Attributes

Inherited from:
PekkoComponents
lazy val coordinatedShutdown: CoordinatedShutdown

Attributes

Inherited from:
PekkoComponents
lazy val langs: Langs

Attributes

Inherited from:
I18nComponents
lazy val messagesApi: MessagesApi

Attributes

Inherited from:
I18nComponents

Implicits

Inherited implicits

implicit lazy val executionContext: ExecutionContext

Attributes

Inherited from:
PekkoComponents
implicit lazy val materializer: Materializer

Attributes

Inherited from:
PekkoComponents
implicit lazy val scheduler: Scheduler

Attributes

Inherited from:
PekkoTypedComponents
Generated with