Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##: Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  def addSyncProvider(asyncMeta: AsyncProviderMeta): Unit

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

5.  def addToPackages(what: Package): Unit

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

6.  def addToPackages(what: String): Unit

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

7.  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.

8.  var ajaxDefaultFailure: Box[() => JsCmd]

   The default action to take when the JavaScript action fails

9.  var ajaxEnd: Box[() => JsCmd]

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

10.  var ajaxPostTimeout: Int
11.  var ajaxRetryCount: Box[Int]

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

12.  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.

13.  var ajaxStart: Box[() => JsCmd]

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

14.  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.

15.  val allowAttributeSnippets: FactoryMaker[() => Boolean]

    This FactoryMaker can be used to disable the little used attributeSnippets

16.  val allowParallelSnippets: FactoryMaker[Boolean]

    Does the current context support parallel snippet execution

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

    Definition Classes

    FormVendor

18.  def appendRequestFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes

    FormVendor

19.  def appendSessionFormBuilder[T](builder: FormBuilderLocator[T]): Unit

    Definition Classes

    FormVendor

20.  final def asInstanceOf[T0]: T0

    Definition Classes

    Any

21.  var assetRootPath: String

    The root path for the assets folder.

    The root path for the assets folder.

    This applies also to the URL domain, appended after the deployed context path. In app developer's work area this folder resides under the 'webapp' folder.

    For example to store asset files under 'myassets' folder, use value '/myassets/'. Assets under this configurable path follow conventions, for example the default lazy loading spinner ('ajax-loader.gif') is under 'images' folder.

    Thus the URL to the assets folder would be: 'http://<domain name>/<context path>/myassets/'

22.  lazy val asyncProviderMeta: Box[AsyncProviderMeta]

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

23.  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

24.  var attributeForRemovedEventAttributes: Option[String]

    The attribute used to expose the names of event attributes that were removed from a given element for separate processing in JS (when extractInlineJavaScript is true).

    The attribute used to expose the names of event attributes that were removed from a given element for separate processing in JS (when extractInlineJavaScript is true). By default, Lift removes event attributes and attaches those behaviors via a separate JS file, to avoid inline JS invocations so that a restrictive content security policy can be used.

    You can set this variable so that the resulting HTML will have attribute information about the removed attributes, in case you need them for e.g. CSS selector matching. The attribute will contain a space-separated list of JS attributes that were removed by Lift's processing.

    For example, if you needed to match elements with an onclick attribute in CSS, you would usually do:

    [onclick] {
      text-decoration: underline;
    }

    And have an element:

    <span onclick="jsCode()">Do something!</span>

    In Lift 3, this would not work, as the onclick attribute would be removed before HTML serialization, so your HTML would be:

    <span id="lift-event-js-F827001738725NKMEQNF">Do something!</span>

    Instead, you could set:

    LiftRules.attributeForRemovedEventAttributes = Some("data-lift-removed-attributes")

    The HTML Lift emitted would then look like:

    <span id="lift-event-js-F827001738725NKMEQNF"
          data-lift-removed-attributes="onclick">Do something!</span>

    This makes it possible to replace the old CSS with with similar matching for the data-lift-removed-attributes attribute:

    [data-lift-removed-attributes~=onclick] {
      text-decoration: underline;
    }

25.  var authentication: HttpAuthentication

    The HTTP authentication mechanism that Lift will perform.

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

26.  val autoIncludeAjaxCalc: FactoryMaker[() => (LiftSession) => Boolean]
27.  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.

28.  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.

29.  def buildPackage(end: String): List[String]

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

30.  var calcIE6ForResponse: () => Boolean
31.  var calcIEMode: () => Boolean

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

32.  var calcRequestTimeout: Box[(Req) => Int]

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

33.  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.

34.  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.

35.  val clientActorLifespan: FactoryMaker[(LiftActor) => Long]

    Server-side actors that represent client-side actor endpoints (client actors, Round Trips) need a lifespan.

    Server-side actors that represent client-side actor endpoints (client actors, Round Trips) need a lifespan. By default, it's 60 seconds, but you might want to make it longer if the client is going to get delayed by long computations that bar it from re-establishing the long polling connection

36.  def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.CloneNotSupportedException]) @native()

37.  val cometCreation: RulesSeq[CometCreationPF]

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

