trait Application extends AnyRef
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:
val application = new DefaultApplication(new File("."), this.getClass.getClassloader, None, Play.Mode.Dev)
This will create an application using the current classloader.
- Annotations
- @implicitNotFound( ... )
- Source
- Application.scala
- Alphabetic
- By Inheritance
- Application
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
actorSystem: ActorSystem
The default ActorSystem used by the application.
-
abstract
def
classloader: ClassLoader
The application's classloader
- abstract def configuration: Configuration
-
abstract
def
coordinatedShutdown: CoordinatedShutdown
The default CoordinatedShutdown to stop the Application
-
abstract
def
environment: Environment
The application's environment
-
abstract
def
errorHandler: HttpErrorHandler
The HTTP error handler
-
implicit abstract
def
materializer: Materializer
The default Materializer used by the application.
-
abstract
def
path: File
The absolute path hosting this application, mainly used by the
getFile(path)
helper method -
abstract
def
requestFactory: RequestFactory
The factory used to create requests for this application.
-
abstract
def
requestHandler: HttpRequestHandler
The HTTP request handler
-
abstract
def
stop(): Future[_]
Stop the application.
Stop the application. The returned future will be redeemed when all stop hooks have been run.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: play.Application
Return the application as a Java application.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
lazy val
globalApplicationEnabled: Boolean
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.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
injector: Injector
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.
- returns
The injector.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
mode: Mode
Dev
,Prod
orTest
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
Deprecated Value Members
-
def
getExistingFile(relativePath: String): Option[File]
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")
- relativePath
the relative path of the file to fetch
- returns
an existing file
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use Environment#getExistingFile instead
-
def
getFile(relativePath: String): 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")
- relativePath
relative path of the file to fetch
- returns
a file instance; it is not guaranteed that the file exists
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use Environment#getFile instead
-
def
resource(name: String): Option[URL]
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")
- name
the absolute name of the resource (from the classpath root)
- returns
the resource URL, if found
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use Environment#resource instead
-
def
resourceAsStream(name: String): Option[InputStream]
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")
- name
the absolute name of the resource (from the classpath root)
- returns
a stream, if found
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use Environment#resourceAsStream instead