The application's classloader
The application's classloader
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
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
Dev
, Prod
or Test
Dev
, Prod
or Test
The absolute path hosting this application, mainly used by the getFile(path)
helper method
The absolute path hosting this application, mainly used by the getFile(path)
helper method
Retrieves a plugin of type T
.
Retrieves a plugin of type T
.
For example, to retrieve the DBPlugin instance:
val dbPlugin = application.plugin[DBPlugin].map(_.api).getOrElse(sys.error("problem with the plugin"))
the plugin type
The plugin instance used by this application.
if no plugins of type T are loaded by this application.
Retrieves a plugin of type T
.
Retrieves a plugin of type T
.
For example, retrieving the DBPlugin instance:
val dbPlugin = application.plugin(classOf[DBPlugin])
the plugin type
the plugin’s class
the plugin instance, wrapped in an option, used by this application
if no plugins of type T
are loaded by this application
The plugins list used by this application.
The plugins list used by this application.
Plugin classes must extend play.api.Plugin and are automatically discovered by searching for all play.plugins files in the classpath.
A play.plugins file contains a list of plugin classes to be loaded, and sorted by priority:
100:play.api.i18n.MessagesPlugin 200:play.api.db.DBPlugin 250:play.api.cache.BasicCachePlugin 300:play.db.ebean.EbeanPlugin 400:play.db.jpa.JPAPlugin 500:play.api.db.evolutions.EvolutionsPlugin 1000:play.api.libs.akka.AkkaPlugin 10000:play.api.GlobalPlugin
play.api.Plugin
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/logger.xml configuration file:
val maybeConf = application.resource("logger.xml")
the absolute name of the resource (from the classpath root)
the resource URL, if found
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/logger.xml configuration file:
val maybeConf = application.resourceAsStream("logger.xml")
the absolute name of the resource (from the classpath root)
a stream, if found
The SourceMapper
used to retrieve source code displayed in error pages
The SourceMapper
used to retrieve source code displayed in error pages