net.liftweb.util

Props

object Props extends Logger

Configuration management utilities.

If you want to provide a configuration file for a subset of your application or for a specific environment, Lift expects configuration files to be named in a manner relating to the context in which they are being used. The standard name format is:

  modeName.userName.hostName.props

  examples:
  dpp.yak.props
  test.dpp.yak.props
  production.moose.props
  staging.dpp.props
  test.default.props
  default.props

with hostName and userName being optional, and modeName being one of "test", "staging", "production", "pilot", "profile", or "default". The standard Lift properties file extension is "props".

Linear Supertypes
Logger, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Props
  2. Logger
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class RunModeProperty[T] extends Logger

    Exposes a property affecting run-mode determination, for customisation.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. object RunModes extends Enumeration

    Enumeration of available run modes.

  7. def _logger: Logger

    Attributes
    protected
    Definition Classes
    Logger

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def assertLog(assertion: Boolean, msg: ⇒ String): Unit

    Definition Classes
    Logger

  10. val autoDetectRunModeFn: RunModeProperty[() ⇒ Props.RunModes.Value]

    When the run.mode environment variable isn't set or recognised, this function is invoked to determine the appropriate mode to use.

    When the run.mode environment variable isn't set or recognised, this function is invoked to determine the appropriate mode to use.

    This logic can be customised by calling set before the run-mode is referenced. (An attempt to customise this after the run-mode is realised will have no effect and will instead log a warning.)

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def debug(msg: ⇒ AnyRef, t: Throwable, marker: Marker): Unit

    Definition Classes
    Logger

  13. def debug(msg: ⇒ AnyRef, marker: Marker): Unit

    Definition Classes
    Logger

  14. def debug(msg: ⇒ AnyRef, t: Throwable): Unit

    Definition Classes
    Logger

  15. def debug(msg: ⇒ AnyRef): Unit

    Definition Classes
    Logger

  16. def debug(msg: ⇒ AnyRef, box: Box[_]): Unit

    Debug a Failure.

    Debug a Failure. If the log level is debug and the Box is a Failure, debug the message concatenated with the Failure's message. If the Failure contains an Exception, debug that as well.

    Definition Classes
    Logger

  17. lazy val devMode: Boolean

    Is the system running in development mode

  18. val doesStackTraceContainKnownTestRunner: RunModeProperty[(Array[StackTraceElement]) ⇒ Boolean]

    The default run-mode auto-detection routine uses this function to infer whether Lift is being run in a test.

    The default run-mode auto-detection routine uses this function to infer whether Lift is being run in a test.

    This routine can be customised by calling set before the run-mode is referenced. (An attempt to customise this after the run-mode is realised will have no effect and will instead log a warning.)

  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  21. def error(msg: ⇒ AnyRef, t: Throwable, marker: Marker): Unit

    Definition Classes
    Logger

  22. def error(msg: ⇒ AnyRef, marker: Marker): Unit

    Definition Classes
    Logger

  23. def error(msg: ⇒ AnyRef, t: Throwable): Unit

    Definition Classes
    Logger

  24. def error(msg: ⇒ AnyRef): Unit

    Definition Classes
    Logger

  25. def error(msg: ⇒ AnyRef, box: Box[_]): Unit

    Error a Failure.

    Error a Failure. If the log level is error and the Box is a Failure, error the message concatenated with the Failure's message. If the Failure contains an Exception, error that as well.

    Definition Classes
    Logger

  26. val fileName: String

  27. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  28. def get(name: String, defVal: String): String

  29. def get(name: String): Box[String]

    Get the configuration property value for the specified key.

    Get the configuration property value for the specified key.

    name

    key for the property to get

    returns

    the value of the property if defined

  30. def getBool(name: String, defVal: Boolean): Boolean

  31. def getBool(name: String): Box[Boolean]

  32. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  33. def getInt(name: String, defVal: Int): Int

  34. def getInt(name: String): Box[Int]

  35. def getLong(name: String, defVal: Long): Long

  36. def getLong(name: String): Box[Long]

  37. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  38. lazy val hostName: String

    The resource path segment corresponding to the system hostname.

  39. lazy val inGAE: Boolean

    Is the app running in the Google App engine (the System property in.

    Is the app running in the Google App engine (the System property in.gae.j is set)

  40. def info(msg: ⇒ AnyRef, t: Throwable, marker: Marker): Unit

    Definition Classes
    Logger

  41. def info(msg: ⇒ AnyRef, marker: Marker): Unit

    Definition Classes
    Logger

  42. def info(msg: ⇒ AnyRef, t: ⇒ Throwable): Unit

    Definition Classes
    Logger

  43. def info(msg: ⇒ AnyRef): Unit

    Definition Classes
    Logger

  44. def info(msg: ⇒ AnyRef, box: Box[_]): Unit

    Info a Failure.

    Info a Failure. If the log level is info and the Box is a Failure, info the message concatenated with the Failure's message. If the Failure contains an Exception, info that as well.

    Definition Classes
    Logger

  45. def isDebugEnabled: Boolean

    Definition Classes
    Logger

  46. def isErrorEnabled: Boolean

    Definition Classes
    Logger

  47. def isInfoEnabled: Boolean

    Definition Classes
    Logger

  48. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  49. def isTraceEnabled: Boolean

    Definition Classes
    Logger

  50. def isWarnEnabled: Boolean

    Definition Classes
    Logger

  51. lazy val mode: Props.RunModes.Value

    The mode for which to retrieve properties, retrieved by System.

    The mode for which to retrieve properties, retrieved by System.getProperty("run.mode"). Recognized modes are "development", "test", "profile", "pilot", "staging" and "production" with the default run mode being development.

  52. lazy val modeName: String

    The resource path segment corresponding to the current mode.

  53. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  54. final def notify(): Unit

    Definition Classes
    AnyRef

  55. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  56. lazy val productionMode: Boolean

    Is the system running in production mode (apply full optimizations)

  57. val propFileName: String

  58. lazy val props: Map[String, String]

    The map of key/value pairs retrieved from the property file.

  59. def require(what: String*): Seq[String]

    Determine whether the specified properties exist.

    Determine whether the specified properties exist.

    what

    the properties to test

    returns

    the subset of strings in 'what' that do not correspond to keys for available properties.

  60. def requireOrDie(what: String*): Unit

    Ensure that all of the specified properties exist; throw an exception if any of the specified values are not keys for available properties.

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

    Definition Classes
    AnyRef

  62. lazy val testMode: Boolean

    Is the system running in test mode

  63. def toString(): String

    Definition Classes
    AnyRef → Any

  64. lazy val toTry: List[() ⇒ String]

    The list of paths to search for property file resources.

    The list of paths to search for property file resources. Properties files may be found at either the classpath root or in /props

  65. def trace(msg: ⇒ AnyRef, t: Throwable, marker: ⇒ Marker): Unit

    Definition Classes
    Logger

  66. def trace(msg: ⇒ AnyRef, marker: Marker): Unit

    Definition Classes
    Logger

  67. def trace(msg: ⇒ AnyRef, t: Throwable): Unit

    Definition Classes
    Logger

  68. def trace(msg: ⇒ AnyRef): Unit

    Definition Classes
    Logger

  69. def trace(msg: ⇒ AnyRef, box: Box[_]): Unit

    Trace a Failure.

    Trace a Failure. If the log level is trace and the Box is a Failure, trace the message concatenated with the Failure's message. If the Failure contains an Exception, trace that as well.

    Definition Classes
    Logger

  70. def trace[T](msg: String, v: T): T

    Log the value of v with trace and return v.

    Log the value of v with trace and return v. Useful for tracing values in expressions

    Definition Classes
    Logger

  71. lazy val userName: String

    The resource path segment corresponding to the current system user (from System.

    The resource path segment corresponding to the current system user (from System.getProperty("user.name"))

  72. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  74. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  75. def warn(msg: ⇒ AnyRef, t: Throwable, marker: Marker): Unit

    Definition Classes
    Logger

  76. def warn(msg: ⇒ AnyRef, marker: Marker): Unit

    Definition Classes
    Logger

  77. def warn(msg: ⇒ AnyRef, t: Throwable): Unit

    Definition Classes
    Logger

  78. def warn(msg: ⇒ AnyRef): Unit

    Definition Classes
    Logger

  79. def warn(msg: ⇒ AnyRef, box: Box[_]): Unit

    Warn a Failure.

    Warn a Failure. If the log level is warn and the Box is a Failure, warn the message concatenated with the Failure's message. If the Failure contains an Exception, warn that as well.

    Definition Classes
    Logger

  80. var whereToLook: () ⇒ List[(String, () ⇒ Box[InputStream])]

    This is a function that returns the first places to look for a props file.

    This is a function that returns the first places to look for a props file. The function returns a List of String -> () => Box[InputStream]. So, if you want to consult System.getProperties to look for a properties file or some such, you can set the whereToLook function in your Boot.scala file before you call anything else in Props.

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped