Package play

Class ContextBasedBuiltInComponents

java.lang.Object

play.ContextBasedBuiltInComponents

All Implemented Interfaces:

BuiltInComponents, ApplicationComponents, BaseComponents, BodyParserComponents, ConfigurationComponents, CryptoComponents, FileMimeTypesComponents, HttpComponents, HttpConfigurationComponents, HttpErrorHandlerComponents, PekkoComponents, PekkoTypedComponents, TemporaryFileComponents, I18nComponents

Direct Known Subclasses:

BuiltInComponentsFromContext

public abstract class ContextBasedBuiltInComponents
extends Object
implements BuiltInComponents

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

Constructor Summary

Constructors

Constructor	Description
ContextBasedBuiltInComponents()

Method Summary

Modifier and Type	Method	Description
ActorSystem	actorSystem()
Application	application()
ApplicationLifecycle	applicationLifecycle()
com.typesafe.config.Config	config()
abstract ApplicationLoader.Context	context()	Returns the application loader context.
CookieSigner	cookieSigner()
CoordinatedShutdown	coordinatedShutdown()
CSRFTokenSigner	csrfTokenSigner()
Optional<play.api.ApplicationLoader.DevContext>	devContext()	Helper to interact with the Play build environment.
Environment	environment()	The application environment.
FileMimeTypes	fileMimeTypes()
HttpErrorHandler	httpErrorHandler()
HttpRequestHandler	httpRequestHandler()
MappedJavaHandlerComponents	javaHandlerComponents()
Langs	langs()
Optional<play.core.SourceMapper>	sourceMapper()
Files.TemporaryFileCreator	tempFileCreator()
play.core.WebCommands	webCommands()	Commands that intercept requests before the rest of the application handles them.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface play.components.BaseComponents

router

Methods inherited from interface play.components.BodyParserComponents

anyContentBodyParser, bytesBodyParser, defaultBodyParser, defaultScalaBodyParser, emptyBodyParser, formUrlEncodedBodyParser, jsonBodyParser, multipartFormDataBodyParser, rawBodyParser, scalaBodyParsers, textBodyParser, tolerantJsonBodyParser, tolerantTextBodyParser, tolerantXmlBodyParser, xmlBodyParser

Methods inherited from interface play.BuiltInComponents

actionCreator, httpConfiguration, javaContextComponents, messagesApi

Methods inherited from interface play.components.ConfigurationComponents

configuration

Methods inherited from interface play.components.CryptoComponents

clock

Methods inherited from interface play.components.HttpComponents

httpFilters

Methods inherited from interface play.components.HttpConfigurationComponents

sessionConfiguration

Methods inherited from interface play.components.HttpErrorHandlerComponents

scalaHttpErrorHandler

Methods inherited from interface play.components.PekkoComponents

executionContext, materializer

Methods inherited from interface play.components.PekkoTypedComponents

scheduler

Constructor Details

ContextBasedBuiltInComponents

public ContextBasedBuiltInComponents()

Method Details

context

public abstract ApplicationLoader.Context context()

Returns the application loader context. The implementation should return a stable, effectively singleton value.

config

public com.typesafe.config.Config config()

Specified by:

config in interface ConfigurationComponents

environment

public Environment environment()

Description copied from interface: BaseComponents

The application environment.

Specified by:

environment in interface BaseComponents

Returns:

an instance of the application environment

sourceMapper

public Optional<play.core.SourceMapper> sourceMapper()

Specified by:

sourceMapper in interface BaseComponents

devContext

public Optional<play.api.ApplicationLoader.DevContext> devContext()

Description copied from interface: BuiltInComponents

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

Specified by:

devContext in interface BuiltInComponents

applicationLifecycle

public ApplicationLifecycle applicationLifecycle()

Specified by:

applicationLifecycle in interface BaseComponents

webCommands

public play.core.WebCommands webCommands()

Description copied from interface: BuiltInComponents

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

Specified by:

webCommands in interface BuiltInComponents

Returns:

the application web commands.

application

public Application application()

Specified by:

application in interface ApplicationComponents

langs

public Langs langs()

Specified by:

langs in interface I18nComponents

Returns:

an instance of Langs.

fileMimeTypes

public FileMimeTypes fileMimeTypes()

Specified by:

fileMimeTypes in interface FileMimeTypesComponents

javaHandlerComponents

public MappedJavaHandlerComponents javaHandlerComponents()

Specified by:

javaHandlerComponents in interface HttpComponents

httpErrorHandler

public HttpErrorHandler httpErrorHandler()

Specified by:

httpErrorHandler in interface HttpErrorHandlerComponents

httpRequestHandler

public HttpRequestHandler httpRequestHandler()

Specified by:

httpRequestHandler in interface HttpComponents

actorSystem

public ActorSystem actorSystem()

Specified by:

actorSystem in interface PekkoComponents

Specified by:

actorSystem in interface PekkoTypedComponents

coordinatedShutdown

public CoordinatedShutdown coordinatedShutdown()

Specified by:

coordinatedShutdown in interface PekkoComponents

cookieSigner

public CookieSigner cookieSigner()

Specified by:

cookieSigner in interface CryptoComponents

csrfTokenSigner

public CSRFTokenSigner csrfTokenSigner()

Specified by:

csrfTokenSigner in interface CryptoComponents

tempFileCreator

public Files.TemporaryFileCreator tempFileCreator()

Specified by:

tempFileCreator in interface TemporaryFileComponents