38.  val cometCreationFactory: FactoryMaker[(CometCreationInfo) => Box[LiftCometActor]]

    A factory that will vend comet creators

39.  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

40.  var cometGetTimeout: Int
41.  def cometLogger: Logger

    Holds the CometLogger that will be used to log comet activity

42.  var cometLoggerStringSecurer: (String) => String

    Sometimes the comet logger (which is really the Ajax logger) needs to have the string cleaned up to remove stuff like passwords.

    Sometimes the comet logger (which is really the Ajax logger) needs to have the string cleaned up to remove stuff like passwords. That's done by this function.

43.  def cometLogger_=(newLogger: Logger): Unit

    Holds the CometLogger that will be used to log comet activity

44.  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.

45.  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.

46.  var cometRequestTimeout: Box[Int]

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

47.  var cometServer: () => Option[String]

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

48.  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 lift.cometOnError with the exception; lift.cometOnError 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).

49.  def configureLogging: () => Unit

    Holds the function that configures logging.

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

50.  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

51.  var contentParsers: List[ContentParser]

    Handles the parsing of template content into NodeSeqs.

    Handles the parsing of template content into NodeSeqs. If multiple parsers are registered for the same template suffix, the first matching parser is used. This intended to be set in in Boot as it is read only once during the processing of the first template.

52.  var contentSecurityPolicyViolationReport: (ContentSecurityPolicyViolation) => Box[LiftResponse]

    Handles content security policy violation reports reported to the default reporting endpoint (see ContentSecurityPolicy.defaultReportUri).

    Handles content security policy violation reports reported to the default reporting endpoint (see ContentSecurityPolicy.defaultReportUri).

    If an Empty is returned from this function, a default 200 response will be returned. The default implementation simply logs the violation at WARN level.

53.  def context: HTTPContext

    Returns the HTTPContext

54.  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.

55.  val convertToEntity: FactoryMaker[Boolean]

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

56.  val dataAttributeProcessor: RulesSeq[DataAttributeProcessor]

    Ever wanted to add custom attribute processing to Lift? Here's your chance.

    Ever wanted to add custom attribute processing to Lift? Here's your chance. Every attribute with the data- prefix will be tested against this RulesSeq and if there's a match, then use the rule process. Simple, easy, cool.

57.  val dateTimeConverter: FactoryMaker[DateTimeConverter]
58.  def defaultGetResource(name: String): Box[URL]

    Obtain the resource URL by name

59.  var defaultHeaders: PartialFunction[(NodeSeq, Req), List[(String, String)]]
60.  def defaultLocaleCalculator(request: Box[HTTPRequest]): Locale
61.  def defaultTimeZoneCalculator(request: Box[HTTPRequest]): TimeZone
62.  val deferredSnippetFailure: FactoryMaker[(Failure) => NodeSeq]

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

63.  val deferredSnippetTimeout: FactoryMaker[NodeSeq]

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

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

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

65.  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.

66.  val dispatch: RulesSeq[DispatchPF]

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

67.  var displayHelpfulSiteMapMessages_?: Boolean

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

68.  def doWith[F, T](builder: FormBuilderLocator[T])(f: => F): F

    Definition Classes

    FormVendor

69.  def doWithResource[T](name: String)(f: (InputStream) => T): Box[T]

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

70.  def doneBoot: Boolean

    Does the LiftRules instance think it's done booting?

71.  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.

72.  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).

    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).

    DPP strongly recommends that everything that you do related to user state is done with earlyInStateful, instead of using onBeginServicing.

73.  val earlyInStateless: RulesSeq[(Box[Req]) => Unit]

    Execute certain functions early in a Stateful Request

74.  val earlyResponse: RulesSeq[(Req) => Box[LiftResponse]] with FirstBox[Req, LiftResponse]
75.  def enableCometRehydration(): Unit

    Adjusts LiftRules to allow a page's comets to "rehydrate" (i.e.

    Adjusts LiftRules to allow a page's comets to "rehydrate" (i.e. reconnect to the page) after a server restart. This works by reloading the page into an iframe and stealing all of the comets. When the refresh occurs, new comet actors will be instantiated, so beware that any state therein will NOT be reinstated. Applications utilizing this feature should be designed to reconstruct comet state from the DB, cookies, client info, etc as required.

76.  var enableContainerSessions: Boolean
77.  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.

78.  var encodeJSessionIdInUrl_?: Boolean

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

