RuntimeEnvironment

Use information in a local build.properties file to determine runtime environment info like the package name, version, and installation path. This can be used to automatically load config files from a config/ path relative to the executable jar.

An example of how to generate a build.properties file is included in sbt standard-project: <http://github.com/twitter/standard-project>

You have to pass in an object from your package in order to identify the location of the build.properties file. The ClassLoader for the given object is used to load the buid.properties file, which is first searched for relative to the given class (class-package-name/build.properties), and if not found there, then it is searched for with an absolute path ("/build.properties").

Linear Supertypes

AnyRef, Any

Instance Constructors

new RuntimeEnvironment(obj: AnyRef)

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
var arguments: Map[String, String]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var configFile: File

Config file, as determined from this jar's runtime path, possibly overridden by a command-line option.
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] )
def findCandidateJar(paths: Seq[String], name: String, version: String): Option[String]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def initLogs(): Unit

If we don't have any loggers configured, try to get at least console output setup.
If we don't have any loggers configured, try to get at least console output setup. In all likelihood the eval'd config is going to set this to something more robust, but we at least need to see errors encountered while processing the config. We also may need to rebuild this if a config file threw an exception before getting around to setting up logging.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val jarBuild: String
val jarBuildBranchName: String
val jarBuildLastFewCommits: Seq[String]
val jarBuildRevision: String
val jarBuildScmMergeBase: String
val jarBuildScmMergeTimestamp: String
val jarBuildScmRepository: String
val jarName: String
lazy val jarPath: Option[String]

Return the path this jar was executed from.
Return the path this jar was executed from. Depends on the presence of a valid build.properties file. Will return None if it couldn't figure out the environment.
val jarVersion: String
def loadConfig[T](): T
def loadRuntimeConfig[T](): T
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parseArgs(args: List[String]): Unit

Perform baseline command-line argument parsing.
def parseSetting(arg: String, value: String): Unit
val serverInfo: ServerInfoHandler
val stageName: String
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
@throws( ... )

Related Docs: object RuntimeEnvironment | package admin

class RuntimeEnvironment extends AnyRef

Instance Constructors

new RuntimeEnvironment(obj: AnyRef)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

var arguments: Map[String, String]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

var configFile: File

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def findCandidateJar(paths: Seq[String], name: String, version: String): Option[String]

final def getClass(): Class[_]

def hashCode(): Int

def initLogs(): Unit

final def isInstanceOf[T0]: Boolean

val jarBuild: String

val jarBuildBranchName: String

val jarBuildLastFewCommits: Seq[String]

val jarBuildRevision: String

val jarBuildScmMergeBase: String

val jarBuildScmMergeTimestamp: String

val jarBuildScmRepository: String

val jarName: String

lazy val jarPath: Option[String]

val jarVersion: String

def loadConfig[T](): T

def loadRuntimeConfig[T](): T

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parseArgs(args: List[String]): Unit

def parseSetting(arg: String, value: String): Unit

val serverInfo: ServerInfoHandler

val stageName: String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped