net.liftweb.http

LiftRules

class LiftRules extends Factory with FormVendor with LazyLoggable

LiftRules is the global object that holds all of Lift's configuration.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. LiftRules
  2. LazyLoggable
  3. FormVendor
  4. Factory
  5. SimpleInjector
  6. Injector
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LiftRules()

Type Members

  1. abstract class FactoryMaker[T] extends StackableMaker[T] with Vendor[T]

    Create an object or val that is a subclass of the FactoryMaker to generate factory for a particular class as well as define session and request specific vendors and use doWith to define the vendor just for the scope of the call.

  2. trait FirstBox[F, T] extends AnyRef

  3. abstract class Inject[T] extends StackableMaker[T] with Vendor[T]

    Create an object or val that is a subclass of the FactoryMaker to generate factory for a particular class as well as define session and request specific vendors and use doWith to define the vendor just for the scope of the call.

  4. class RulesSeq[T] extends AnyRef

    Generic container used mainly for adding functions

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 RulesSeq extends AnyRef

  7. def addSyncProvider(asyncMeta: AsyncProviderMeta): Unit

    Register an AsyncMeta provider in addition to the default Jetty6, Jetty7, and Servlet 3.

    Register an AsyncMeta provider in addition to the default Jetty6, Jetty7, and Servlet 3.0 providers

  8. def addToPackages(what: Package): Unit

    Tells Lift where to find Snippets, Views, Comet Actors and Lift ORM Model object

  9. def addToPackages(what: String): Unit

    Tells Lift where to find Snippets,Views, Comet Actors and Lift ORM Model object

  10. val afterSend: RulesSeq[(BasicResponse, HTTPResponse, List[(String, String)], Box[Req]) ⇒ Any]

    Holds user functions that are executed after the response is sent to client.

    Holds user functions that are executed after the response is sent to client. The functions' result will be ignored.

  11. var ajaxDefaultFailure: Box[() ⇒ JsCmd]

    The default action to take when the JavaScript action fails

  12. var ajaxEnd: Box[() ⇒ JsCmd]

    The JavaScript to execute at the end of an Ajax request (for example, removing the spinning working thingy)

  13. var ajaxPath: String

    Contains the Ajax URI path used by Lift to process Ajax requests.

  14. var ajaxPostTimeout: Int

  15. var ajaxRetryCount: Box[Int]

    How many times do we retry an Ajax command before calling it a failure?

  16. var ajaxScriptName: () ⇒ String

    The name of the Ajax script that manages Ajax requests.

  17. var ajaxScriptUpdateTime: (LiftSession) ⇒ Long

    Holds the last update time of the Ajax request.

    Holds the last update time of the Ajax request. Based on this server may return HTTP 304 status indicating the client to used the cached information.

  18. var ajaxStart: Box[() ⇒ JsCmd]

    The JavaScript to execute at the beginning of an Ajax request (for example, showing the spinning working thingy)

  19. val allAround: RulesSeq[LoanWrapper]

    Add functionality around all of the HTTP request/response cycle.

    Add functionality around all of the HTTP request/response cycle. This is an optimal place to get a database connection. Note that whatever is loaned at the beginning of the request will not be returned until the end of the request. It's super-important to (1) not do anything related to state or touch the request objects or anything else at the beginning or end of the loan wrapper phase; (2) make sure that your code does not throw exceptions as exceptions can cause major problems.

  20. val allowAttributeSnippets: FactoryMaker[() ⇒ Boolean]

    This FactoryMaker can be used to disable the little used attributeSnippets

  21. val allowParallelSnippets: FactoryMaker[Boolean]

    Does the current context support parallel snippet execution

  22. def appendGlobalFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes
    FormVendor
  23. def appendRequestFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes
    FormVendor
  24. def appendSessionFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes
    FormVendor
  25. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  26. lazy val asyncProviderMeta: Box[AsyncProviderMeta]

    The meta for the detected AsyncProvider given the container we're running in

  27. var attachResourceId: (String) ⇒ String

    Attaches an ID entity for resource URI specified in link or script tags.

    Attaches an ID entity for resource URI specified in link or script tags. This allows controlling browser resource caching. By default this just adds a query string parameter unique per application lifetime. More complex implementation could user per resource MD5 sequences thus "forcing" browsers to refresh the resource only when the resource file changes. Users can define other rules as well. Inside user's function it is safe to use S context as attachResourceId is called from inside the <lift:with-resource-id> snippet

  28. var authentication: HttpAuthentication

    The HTTP authentication mechanism that Lift will perform.

    The HTTP authentication mechanism that Lift will perform. See LiftRules.protectedResource

  29. val autoIncludeAjaxCalc: FactoryMaker[() ⇒ (LiftSession) ⇒ Boolean]

  30. var autoIncludeComet: (LiftSession) ⇒ Boolean

    Tells Lift if the Comet JavaScript should be included.

    Tells Lift if the Comet JavaScript should be included. By default it is set to true.

  31. val beforeSend: RulesSeq[(BasicResponse, HTTPResponse, List[(String, String)], Box[Req]) ⇒ Any]

    Holds user functions that are executed before sending the response to client.

    Holds user functions that are executed before sending the response to client. The functions' result will be ignored.

  32. def buildPackage(end: String): List[String]

    Used by Lift to construct full package names from the packages provided to addToPackages function

  33. var calcCometPath: (String) ⇒ JsExp

    Computes the Comet path by adding additional tokens on top of cometPath

  34. var calcIE6ForResponse: () ⇒ Boolean

  35. var calcIEMode: () ⇒ Boolean

    The function that calculates if the response should be rendered in IE6/7 compatibility mode

  36. var calcRequestTimeout: Box[(Req) ⇒ Int]

    Put a function that will calculate the request timeout based on the incoming request.

  37. var calculateContextPath: () ⇒ Box[String]

    If there is an alternative way of calculating the context path (by default returning Empty)

    If there is an alternative way of calculating the context path (by default returning Empty)

    If this function returns an Empty, the contextPath provided by the container will be used.

  38. var calculateXmlHeader: (NodeResponse, Node, Box[String]) ⇒ String

    An XML header is inserted at the very beginning of returned XHTML pages.

    An XML header is inserted at the very beginning of returned XHTML pages. This function defines the cases in which such a header is inserted. The function takes a NodeResponse (the LiftResponse that is converting the XML to a stream of bytes), the Node (root node of the XML), and a Box containing the content type.

  39. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  40. val cometCreation: RulesSeq[CometCreationPF]

    Partial function to allow you to build a CometActor from code rather than via reflection

  41. val cometCreationFactory: FactoryMaker[(CometCreationInfo) ⇒ Box[LiftCometActor]]

    A factory that will vend comet creators

  42. var cometFailureRetryTimeout: Long

    If a Comet request fails timeout for this period of time.

    If a Comet request fails timeout for this period of time. Default value is 10 seconds

  43. var cometGetTimeout: Int

  44. def cometLogger: Logger

    Holds the CometLogger that will be used to log comet activity

  45. def cometLogger_=(newLogger: Logger): Unit

    Holds the CometLogger that will be used to log comet activity

  46. var cometPath: String

    Contains the Comet URI path used by Lift to process Comet requests.

  47. var cometProcessingTimeout: Long

    The timeout in milliseconds of a comet ajax-request.

    The timeout in milliseconds of a comet ajax-request. Defaults to 5000 ms.

  48. var cometRenderTimeout: Long

    The timeout in milliseconds of a comet render-request.

    The timeout in milliseconds of a comet render-request. Defaults to 30000 ms.

  49. var cometRequestTimeout: Box[Int]

    If you want the AJAX request timeout to be something other than 120 seconds, put the value here

  50. var cometScriptName: () ⇒ String

    The name of the Comet script that manages Comet requests.

  51. var cometScriptUpdateTime: (LiftSession) ⇒ Long

    Holds the last update time of the Comet request.

    Holds the last update time of the Comet request. Based on this server may return HTTP 304 status indicating the client to used the cached information.

  52. var cometServer: () ⇒ String

    Calculate the Comet Server (by default, the server that the request was made on, but can do the multi-server thing as well)

  53. val cometUpdateExceptionHandler: FactoryMaker[Box[JsCmd]]

    If this is Full, comet updates (partialUpdates or reRenders) are wrapped in a try/catch statement.

    If this is Full, comet updates (partialUpdates or reRenders) are wrapped in a try/catch statement. The provided JsCmd is the body of the catch statement. Within that JsCmd, the variable "e" refers to the caught exception.

    In development mode, this defaults to Full and the command within invokes liftComet.lift_cometError with the exception; lift_cometError rethrows the exception by default. In production mode, this defaults to Empty.

    Note that if you set this to Full, it is highly advised that you rethrow the exception. If you fail to rethrow the exception, you run the risk of dropping an unpredictable number of updates (i.e., if the third of 20 updates that are sent to the client in a single response throws an exception, none of the subsequent ones will run; failing to rethrow the exception means any updates that did not run will never be run).

  54. def configureLogging: () ⇒ Unit

    Holds the function that configures logging.

    Holds the function that configures logging. Must be set before any loggers are created

  55. def configureLogging_=(newConfigurer: () ⇒ Unit): Unit

    Holds the function that configures logging.

    Holds the function that configures logging. Must be set before any loggers are created

  56. def context: HTTPContext

    Returns the HTTPContext

  57. var convertResponse: PartialFunction[(Any, List[(String, String)], List[HTTPCookie], Req), LiftResponse]

    convertResponse is a PartialFunction that reduces a given Tuple4 into a LiftResponse that can then be sent to the browser.

  58. val convertToEntity: FactoryMaker[Boolean]

    Should codes that represent entities be converted to XML entities when rendered?

  59. val dateTimeConverter: FactoryMaker[DateTimeConverter]

  60. def defaultGetResource(name: String): Box[URL]

    Obtain the resource URL by name

  61. var defaultHeaders: PartialFunction[(NodeSeq, Req), List[(String, String)]]

  62. def defaultLocaleCalculator(request: Box[HTTPRequest]): Locale

  63. def defaultTimeZoneCalculator(request: Box[HTTPRequest]): TimeZone

  64. val deferredSnippetFailure: FactoryMaker[(Failure) ⇒ NodeSeq]

    If a deferred snippet has a failure during render, what should we display?

  65. val deferredSnippetTimeout: FactoryMaker[NodeSeq]

    If a deferred snippet has a failure during render, what should we display?

  66. var determineContentType: PartialFunction[(Box[Req], Box[String]), String]

    A partial function that determines content type based on an incoming Req and Accept header

  67. var devModeFailureResponseCodeOverride: Box[Int]

    In Dev mode and Test mode, return a non-200 response code if there is an error on the page (one that would result in the red box with the error message being displayed).

    In Dev mode and Test mode, return a non-200 response code if there is an error on the page (one that would result in the red box with the error message being displayed). This helps in testing automation.

  68. val dispatch: RulesSeq[DispatchPF]

    Holds the user's DispatchPF functions that will be executed in stateful context

  69. var displayHelpfulSiteMapMessages_?: Boolean

    Set to false if you want to have 404's handled the same way in dev and production mode

  70. def doWith[F, T](builder: FormBuilderLocator[T])(f: ⇒ F): F

    Definition Classes
    FormVendor
  71. def doWithResource[T](name: String)(f: (InputStream) ⇒ T): Box[T]

    Open a resource by name and process its contents using the supplied function.

  72. def doneBoot: Boolean

    Does the LiftRules instance think it's done booting?

  73. val early: RulesSeq[(HTTPRequest) ⇒ Any]

    Holds user functions that will be executed very early in the request processing.

    Holds user functions that will be executed very early in the request processing. The functions' result will be ignored.

  74. val earlyInStateful: RulesSeq[(Box[Req]) ⇒ Unit]

    Execute certain functions early in a Stateful Request This is called early in a stateful request (one that's not serviced by a stateless REST request and one that's not marked as a stateless HTML page request).

  75. val earlyInStateless: RulesSeq[(Box[Req]) ⇒ Unit]

    Execute certain functions early in a Stateful Request

  76. val earlyResponse: RulesSeq[(Req) ⇒ Box[LiftResponse]] with FirstBox[Req, LiftResponse]

  77. var enableContainerSessions: Boolean

  78. var enableLiftGC: Boolean

    By default lift uses a garbage-collection mechanism of removing unused bound functions from LiftSesssion.

    By default lift uses a garbage-collection mechanism of removing unused bound functions from LiftSesssion. Setting this to false will disable this mechanisms and there will be no Ajax polling requests attempted.

  79. var encodeJSessionIdInUrl_?: Boolean

    Should the JSESSIONID be encoded in the URL if cookies are not supported

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

    Definition Classes
    AnyRef
  81. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  82. val exceptionHandler: RulesSeq[ExceptionHandlerPF]

    The sequence of partial functions (pattern matching) for handling converting an exception to something to be sent to the browser depending on the current RunMode (development, etc.

    The sequence of partial functions (pattern matching) for handling converting an exception to something to be sent to the browser depending on the current RunMode (development, etc.)

    By default it returns an XhtmlResponse containing a predefined markup. You can overwrite this by calling LiftRules.exceptionHandler.prepend(...). If you are calling append then your code will not be called since a default implementation is already appended.

  83. val excludePathFromContextPathRewriting: FactoryMaker[(String) ⇒ Boolean]

    Update the function here that calculates particular paths to excluded from context path rewriting

  84. var explicitlyParsedSuffixes: Set[String]

    When a request is parsed into a Req object, certain suffixes are explicitly split from the last part of the request URI.

    When a request is parsed into a Req object, certain suffixes are explicitly split from the last part of the request URI. If the suffix is contained in this list, it is explicitly split. The default list is: "html", "htm", "jpg", "png", "gif", "xml", "rss", "json" ...

  85. val externalTemplateResolver: FactoryMaker[() ⇒ PartialFunction[(Locale, List[String]), Box[NodeSeq]]]

    There may be times when you want to entirely control the templating process.

    There may be times when you want to entirely control the templating process. You can insert a function to this factory that will do your custom template resolution. If the PartialFunction isDefinedAt the given locale/path, then that's the template returned. In this way, you can return Empty for a template that's not found and the template will not be found. Otherwise, if the function is not defined for the locale/path pair, the normal templating system will be used. Also, keep in mind how FactoryMaker can be used... it can be global, per request, etc.

  86. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  87. def fixCSS(path: List[String], prefix: Box[String]): Unit

    Modifies the root relative paths from the css url-s

    Modifies the root relative paths from the css url-s

    path

    - the path of the css resource

  88. var flipDocTypeForIE6: Boolean

  89. val formAttrs: FactoryMaker[List[String]]

    If you use the form attribute in a snippet invocation, what attributes should be copied from the snippet invocation tag to the form tag.

    If you use the form attribute in a snippet invocation, what attributes should be copied from the snippet invocation tag to the form tag. The default list is "class", "id", "target", "style", "onsubmit"

  90. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  91. var getLiftSession: (Req) ⇒ LiftSession

  92. var getResource: (String) ⇒ Box[URL]

    Obtain the resource URL by name

  93. var handleMimeFile: (String, String, String, InputStream) ⇒ FileParamHolder

    The function that converts a fieldName, contentType, fileName and an InputStream into a FileParamHolder.

    The function that converts a fieldName, contentType, fileName and an InputStream into a FileParamHolder. By default, create an in-memory instance. Use OnDiskFileParamHolder to create an on-disk version

  94. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  95. val htmlProperties: FactoryMaker[(Req) ⇒ HtmlProperties]

    A unified set of properties for managing how to treat HTML, XHTML, HTML5.

    A unified set of properties for managing how to treat HTML, XHTML, HTML5. The default behavior is to return an OldHtmlPropteries instance, but you can change this to return an Html5Properties instance any you'll get HTML5 support. LiftRules.htmlProperties.default.set((r: Req) => new Html5Properties(r.userAgent))

  96. val httpAuthProtectedResource: RulesSeq[HttpAuthProtectedResourcePF]

    Defines the resources that are protected by authentication and authorization.

    Defines the resources that are protected by authentication and authorization. If this function is not defined for the input data, the resource is considered unprotected ergo no authentication is performed. If this function is defined and returns a Full box, it means that this resource is protected by authentication, and authenticated subjed must be assigned to the role returned by this function or to a role that is child-of this role. If this function returns Empty it means that this resource is protected by authentication but no authorization is performed meaning that roles are not verified.

  97. implicit def inject[T](implicit man: Manifest[T]): Box[T]

    Perform the injection for the given type.

    Perform the injection for the given type. You can call: inject[Date] or inject[List[Map[String, PaymentThing]]]. The appropriate Manifest will be

    Definition Classes
    SimpleInjectorInjector
  98. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  99. var jsArtifacts: JSArtifacts

    Holds the JS library specific UI artifacts.

    Holds the JS library specific UI artifacts. By default it uses JQuery's artifacts

  100. var jsLogFunc: Box[(JsVar) ⇒ JsCmd]

    The JavaScript to execute to log a message on the client side when liftAjax.

    The JavaScript to execute to log a message on the client side when liftAjax.lift_logError is called.

    If Empty no logging is performed The default when running in DevMode is to call lift_defaultLogError which will use JavaScript console if available or alert otherwise.

    To always use alert set:

    LiftRules.jsLogFunc = Full(v => JE.Call("alert",v).cmd)

  101. val jsonOutputConverter: FactoryMaker[(Document) ⇒ String]

    The function that converts a scala.

    The function that converts a scala.text.Document to a String (used for JsonAST.JValue to text convertion. By default, use Printer.pretty for dev mode and Printer.compact for other modes

  102. val lazySnippetTimeout: FactoryMaker[TimeSpan]

    How long should we wait for all the lazy snippets to render

  103. lazy val liftBuildDate: Date

  104. var liftCoreResourceName: String

    The base name of the resource bundle of the lift core code

  105. var liftGCFailureRetryTimeout: Long

    The polling interval for background Ajax requests to keep functions to not be garbage collected.

    The polling interval for background Ajax requests to keep functions to not be garbage collected. This will be applied if the Ajax request will fail. Default value is set to 15 seconds.

  106. var liftGCPollingInterval: Long

    The polling interval for background Ajax requests to prevent functions of being garbage collected.

    The polling interval for background Ajax requests to prevent functions of being garbage collected. Default value is set to 75 seconds.

  107. val liftRequest: RulesSeq[LiftRequestPF]

    Get the partial function that defines if a request should be handled by the application (rather than the default container handler)

  108. val liftTagProcessing: RulesSeq[LiftTagPF]

    Allows user adding additional Lift tags (the tags must be prefixed by lift namespace such as <lift:xxxx/>).

    Allows user adding additional Lift tags (the tags must be prefixed by lift namespace such as <lift:xxxx/>). Each LiftTagPF function will be called with the following parameters:

     - Element label,
     - The Element itselft,
     - The attributes
     - The child nodes
     - The page name
    

  109. lazy val liftVersion: String

  110. def loadResource(name: String): Box[Array[Byte]]

    Obtain the resource as an array of bytes by name

  111. def loadResourceAsString(name: String): Box[String]

    Obtain the resource as a String by name

  112. def loadResourceAsXml(name: String): Box[NodeSeq]

    Obtain the resource as an XML by name.

    Obtain the resource as an XML by name. If you're using this to load a template, consider using the Template object instead.

    See also

    Template

  113. var localeCalculator: (Box[HTTPRequest]) ⇒ Locale

    A function that takes the current HTTP request and returns the current

  114. var localizationLookupFailureNotice: Box[(String, Locale) ⇒ Unit]

    The function referenced here is called if there's a localization lookup failure

  115. var localizeStringToXml: (String) ⇒ NodeSeq

    A function that defines how a String should be converted to XML for the localization stuff.

    A function that defines how a String should be converted to XML for the localization stuff. By default, Text(s) is returned, but you can change this to attempt to parse the XML in the String and return the NodeSeq.

  116. var logServiceRequestTiming: Boolean

    Controls whether or not the service handling timing messages (Service request (GET) .

    Controls whether or not the service handling timing messages (Service request (GET) ... took ... Milliseconds) are logged. Defaults to true.

  117. var logUnreadRequestVars: Boolean

    This variable controls whether RequestVars that have been set but not subsequently read will be logged in Dev mode.

    This variable controls whether RequestVars that have been set but not subsequently read will be logged in Dev mode. Logging can be disabled at the per-RequestVar level via RequestVar.logUnreadVal

    See also

    RequestVar#logUnreadVal

  118. var loggedInTest: Box[() ⇒ Boolean]

    Put a test for being logged in into this function

  119. lazy val logger: Logger

    Attributes
    protected
    Definition Classes
    LazyLoggable
  120. var makeCometBreakoutDecision: (LiftSession, Req) ⇒ Unit

    A function that takes appropriate action in breaking out of any existing comet requests based on the request, browser type, etc.

  121. val maxConcurrentRequests: FactoryMaker[(Req) ⇒ Int]

    The maximum concurrent requests.

    The maximum concurrent requests. If this number of requests are being serviced for a given session, messages will be sent to all Comet requests to terminate

  122. var maxMimeFileSize: Long

    The maximum allowed size of a single file in a mime multi-part POST.

    The maximum allowed size of a single file in a mime multi-part POST. Default 7MB

  123. var maxMimeSize: Long

    The maximum allowed size of a complete mime multi-part POST.

    The maximum allowed size of a complete mime multi-part POST. Default 8MB

  124. def mimeHeaders: Box[Map[String, List[String]]]

    Returns any mimeHeaders for the currently invoked handleMimeFile.

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

    Definition Classes
    AnyRef
  126. val noAjaxSessionCmd: FactoryMaker[JsCmd]

    The JsCmd to execute when the ajax session is lost.

    The JsCmd to execute when the ajax session is lost. The ajax session is considered lost when either an ajax request comes in for a session that does not exist on the server.

    By default, we invoke liftAjax.lift_sessionLost, which can be overridden client-side for more complex work. liftAjax.lift_sessionLost reloads the page by default.

  127. val noCometSessionCmd: FactoryMaker[JsCmd]

    The JsCmd to execute when the comet session is lost.

    The JsCmd to execute when the comet session is lost. The comet session is considered lost when either (a) a comet request comes in for a session that does not exist on the server or (b) a comet request comes in for a session that has no associated comet actors (this typically happens when the server restarts).

    By default, we invoke liftComet.lift_sessionLost, which can be overridden client-side for more complex work. liftComet.lift_sessionLost redirects to LiftRules.noCometSessionPage by default for now, though noCometSessionPage is deprecated and will be replaced by a default of reloading the current page.

  128. val noticesAutoFadeOut: FactoryMaker[(Value) ⇒ Box[(TimeSpan, TimeSpan)]]

    Set the default fadeout mechanism for Lift notices.

    Set the default fadeout mechanism for Lift notices. Thus you provide a function that take a NoticeType.Value and decide the duration after which the fade out will start and the actual fadeout time. This is applicable for general notices (not associated with id-s) regardless if they are set for the page rendering, ajax response or Comet response.

  129. def noticesContainerId: String

  130. val noticesEffects: FactoryMaker[(Box[Value], String) ⇒ Box[JsCmd]]

    Use this to apply various effects to the notices.

    Use this to apply various effects to the notices. The user function receives the NoticeType and the id of the element containing the specific notice. Thus it is the function's responsibility to form the javascript code for the visual effects. This is applicable for both ajax and non ajax contexts. For notices associated with ID's the user type will receive an Empty notice type. That's because the effect is applied on the real estate holding the notices for this ID. Typically this contains a single message.

  131. var noticesToJsCmd: () ⇒ JsCmd

    This function is called to convert the current set of Notices into a JsCmd that will be executed on the client to display the Notices.

    This function is called to convert the current set of Notices into a JsCmd that will be executed on the client to display the Notices.

    See also

    net.liftweb.builtin.snippet.Msgs

  132. final def notify(): Unit

    Definition Classes
    AnyRef
  133. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  134. val onBeginServicing: RulesSeq[(Req) ⇒ Unit]

    Holds user function hooks when the request is about to be processed It's legacy from when Lift was a lot more Rails-like.

    Holds user function hooks when the request is about to be processed It's legacy from when Lift was a lot more Rails-like. It's called literally at the very beginning of the servicing of the HTTP request. The S scope is not available nor is the DB connection available in onBeginServicing. We recommend using earlyInStateful.

  135. val onEndServicing: RulesSeq[(Req, Box[LiftResponse]) ⇒ Unit]

    Holds user function hooks when the request was processed

  136. val overwrittenReponseHeaders: FactoryMaker[List[String]]

    By default, Http response headers are appended.

    By default, Http response headers are appended. However, there are some headers that should only appear once (for example "expires"). This Vendor vends the list of header responses that can only appear once.

  137. var passNotFoundToChain: Boolean

    Should pages that are not found be passed along the request processing chain to the next handler outside Lift?

  138. def performTransform(in: LiftResponse): LiftResponse

    Runs responseTransformers

  139. val preAccessControlResponse_!!: RulesSeq[(Req) ⇒ Box[LiftResponse]] with FirstBox[Req, LiftResponse]

  140. def prependGlobalFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes
    FormVendor
  141. def prependRequestFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes
    FormVendor
  142. def prependSessionFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes
    FormVendor
  143. var progressListener: (Long, Long, Int) ⇒ Unit

    The global multipart progress listener: pBytesRead - The total number of bytes, which have been read so far.

    The global multipart progress listener: pBytesRead - The total number of bytes, which have been read so far. pContentLength - The total number of bytes, which are being read. May be -1, if this number is unknown. pItems - The number of the field, which is currently being read. (0 = no item so far, 1 = first item is being read, ...)

  144. var redirectAsyncOnSessionLoss: Boolean

    Set to false if you do not want ajax/comet requests that are not associated with a session to call their respective session loss handlers (set via LiftRules.

    Set to false if you do not want ajax/comet requests that are not associated with a session to call their respective session loss handlers (set via LiftRules.noAjaxSessionCmd and LiftRules.noCometSessionCmd).

  145. def registerInjection[T](f: () ⇒ T)(implicit man: Manifest[T]): Unit

    Register a function that will inject for the given Manifest

    Register a function that will inject for the given Manifest

    Definition Classes
    SimpleInjector
  146. var renderAjaxScript: (LiftSession) ⇒ JsCmd

    Returns the JavaScript that manages Ajax requests.

  147. var renderCometPageContents: (LiftSession, Seq[CometVersionPair]) ⇒ JsCmd

    Renders that JavaScript that holds Comet identification information

  148. var renderCometScript: (LiftSession) ⇒ JsCmd

    Returns the JavaScript that manages Comet requests.

  149. var requestTimedOut: Box[(Req, Any) ⇒ Box[LiftResponse]]

    If the request times out (or returns a non-Response) you can intercept the response here and create your own response

  150. val resourceBundleFactories: RulesSeq[ResourceBundleFactoryPF]

  151. val resourceForCurrentLoc: FactoryMaker[() ⇒ List[ResourceBundle]]

    Given the current location (based on the Req.

    Given the current location (based on the Req.path.partPath), what are the resource bundles in the templates for the current page.

    See also

    DefaultRoutines.resourceForCurrentLoc()

  152. var resourceNames: List[String]

    The base name of the resource bundle

  153. var resourceServerPath: String

    The path to handle served resources

  154. val responseTransformers: RulesSeq[(LiftResponse) ⇒ LiftResponse]

    Holds the user's transformer functions allowing the user to modify a LiftResponse before sending it to client.

  155. def searchSnippetsWithRequestPath(name: String): List[String]

    Implementation for snippetNamesToSearch that looks first in a package named by taking the current template path.

    Implementation for snippetNamesToSearch that looks first in a package named by taking the current template path. For example, suppose the following is configured in Boot: LiftRules.snippetNamesToSearch.default.set(() => LiftRules.searchSnippetsWithRequestPath) LiftRules.addToPackages("com.mycompany.myapp") LiftRules.addToPackages("com.mycompany.mylib") The tag <lift:MySnippet> in template foo/bar/baz.html would search for the snippet in the following locations:

    • com.mycompany.myapp.snippet.foo.bar.MySnippet
    • com.mycompany.myapp.snippet.MySnippet
    • com.mycompany.mylib.snippet.foo.bar.MySnippet
    • com.mycompany.mylib.snippet.MySnippet
    • and then the Lift builtin snippet packages
  156. var serveAjaxScript: (LiftSession, Req) ⇒ Box[LiftResponse]

    Returns the Ajax script as a JavaScript response

  157. var serveCometScript: (LiftSession, Req) ⇒ Box[LiftResponse]

    Returns the Comet script as a JavaScript response

  158. var sessionCreator: (HTTPSession, String) ⇒ LiftSession

    A function that takes the HTTPSession and the contextPath as parameters and returns a LiftSession reference.

    A function that takes the HTTPSession and the contextPath as parameters and returns a LiftSession reference. This can be used in cases subclassing LiftSession is necessary.

  159. def sessionCreatorForMigratorySessions: (HTTPSession, String) ⇒ LiftSession

    A method that returns a function to create migratory sessions.

    A method that returns a function to create migratory sessions. If you want migratory sessions for your application, LiftRules.sessionCreator = LiftRules.sessionCreatorForMigratorySessions

  160. val sessionInactivityTimeout: FactoryMaker[Box[Long]]

    If you want to make the Lift inactivity timeout shorter than the container inactivity timeout, set the inactivity timeout here

  161. def setAjaxEnd(f: Func0[JsCmd]): Unit

    Set the Ajax end JavaScript function.

    Set the Ajax end JavaScript function. The Java-callable alternative to assigning the var ajaxEnd

  162. def setAjaxStart(f: Func0[JsCmd]): Unit

    Set the Ajax end JavaScript function.

    Set the Ajax end JavaScript function. The Java-callable alternative to assigning the var ajaxStart

  163. def setContext(in: HTTPContext): Unit

    Sets the HTTPContext

  164. def setSiteMap(sm: SiteMap): Unit

    Define the sitemap.

  165. def setSiteMapFunc(smf: () ⇒ SiteMap): Unit

    Set the sitemap to a function that will be run to generate the sitemap.

    Set the sitemap to a function that will be run to generate the sitemap.

    This allows for changing the SiteMap when in development mode and having the function re-run for each request.

    This is **NOT** a mechanism for dynamic SiteMap. This is a mechanism **ONLY** for allowing you to change the SiteMap during development. There will be significant performance penalties (serializing the service of requests... only one at a time) for changing the SiteMap.

  166. def siteMap: Box[SiteMap]

    Return the sitemap if set in Boot.

    Return the sitemap if set in Boot. If the current runMode is development mode, the sitemap may be recomputed on each page load.

  167. var siteMapFailRedirectLocation: List[String]

    The default location to send people if SiteMap access control fails.

    The default location to send people if SiteMap access control fails. The path is expressed a a List[String]

  168. val snippetDispatch: RulesSeq[SnippetDispatchPF]

    The dispatcher that takes a Snippet and converts it to a DispatchSnippet instance

  169. val snippetFailedFunc: RulesSeq[(SnippetFailure) ⇒ Unit]

    Set a snippet failure handler here.

    Set a snippet failure handler here. The class and method for the snippet are passed in

  170. var snippetNamesToSearch: FactoryMaker[(String) ⇒ List[String]]

    Function that generates variants on snippet names to search for, given the name from the template.

    Function that generates variants on snippet names to search for, given the name from the template. The default implementation just returns name :: Nil (e.g. no change). The names are searched in order. See also searchSnippetsWithRequestPath for an implementation.

  171. val snippetWhiteList: FactoryMaker[() ⇒ PartialFunction[(String, String), Box[(NodeSeq) ⇒ NodeSeq]]]

    There may be times when you want to entirely control the templating process.

    There may be times when you want to entirely control the templating process. You can insert a function that creates a white list of snippets. The white list is the exhaustive list of snippets. The snippets are class/method pairs. If the partial function is defined and the result is a Full Box, the function is run. If the Box is an EmptyBox, then the result is a snippet lookup failure. If the partial function is not defined, then the normal snippet resolution mechanism is used. Please note that in Scala a Map is PartialFunction and you can create Maps that have a default value using the withDefaultValue method.

  172. val snippets: RulesSeq[SnippetPF]

    Holds the user's snippet functions that will be executed by lift given a certain path.

  173. val statefulRewrite: RulesSeq[RewritePF]

    Holds the user's rewrite functions that can alter the URI parts and query parameters.

    Holds the user's rewrite functions that can alter the URI parts and query parameters. This rewrite takes place within the scope of the S state so SessionVars and other session-related information is available.
    Note also that rewrites should not have side effects except to memoize database query results. No side effects means that you should not change SessionVars in a rewrite.
    In general, rewrites should be considered low level access. Rather than using a rewrite to extract parameters out of a URL, you'll be much better off using SiteMap generally and Menu.param and Menu.params specifically for extracting parameters from URLs.

  174. val statelessDispatch: RulesSeq[DispatchPF]

    Holds user's DispatchPF functions that will be executed in a stateless context.

    Holds user's DispatchPF functions that will be executed in a stateless context. This means that no session will be created and no JSESSIONID cookie will be presented to the user (unless the user has presented a JSESSIONID cookie).

    This is the way to do stateless REST in Lift

  175. val statelessReqTest: RulesSeq[StatelessReqTestPF]

    Certain paths and requests within your application can be marked as stateless and if there is access to Lift's stateful facilities (setting SessionVars, updating function tables, etc.

    Certain paths and requests within your application can be marked as stateless and if there is access to Lift's stateful facilities (setting SessionVars, updating function tables, etc.) the developer will receive a notice and the operation will not complete.

  176. val statelessRewrite: RulesSeq[RewritePF]

    Holds the user's rewrite functions that can alter the URI parts and query parameters.

    Holds the user's rewrite functions that can alter the URI parts and query parameters. This rewrite is performed very early in the HTTP request cycle and may not include any state. This rewrite is meant to rewrite requests for statelessDispatch.
    Note also that rewrites should not have side effects except to memoize database query results. No side effects means that you should not change SessionVars in a rewrite.

  177. val statelessSession: FactoryMaker[(Req) ⇒ LiftSession with StatelessSession]

  178. var stdRequestTimeout: Box[Int]

    If you want the standard (non-AJAX) request timeout to be something other than 10 seconds, put the value here

  179. val stripComments: FactoryMaker[Boolean]

    Should comments be stripped from the served XHTML

  180. val suffixSplitters: RulesSeq[SplitSuffixPF]

    Determines the path parts and suffix from given path parts

  181. var supplimentalHeaders: (HTTPResponse) ⇒ Unit

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

    Definition Classes
    AnyRef
  183. var templateCache: Box[TemplateCache[(Locale, List[String]), NodeSeq]]

  184. var templateSuffixes: List[String]

    The list of suffixes that Lift looks for in templates.

    The list of suffixes that Lift looks for in templates. By default, html, xhtml, and htm

  185. lazy val theServletAsyncProvider: Box[(HTTPRequest) ⇒ ServletAsyncProvider]

    A function that converts the current Request into an AsyncProvider.

  186. var throwOnOutOfScopeVarAccess: Boolean

    Should an exception be thrown on out of scope Session and RequestVar access.

    Should an exception be thrown on out of scope Session and RequestVar access. By default, no.

  187. var timeZoneCalculator: (Box[HTTPRequest]) ⇒ TimeZone

    A function that takes the current HTTP request and returns the current

  188. def toString(): String

    Definition Classes
    AnyRef → Any
  189. val unloadHooks: RulesSeq[() ⇒ Unit]

    Hooks to be run when LiftServlet.

    Hooks to be run when LiftServlet.destroy is called.

  190. var unusedFunctionsLifeTime: Long

    If Lift garbage collection is enabled, functions that are not seen in the page for this period of time (given in milliseconds) will be discarded, hence eligible for garbage collection.

    If Lift garbage collection is enabled, functions that are not seen in the page for this period of time (given in milliseconds) will be discarded, hence eligible for garbage collection. The default value is 10 minutes.

  191. def updateAsyncMetaList(f: (List[AsyncProviderMeta]) ⇒ List[AsyncProviderMeta]): Unit

  192. val uriNotFound: RulesSeq[URINotFoundPF]

    The list of partial function for defining the behavior of what happens when URI is invalid and you're not using a site map

  193. val urlDecorate: RulesSeq[URLDecoratorPF]

    Use this PartialFunction to to automatically add static URL parameters to any URL reference from the markup of Ajax request.

  194. var useXhtmlMimeType: Boolean

    If you don't want lift to send the application/xhtml+xml mime type to those browsers that understand it, then set this to { @code false }

  195. def vendForm[T](implicit man: Manifest[T]): Box[(T, (T) ⇒ Any) ⇒ NodeSeq]

    Given a type manifest, vend a form

    Given a type manifest, vend a form

    Definition Classes
    FormVendor
  196. val viewDispatch: RulesSeq[ViewDispatchPF]

    Change this variable to set view dispatching

  197. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  198. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  199. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  200. var xhtmlValidator: Box[XHtmlValidator]

    Define the XHTML validator

Deprecated Value Members

  1. var autoIncludeAjax: (LiftSession) ⇒ Boolean

    Tells Lift if the Ajax JavaScript should be included.

    Tells Lift if the Ajax JavaScript should be included. By default it is set to true.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use autoIncludeAjaxCalc

  2. val docType: FactoryMaker[(Req) ⇒ Box[String]]

    Set the doc type used.

    Set the doc type used. Use the HtmlProperties

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use the HtmlProperties

  3. var formatDate: (Date) ⇒ String

    A function to format a Date.

    A function to format a Date... can be replaced by a function that is user-specific Replaced by dateTimeConverter

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Replaced by dateTimeConverter

  4. var noCometSessionPage: String

    Where to send the user if there's no comet session.

    Where to send the user if there's no comet session. Note that this is contingent on an unchanged LiftRules.noCometSessionCommand and on liftComet.lift_sessionLost not being overridden client-side.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5) Use LiftRules.noCometSessionCmd.

  5. var parseDate: (String) ⇒ Box[Date]

    A function that parses a String into a Date.

    A function that parses a String into a Date... can be replaced by something that's user-specific Replaced by dateTimeConverter

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Replaced by dateTimeConverter

  6. def redirectAjaxOnSessionLoss: Boolean

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5) Use redirectAsyncOnSessionLoss instead.

  7. def redirectAjaxOnSessionLoss_=(updated: Boolean): Unit

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5) Use redirectAsyncOnSessionLoss instead.

  8. val rewrite: RulesSeq[RewritePF]

    Use statelessRewrite or statefuleRewrite

    Use statelessRewrite or statefuleRewrite

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use statelessRewrite or statefuleRewrite

  9. var servletAsyncProvider: (HTTPRequest) ⇒ ServletAsyncProvider

    Provides the async provider instance responsible for suspending/resuming requests

    Provides the async provider instance responsible for suspending/resuming requests

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Register your povider via addSyncProvider

  10. def statelessDispatchTable: RulesSeq[DispatchPF]

    Holds user's DispatchPF functions that will be executed in a stateless context.

    Holds user's DispatchPF functions that will be executed in a stateless context. This means that no session will be created and no JSESSIONID cookie will be presented to the user (unless the user has presented a JSESSIONID cookie).

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use statelessDispatch

  11. val statelessTest: RulesSeq[StatelessTestPF]

    Certain paths within your application can be marked as stateless and if there is access to Lift's stateful facilities (setting SessionVars, updating function tables, etc.

    Certain paths within your application can be marked as stateless and if there is access to Lift's stateful facilities (setting SessionVars, updating function tables, etc.) the developer will receive a notice and the operation will not complete. This test has been deprecated in favor of statelessReqTest which also passes the HTTPRequest instance for testing of the user agent and other stuff.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use statelessReqTest

Inherited from LazyLoggable

Inherited from FormVendor

Inherited from Factory

Inherited from SimpleInjector

Inherited from Injector

Inherited from AnyRef

Inherited from Any