79.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

80.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

81.  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.

82.  val excludePathFromContextPathRewriting: FactoryMaker[(String) => Boolean]

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

83.  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" ...

84.  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.

85.  var extractInlineJavaScript: Boolean

    Enables or disables event attribute and script element extraction.

    Enables or disables event attribute and script element extraction.

    Lift can extract script elements and event attributes like onclick, onchange, etc, and attach the event handlers in a separate JavaScript file that is generated per-page. This allows for populating these types of JavaScript in your snippets via CSS selector transforms, without needing to allow inline scripts in your content security policy (see securityRules).

    However, there are certain scenarios where event attribute extraction cannot provide a 1-to-1 reproduction of the behavior you'd get with inline attributes or scripts; if your application hits these scenarios and you would prefer not to adjust them to work with a restrictive content security policy, you can allow inline scripts and set extractEventAttributes to false to disable event extraction.

86.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

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

    prefix

    the prefix to be added on the root relative paths. If this is Empty, the prefix will be the application context path.

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.  var funcNameGenerator: () => String

    Provides a function that returns random names for form variables, page ids, callbacks, etc.

91.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

92.  var getLiftSession: (Req) => LiftSession
93.  var getResource: (String) => Box[URL]

    Obtain the resource URL by name

94.  val guardedSettingViolationFunc: LiftRulesGuardedSetting[(SettingViolation) => Unit]
95.  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

96.  val handleUnmappedParameter: FactoryMaker[(Req, String) => Unit]

    When a parameter is received either via POST or GET and does not have a corresponding mapping on the server, the function provided by this FactoryMaker will be called with the req and parameter name.

    When a parameter is received either via POST or GET and does not have a corresponding mapping on the server, the function provided by this FactoryMaker will be called with the req and parameter name.

    By default, if the parameter looks Lift-like (i.e., it starts with an F), then we log a warning with the given parameter name and URI.

97.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

98.  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 Html5Properties instance, but you can change this.

    LiftRules.htmlProperties.default.set((r: Req) => new XHtmlInHtml5OutProperties(r.userAgent))

99.  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.

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

     Definition Classes

     SimpleInjector → Injector

101.  def installServiceRequestTimer(default: ServiceRequestTimer): Unit
102.  def installSnippetTimer(default: SnippetTimer): Unit

     Enable snippet timing and install a default snippet timer.

     Enable snippet timing and install a default snippet timer. This method can only be invoked during boot.

     This method only enables snippet timing and sets the default snippet timer. If you want to change snipping timing behavior for specific sessions or requests, you'll want to interact with the underlying FactoryMaker after its set up.

103.  final def isInstanceOf[T0]: Boolean

     Definition Classes

     Any

104.  val javaScriptSettings: FactoryMaker[() => Box[(LiftSession) => JsObj]]

     Tells Lift which JavaScript settings to use.

     Tells Lift which JavaScript settings to use. If Empty, does not include the JS settings.

105.  var jsArtifacts: JSArtifacts

     Holds the JS library specific UI artifacts.

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

     Please note that currently any setting other than JQueryArtifacts will switch you to using Lift's liftVanilla implementation, which is meant to work independent of any framework. This implementation is experimental in Lift 3.0, so use it at your own risk and make sure you test your application!

106.  var jsLogFunc: Box[(JsVar) => JsCmd]

     The JavaScript to execute to log a message on the client side when lift.logError is called.

     The JavaScript to execute to log a message on the client side when lift.logError is called.

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

     To always use alert set:

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

107.  val jsonOutputConverter: FactoryMaker[(JValue) => String]

     The function that converts a JValue to a String.

     The function that converts a JValue to a String.

     By default, use prettyRender for dev mode and compactRender for other modes.

108.  val lazySnippetTimeout: FactoryMaker[util.Helpers.TimeSpan]

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

109.  lazy val liftBuildDate: Date
110.  var liftContextRelativePath: String

     Contains the URI path under which all built-in Lift-handled requests are scoped.

     Contains the URI path under which all built-in Lift-handled requests are scoped. It does not include the context path and should not begin with a /.

111.  var liftCoreResourceName: String

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

112.  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.

113.  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.

114.  def liftPath: String

     Returns a complete URI, including the context path, under which all built-in Lift-handled requests are scoped.

115.  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)

116.  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
     

