case class Environment(rootPath: File, classLoader: ClassLoader, mode: Mode) extends Product with Serializable
The environment for the application.
Captures concerns relating to the classloader and the filesystem for the application.
- rootPath
The root path that the application is deployed at.
- classLoader
The classloader that all application classes and resources can be loaded from.
- mode
The mode of the application.
- Alphabetic
- By Inheritance
- Environment
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Environment(rootPath: File, classLoader: ClassLoader, mode: Mode)
- rootPath
The root path that the application is deployed at.
- classLoader
The classloader that all application classes and resources can be loaded from.
- mode
The mode of the application.
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.Environment
- returns
Returns the Java version for this environment.
- val classLoader: ClassLoader
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mode: Mode
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- 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
- 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
- val rootPath: File
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])