Application
Related Docs:
object Application
| package api
The default ActorSystem used by the application.
The application's classloader
The application's environment
The HTTP error handler
The default Materializer used by the application.
The absolute path hosting this application, mainly used by the getFile(path) helper method
The factory used to create requests for this application.
The HTTP request handler
Stop the application.
Stop the application. The returned future will be redeemed when all stop hooks have been run.
Return the application as a Java application.
Returns true if the global application is enabled for this app.
Returns true if the global application is enabled for this app. If set to false, this changes the behavior of Play.start, Play.current, and Play.maybeApplication to disallow access to the global application instance, also affecting the deprecated Play APIs that use these.
Get the runtime injector for this application.
Get the runtime injector for this application. In a runtime dependency injection based application, this can be used to obtain components as bound by the DI framework.
The injector.
Dev, Prod or Test
Retrieves a file relative to the application root path.
Retrieves a file relative to the application root path. This method returns an Option[File], using None if the file was not found.
Note that it is up to you to manage the files in the application root path in production. By default, there will be nothing available in the application root path.
For example, to retrieve some deployment specific data file:
val myDataFile = application.getExistingFile("data/data.xml")
the relative path of the file to fetch
an existing file
(Since version 2.6.0) Use Environment#getExistingFile instead
Retrieves a file relative to the application root path.
Retrieves a file relative to the application root path.
Note that it is up to you to manage the files in the application root path in production. By default, there will be nothing available in the application root path.
For example, to retrieve some deployment specific data file:
val myDataFile = application.getFile("data/data.xml")
relative path of the file to fetch
a file instance; it is not guaranteed that the file exists
(Since version 2.6.0) Use Environment#getFile instead
Scans the application classloader to retrieve a resource.
Scans the application classloader to retrieve a resource.
The conf directory is included on the classpath, so this may be used to look up resources, relative to the conf directory.
For example, to retrieve the conf/logback.xml configuration file:
val maybeConf = application.resource("logback.xml")
the absolute name of the resource (from the classpath root)
the resource URL, if found
(Since version 2.6.0) Use Environment#resource instead
Scans the application classloader to retrieve a resource’s contents as a stream.
Scans the application classloader to retrieve a resource’s contents as a stream.
The conf directory is included on the classpath, so this may be used to look up resources, relative to the conf directory.
For example, to retrieve the conf/logback.xml configuration file:
val maybeConf = application.resourceAsStream("logback.xml")
the absolute name of the resource (from the classpath root)
a stream, if found
(Since version 2.6.0) Use Environment#resourceAsStream instead
A Play application.
Application creation is handled by the framework engine.
If you need to create an ad-hoc application, for example in case of unit testing, you can easily achieve this using:
This will create an application using the current classloader.