117.  lazy val liftVersion: String
118.  def loadResource(name: String): Box[Array[Byte]]

     Obtain the resource as an array of bytes by name

119.  def loadResourceAsString(name: String): Box[String]

     Obtain the resource as a String by name

120.  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

121.  var localeCalculator: (Box[HTTPRequest]) => Locale

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

122.  var localizationLookupFailureNotice: Box[(String, Locale) => Unit]

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

123.  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.

124.  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. If set to false NoOpServiceTimer is used. We should remove this setting in Lift-4 and only depend on serviceRequestTimer Defaults to true.

125.  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

126.  var loggedInTest: Box[() => Boolean]

     Put a test for being logged in into this function

127.  lazy val logger: Logger

     Attributes

     protected

     Definition Classes

     LazyLoggable

     Annotations

     @transient()

128.  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.

129.  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

130.  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

131.  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

132.  def mimeHeaders: Box[Map[String, List[String]]]

     Returns any mimeHeaders for the currently invoked handleMimeFile.

133.  final def ne(arg0: AnyRef): Boolean

     Definition Classes

     AnyRef

134.  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 lift.ajaxOnSessionLost, which can be overridden client-side for more complex work. lift.ajaxOnSessionLost reloads the page by default.

135.  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 lift.cometOnSessionLost, which can be overridden client-side for more complex work. lift.cometOnSessionLost reloads the current page by default.

136.  val noticesAutoFadeOut: FactoryMaker[(Value) => Box[(util.Helpers.TimeSpan, util.Helpers.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.

137.  def noticesContainerId: String
138.  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.

139.  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

140.  final def notify(): Unit

     Definition Classes

     AnyRef

     Annotations

     @native()

141.  final def notifyAll(): Unit

     Definition Classes

     AnyRef

     Annotations

     @native()

142.  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.

143.  val onEndServicing: RulesSeq[(Req, Box[LiftResponse]) => Unit]

     Holds user function hooks when the request was processed

144.  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.

145.  var passNotFoundToChain: Boolean

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

146.  def performTransform(in: LiftResponse): LiftResponse

     Runs responseTransformers

147.  val preAccessControlResponse_!!: RulesSeq[(Req) => Box[LiftResponse]] with FirstBox[Req, LiftResponse]
148.  def prependGlobalFormBuilder[T](builder: FormBuilderLocator[T]): Unit

     Definition Classes

     FormVendor

149.  def prependRequestFormBuilder[T](builder: FormBuilderLocator[T]): Unit

     Definition Classes

     FormVendor

150.  def prependSessionFormBuilder[T](builder: FormBuilderLocator[T]): Unit

     Definition Classes

     FormVendor

151.  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, ...)

152.  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.noAjaxSessionCmd and LiftRules.noCometSessionCmd).

153.  def registerInjection[T](f: () => T)(implicit man: Manifest[T]): Unit

     Definition Classes

     SimpleInjector

154.  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

155.  val resourceBundleFactories: RulesSeq[ResourceBundleFactoryPF]
156.  val resourceForCurrentLoc: FactoryMaker[() => List[ResourceBundle]]

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

     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()

157.  var resourceNames: List[String]

     The base name of the resource bundle

158.  var resourceServerPath: String

     The path to handle served resources

159.  val responseTransformers: RulesSeq[(LiftResponse) => LiftResponse]

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

160.  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
161.  var securityRules: () => SecurityRules

     The security rules used by Lift to secure this application.

     The security rules used by Lift to secure this application. These mostly relate to HTTPS handling and HTTP Content-Security-Policy. See the SecurityRules documentation for more.

     Once the application has started using these, they are locked in, so make sure to set them early in the boot process.

162.  val serviceRequestTimer: LiftRulesGuardedSetting[FactoryMaker[ServiceRequestTimer]]

     Handles logging of servicing a request two default implementations:

     Handles logging of servicing a request two default implementations:

     • NoOpServiceTimer that does nothing
     • StandardServiceTimer that logs time it takes to serve the request (Service request (GET) ... took ... Milliseconds). This is the default used.

     Set custom in Boot: LiftRules.installServiceRequestTimer(MyCustomServiceTimer)

163.  var servletSessionIdentifier: String

     A session identifier for net.liftweb.http.provider.servlet.HTTPServletSession.

     A session identifier for net.liftweb.http.provider.servlet.HTTPServletSession.

     Under most circumstances, you won't need to change this value. However, in some cases containers will be configured with backing datastores that don't play nice with the default value. In those cases you can change this string to get those working.

164.  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.

165.  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

166.  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

167.  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

168.  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

169.  def setContext(in: HTTPContext): Unit

     Sets the HTTPContext

170.  def setSiteMap(sm: SiteMap): Unit

     Define the sitemap.

171.  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.

172.  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.

173.  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]

