net.liftweb.http

LiftRules

trait LiftRules extends Factory with FormVendor with LazyLoggable

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

go to: companion
linear super types: LazyLoggable, FormVendor, Factory, SimpleInjector, Injector, AnyRef, Any
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
Impl.
  1. Concrete
  2. Abstract

Type Members

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

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. 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

  9. def addToPackages (what: Package) : Unit

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

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

  10. def addToPackages (what: String) : Unit

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

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

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

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

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

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

    The default action to take when the JavaScript action fails

    The default action to take when the JavaScript action fails

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

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

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

  14. var ajaxPath : String

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

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

  15. var ajaxPostTimeout : Int

  16. var ajaxRetryCount : Box[Int]

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

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

  17. var ajaxScriptName : () ⇒ String

    The name of the Ajax script that manages Ajax requests.

    The name of the Ajax script that manages Ajax requests.

  18. 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 mayreturn HTTP 304 status indicating the client to used the cached information.

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

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

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

  20. val allowParallelSnippets : FactoryMaker[Boolean]

    Does the current context support parallel snippet execution

    Does the current context support parallel snippet execution

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

    definition classes: FormVendor
  22. def appendRequestFormBuilder [T] (builder: FormBuilderLocator[T]) : Unit

    definition classes: FormVendor
  23. def appendSessionFormBuilder [T] (builder: FormBuilderLocator[T]) : Unit

    definition classes: FormVendor
  24. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  25. lazy val asyncProviderMeta : Box[AsyncProviderMeta]

  26. var attachResourceId : (String) ⇒ String

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

    Attached 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

  27. var authentication : HttpAuthentication

    The HTTP authentication mechanism that ift will perform.

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

  28. var autoIncludeAjax : (LiftSession) ⇒ Boolean

    Tells Lift if the Ajax JavaScript shoukd be included.

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

  29. var autoIncludeComet : (LiftSession) ⇒ Boolean

    Tells Lift if the Comet JavaScript shoukd be included.

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

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

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

    Used by Lift to construct full pacakge names fromthe packages provided to addToPackages function

    Used by Lift to construct full pacakge names fromthe packages provided to addToPackages function

  32. var calcCometPath : (String) ⇒ JsExp

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

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

  33. var calcIE6ForResponse : () ⇒ Boolean

  34. var calcIEMode : () ⇒ Boolean

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

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

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

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

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

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

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

  38. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  39. val cometCreation : RulesSeq[CometCreationPF]

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

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

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

    A factory that will vend comet creators

    A factory that will vend comet creators

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

  42. var cometGetTimeout : Int

  43. def cometLogger : Logger

    Holds the CometLogger that will be used to log comet activity

    Holds the CometLogger that will be used to log comet activity

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

    Holds the CometLogger that will be used to log comet activity

    Holds the CometLogger that will be used to log comet activity

  45. var cometPath : String

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

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

  46. var cometRequestTimeout : Box[Int]

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

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

  47. var cometScriptName : () ⇒ String

    The name of the Comet script that manages Comet requests.

    The name of the Comet script that manages Comet requests.

  48. 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 mayreturn HTTP 304 status indicating the client to used the cached information.

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

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

  50. def configureLogging : () ⇒ Unit

    Holds the function that configures logging.

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

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

  52. def context : HTTPContext

    Returns the HTTPContext

    Returns the HTTPContext

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

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

  54. val convertToEntity : FactoryMaker[Boolean]

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

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

  55. val dateTimeConverter : FactoryMaker[DateTimeConverter]

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

    Obtain the resource URL by name

    Obtain the resource URL by name

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

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

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

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

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

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

  61. val deferredSnippetTimeout : FactoryMaker[NodeSeq]

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

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

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

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

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

  63. 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 automate testing

  64. val dispatch : RulesSeq[DispatchPF]

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

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

  65. var displayHelpfulSiteMapMessages_? : Boolean

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

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

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

    definition classes: FormVendor
  67. def doWithResource [T] (name: String)(f: (InputStream) ⇒ T) : Box[T]

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

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

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

    Set the doc type used.

    Set the doc type used. Use the HtmlProperties

    @deprecated

      deprecated:
    1. Use the HtmlProperties

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

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

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

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

    Execute certain functions early in a Stateful Request

    Execute certain functions early in a Stateful Request

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

    Execute certain functions early in a Stateful Request

    Execute certain functions early in a Stateful Request

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

  73. var enableContainerSessions : Boolean

  74. 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 mechanims and there will be no Ajax polling requests attempted.

  75. var encodeJSessionIdInUrl_? : Boolean

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

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

  76. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  77. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  78. var 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 calle since a default implementation is already appended.

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

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

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

  80. 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" ...

  81. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  82. 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

  83. var flipDocTypeForIE6 : Boolean

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

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

      deprecated:
    1. Replaced by dateTimeConverter

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

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  87. var getLiftSession : (Req) ⇒ LiftSession

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

    Obtain the resource URL by name

    Obtain the resource URL by name

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

  90. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  91. 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))

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

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

    attributes: implicit
    definition classes: SimpleInjectorInjector
  94. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  95. var jsArtifacts : JSArtifacts

    Holds the JS library specific UI artifacts.

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

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

  97. val lazySnippetTimeout : FactoryMaker[TimeSpan]

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

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

  98. lazy val liftBuildDate : Date

  99. var liftCoreResourceName : String

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

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

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

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

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

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

  103. 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 folowing parameters:

    • Element label,
    • The Element itselft,
    • The attrbutes
    • The child nodes
    • The page name
  • lazy val liftVersion : String

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

    Obtain the resource as an array of bytes by name

    Obtain the resource as an array of bytes by name

  • def loadResourceAsString (name: String) : Box[String]

    Obtain the resource as a String by name

    Obtain the resource as a String by name

  • 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 TemplateFinder object instead.

      see also:
    1. TemplateFinder

  • var localeCalculator : (Box[HTTPRequest]) ⇒ Locale

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

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

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

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

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

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

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

  • 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:
    1. RequestVar#logUnreadVal

  • var loggedInTest : Box[() ⇒ Boolean]

    Put a test for being logged in into this function

    Put a test for being logged in into this function

  • lazy val logger : Logger

    attributes: protected
    definition classes: LazyLoggable
  • 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.

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

  • 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

  • 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

  • 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

  • def mimeHeaders : Box[Map[String, List[String]]]

    Returns any mimeHeaders for the currently invoked handleMimeFile.

    Returns any mimeHeaders for the currently invoked handleMimeFile.

  • def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  • 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

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

  • def noticesContainerId : String

  • 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 responsability 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.

  • 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:
    1. net.liftweb.builtin.snippet.Msgs

  • def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  • def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  • val onBeginServicing : RulesSeq[(Req) ⇒ Unit]

    Holds user function hooks when the request is about to be processed

    Holds user function hooks when the request is about to be processed

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

    Holds user function hooks when the request was processed

    Holds user function hooks when the request was processed

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

  • 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

      deprecated:
    1. Replaced by dateTimeConverter

  • var passNotFoundToChain : Boolean

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

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

  • def performTransform (in: LiftResponse) : LiftResponse

    Runs responseTransformers

    Runs responseTransformers

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

  • def prependGlobalFormBuilder [T] (builder: FormBuilderLocator[T]) : Unit

    definition classes: FormVendor
  • def prependRequestFormBuilder [T] (builder: FormBuilderLocator[T]) : Unit

    definition classes: FormVendor
  • def prependSessionFormBuilder [T] (builder: FormBuilderLocator[T]) : Unit

    definition classes: FormVendor
  • 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, ...)

  • var redirectAjaxOnSessionLoss : Boolean

    Set to false if you do not want Ajax/Comet requests that are not associated with a session to cause a page reload

    Set to false if you do not want Ajax/Comet requests that are not associated with a session to cause a page reload

  • 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
  • var renderAjaxScript : (LiftSession) ⇒ JsCmd

    Returns the JavaScript that manages Ajax requests.

    Returns the JavaScript that manages Ajax requests.

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

    Renders that JavaScript that holds Comet identification information

    Renders that JavaScript that holds Comet identification information

  • var renderCometScript : (LiftSession) ⇒ JsCmd

    Returns the JavaScript that manages Comet requests.

    Returns the JavaScript that manages Comet requests.

  • 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

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

  • val resourceBundleFactories : RulesSeq[ResourceBundleFactoryPF]

  • 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:
    1. DefaultRoutines.resourceForCurrentLoc()

  • var resourceNames : List[String]

    The base name of the resource bundle

    The base name of the resource bundle

  • var resourceServerPath : String

    The path to handle served resources

    The path to handle served resources

  • val responseTransformers : RulesSeq[(LiftResponse) ⇒ LiftResponse]

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

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

  • val rewrite : RulesSeq[RewritePF]

    Use statelessRewrite or statefuleRewrite

    Use statelessRewrite or statefuleRewrite

      deprecated:
    1. Use statelessRewrite or statefuleRewrite

  • 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
  • var serveAjaxScript : (LiftSession, Req) ⇒ Box[LiftResponse]

    Returns the Ajax script as a JavaScript response

    Returns the Ajax script as a JavaScript response

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

    Returns the Comet script as a JavaScript response

    Returns the Comet script as a JavaScript response

  • var servletAsyncProvider : (HTTPRequest) ⇒ ServletAsyncProvider

    Provides the async provider instance responsible for suspending/resuming requests

    Provides the async provider instance responsible for suspending/resuming requests

      deprecated:
    1. Register your povider via addSyncProvider

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

  • 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

  • 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

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

  • def setAjaxEnd (f: Func0[JsCmd]) : Unit

    Set the Ajax end JavaScript function.

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

  • def setAjaxStart (f: Func0[JsCmd]) : Unit

    Set the Ajax end JavaScript function.

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

  • def setContext (in: HTTPContext) : Unit

    Sets the HTTPContext

    Sets the HTTPContext

  • def setSiteMap (sm: SiteMap) : Unit

    Define the sitemap.

    Define the sitemap.

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

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

  • 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]

  • val snippetDispatch : RulesSeq[SnippetDispatchPF]

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

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

  • 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

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

  • val snippets : RulesSeq[SnippetPF]

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

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

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

  • val 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 S object is not availble yet.

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

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

  • 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

  • var stdRequestTimeout : Box[Int]

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

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

  • val stripComments : FactoryMaker[Boolean]

    Should comments be stripped from the served XHTML

    Should comments be stripped from the served XHTML

  • val suffixSplitters : RulesSeq[SplitSuffixPF]

    Determins the path parts and suffix from given path parts

    Determins the path parts and suffix from given path parts

  • var supplimentalHeaders : (HTTPResponse) ⇒ Unit

  • def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  • var templateCache : Box[TemplateCache[(Locale, List[String]), NodeSeq]]

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

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

  • var timeZoneCalculator : (Box[HTTPRequest]) ⇒ TimeZone

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

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

  • def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  • val unloadHooks : RulesSeq[() ⇒ Unit]

    Hooks to be run when LiftServlet.

    Hooks to be run when LiftServlet.destroy is called.

  • var unusedFunctionsLifeTime : Long

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

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

  • 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

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

  • val urlDecorate : RulesSeq[URLDecoratorPF]

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

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

  • 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 }

    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 }

  • 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
  • val viewDispatch : RulesSeq[ViewDispatchPF]

    Change this variable to set view dispatching

    Change this variable to set view dispatching

  • def wait () : Unit

    attributes: final
    definition classes: AnyRef
  • def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  • def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  • var xhtmlValidator : Box[XHtmlValidator]

    Define the XHTML validator

    Define the XHTML validator

  • Inherited from LazyLoggable

    Inherited from FormVendor

    Inherited from Factory

    Inherited from SimpleInjector

    Inherited from Injector

    Inherited from AnyRef

    Inherited from Any