174.  val snippetDispatch: RulesSeq[SnippetDispatchPF]

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

175.  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

176.  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.

177.  val snippetTimer: LiftRulesGuardedSetting[Option[FactoryMaker[SnippetTimer]]]

     Snippet timers are used to time and record the execution time of snippets.

     Snippet timers are used to time and record the execution time of snippets. We provide two default implementations for you:

     • NoOpSnippetTimer that does nothing
     • LoggingSnippetTimer that logs snippet times.

     To enable snippet timing, invoke LiftRules.installSnippetTimer. Once enabled you can use the snippet timer like a regular FactoryMaker. If you only want snippet timing for certain sessions or requests, invoke installSnippetTimer with the NoOpSnippetTimer and change the value for the sessions or requests where you want snippet timing.

     Since this is a FactoryMaker you can programmatically override it for an individual request or session as you see fit. You can also implement your own timer!

178.  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.

179.  val snippets: RulesSeq[SnippetPF]

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

180.  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.

181.  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

182.  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.) the developer will receive a notice and the operation will not complete.

183.  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.

184.  val statelessSession: FactoryMaker[(Req) => LiftSession with StatelessSession]
185.  var stdRequestTimeout: Box[Int]

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

186.  val stripComments: FactoryMaker[Boolean]

     Should comments be stripped from the served XHTML

187.  val suffixSplitters: RulesSeq[SplitSuffixPF]

     Determines the path parts and suffix from given path parts

188.  val supplementalHeaders: FactoryMaker[List[(String, String)]]

     Compute the headers to be sent to the browser in addition to anything else that's sent.

     Compute the headers to be sent to the browser in addition to anything else that's sent.

     Note that the headers for the applications SecurityRules are also set here, so if you override the supplemental headers, you should either refer back to the default set or make sure to include LiftRules.securityRules.headers.

189.  final def synchronized[T0](arg0: => T0): T0

     Definition Classes

     AnyRef

190.  val tagProcessor: RulesSeq[TagProcessor]

     Ever wanted to match on *any* arbitrary tag in your HTML and process it any way you wanted? Well, here's your chance, dude.

     Ever wanted to match on *any* arbitrary tag in your HTML and process it any way you wanted? Well, here's your chance, dude. You can capture any tag and do anything you want with it.

     Note that this set of PartialFunctions is run for **EVERY** node in the DOM so make sure it runs *FAST*.

     Also, no subsequent processing of the returned NodeSeq is done (no LiftSession.processSurroundAndInclude()) so evaluate everything you want to.

     But do avoid infinite loops, so make sure the PartialFunction actually returns true *only* when you're going to return a modified node.

     An example might be:

     case ("script", e, session) if e.getAttribute("data-serverscript").isDefined => ...

191.  var templateCache: Box[TemplateCache[(Locale, List[String]), NodeSeq]]
192.  lazy val theServletAsyncProvider: Box[(HTTPRequest) => ServletAsyncProvider]

     A function that converts the current Request into an AsyncProvider.

193.  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.

194.  var timeZoneCalculator: (Box[HTTPRequest]) => TimeZone

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

195.  def toString(): String

     Definition Classes

     AnyRef → Any

196.  val unloadHooks: RulesSeq[() => Unit]

     Hooks to be run when LiftServlet.destroy is called.

197.  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.

198.  def updateAsyncMetaList(f: (List[AsyncProviderMeta]) => List[AsyncProviderMeta]): Unit
199.  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

200.  val urlDecorate: RulesSeq[URLDecoratorPF]

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

201.  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 }

202.  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

203.  val viewDispatch: RulesSeq[ViewDispatchPF]

     Change this variable to set view dispatching

204.  final def wait(): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.InterruptedException])

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

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.InterruptedException])

206.  final def wait(arg0: Long): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.InterruptedException]) @native()

207.  var xhtmlValidator: Box[XHtmlValidator]

     Define the XHTML validator

208.  object RulesSeq