net.liftweb

http

package http

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

Type Members

  1. trait AbstractScreen extends Factory

    The trait that forms the basis for LiftScreen and the Screen instances in Wizard

  2. case class AcceptedResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    202 response but without body.

  3. case class ActionMessageSet(msg: List[() ⇒ Any], req: Req) extends CometMessage with Product with Serializable

  4. case class AddAListener(who: SimpleActor[Any], shouldUpdate: PartialFunction[Any, Boolean]) extends Product with Serializable

    This is a message class for use with ListenerManager and CometListener instances.

    This is a message class for use with ListenerManager and CometListener instances. The use of the shouldUpdate function is deprecated, and should instead be handled by the message processing partial functions on the CometListener instances themselves.

    See also

    ListenerManager

    CometListener

  5. case class AjaxContext(success: Box[String], failure: Box[String], responseType: AjaxType.Value) extends Product with Serializable

  6. case class AnswerQuestion(what: Any, listeners: List[(ListenerId, (AnswerRender) ⇒ Unit)]) extends CometMessage with Product with Serializable

  7. case class AnswerRender(response: XmlOrJsCmd, who: LiftCometActor, when: Long, displayAll: Boolean) extends CometMessage with Product with Serializable

  8. case class AskQuestion(what: Any, who: LiftCometActor, listeners: List[(ListenerId, (AnswerRender) ⇒ Unit)]) extends CometMessage with Product with Serializable

  9. case class AtomCategoryResponse(xml: Node) extends LiftResponse with Product with Serializable

    Returning an Atom category document.

  10. case class AtomCreatedResponse(xml: Node) extends LiftResponse with Product with Serializable

    The Atom entity was successfully created and is shown to the client.

  11. case class AtomResponse(xml: Node, addlHeaders: List[(String, String)] = XmlResponse.addlHeaders) extends XmlNodeResponse with Product with Serializable

    Returning an Atom document.

  12. case class AtomServiceResponse(xml: Node) extends LiftResponse with Product with Serializable

    Returning an Atom Service Document.

  13. case class BadGatewayResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    502 Bad Gateway

    502 Bad Gateway

    The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

  14. case class BadResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    400 Bad Request

    400 Bad Request

    Your Request was missing an important element. Use this as a last resort if the request appears incorrect.

  15. sealed trait BasicResponse extends LiftResponse

  16. trait BlankStatelessBehavior extends StatelessBehavior

    A "default" implementation of StatelessBehavior.

    A "default" implementation of StatelessBehavior. Just ignore everything and return an empty NodeSeq.

  17. final case class BodyOrInputStream(is: InputStream) extends Product with Serializable

    Holds either the body or the request input stream, depending on which was requested first

  18. trait BooleanField extends FieldIdentifier

  19. abstract class Bootable extends AnyRef

  20. final case class BreakOut() extends Product with Serializable

  21. case class CSSResponse(text: String, headers: List[(String, String)], code: Int) extends LiftResponse with Product with Serializable

  22. case class CVP(guid: String, version: Long) extends CometVersionPair with Product with Serializable

  23. trait CleanRequestVarOnSessionTransition extends AnyRef

  24. trait CometActor extends LiftActor with LiftCometActor with BindHelpers

    Takes care of the plumbing for building Comet-based Web Apps

  25. abstract class CometActorJ extends LiftActorJ with CometActor

    Subclass from this class if you're in Java-land and want a CometActor

  26. abstract class CometActorJWithCometListener extends CometActorJ with CometListener

    Subclass from this class if you want a CometActorJ with CometListeners

  27. final case class CometCreationInfo(contType: String, name: Box[String], defaultXml: NodeSeq, attributes: Map[String, String], session: LiftSession) extends Product with Serializable

    A case class that contains the information necessary to set up a CometActor

  28. trait CometListener extends CometActor

    This trait adds functionality to automatically register with a given Actor using AddAListener and RemoveAListener control messages.

    This trait adds functionality to automatically register with a given Actor using AddAListener and RemoveAListener control messages. The most typical usage would be to register with an instance of ListenerManager. You will need to provide a def/val for the

    registerWith
    
    member to control which Actor to connect to.

    See ListenerManager for a complete example.

    registerWith to control which Actor to connect to. See ListenerManager for a complete example.

    See also

    ListenerManager

  29. sealed abstract class CometMessage extends AnyRef

  30. case class CometName(name: String) extends Product with Serializable

  31. trait CometState[DeltaType <: DeltaTrait, MyType <: CometState[DeltaType, MyType]] extends AnyRef

  32. trait CometStateWithUpdate[UpdateType, DeltaType <: DeltaTrait, MyType <: CometStateWithUpdate[UpdateType, DeltaType, MyType]] extends CometState[DeltaType, MyType]

  33. trait CometVersionPair extends AnyRef

    Holds the Comet identification information

  34. trait ContainerSerializer[T] extends AnyRef

    A trait that provides *actual* serialization of a type so that the type can be stored into a container's session and be migrated across servers

  35. abstract class ContainerVar[T] extends AnyVar[T, ContainerVar[T]] with LazyLoggable

    A typesafe container for data with a lifetime nominally equivalent to the lifetime of HttpSession attributes.

    A typesafe container for data with a lifetime nominally equivalent to the lifetime of HttpSession attributes. This alternative to SessionVar keeps data in the container's session and must be serializable to support session migration. Use SessionVars unless you are using MigratoryLiftSessions.

    object MySnippetCompanion { object mySessionVar extends ContainerVar[String]("hello") }

    The standard pattern is to create a singleton object extending ContainerVar instead of creating an instance variable of a concrete ContainerVar subclass. This is preferred because ContainerVar will use the name of its instantiating class for part of its state maintenance mechanism.

    If you find it necessary to create a ContainerVar subclass of which there may be more than one instance, it is necessary to override the nameSalt() method to return a unique salt value for each instance to prevent name collisions.

  36. final case class ContentType(theType: String, subtype: String, order: Int, q: Box[Double], extension: List[(String, String)]) extends Ordered[ContentType] with Product with Serializable

    Holds information about the content type and subtype including the q parameter and extension information.

  37. class ContinueResponseException extends LiftFlowOfControlException

    This exception is used by LiftSession.

    This exception is used by LiftSession.destroySessionAndContinueInNewSession to unwind the stack so that the session can be destroyed and a new session can be created and have the balance of the continuation executed in the context of the new session.

  38. case class CreatedResponse(xml: Node, mime: String, addlHeaders: List[(String, String)] = XmlResponse.addlHeaders) extends XmlNodeResponse with Product with Serializable

    201 Created Response

    201 Created Response

    The Resource was created. We then return the resource, post-processing, to the client. Usually used with HTTP PUT.

  39. trait CssBoundLiftScreen extends LiftScreen with CssBoundScreen

  40. trait CssBoundScreen extends ScreenWizardRendered with Loggable

  41. abstract class Delta extends AnyRef

  42. trait DeltaTrait extends AnyRef

  43. trait DispatchSnippet extends AnyRef

  44. case class Error(id: Box[String], msg: NodeSeq) extends CometMessage with Product with Serializable

  45. trait Factory extends SimpleInjector

    A base trait for a Factory.

    A base trait for a Factory. A Factory is both an Injector and a collection of FactorMaker instances. The FactoryMaker instances auto-register with the Injector. This provides both concrete Maker/Vender functionality as well as Injector functionality.

  46. case class FieldBinding(fieldName: String, bindingStyle: BindingStyle) extends Product with Serializable

  47. abstract class FileParamHolder extends ParamHolder with Serializable

    A FileParamHolder contains a file uploaded via a multipart form.

  48. case class ForbiddenResponse(message: String) extends LiftResponse with HeaderDefaults with Product with Serializable

    403 Forbidden

    403 Forbidden

    The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

  49. trait FormVendor extends AnyRef

  50. class GUIDJsExp extends JsExp

    A long time ago, Lift was going to track every function/GUID combination vended to a web page with extreme granularity.

    A long time ago, Lift was going to track every function/GUID combination vended to a web page with extreme granularity. This meant that for every function/GUID vended, Lift would put that GUID in an attribute associated with the element on the page. In order to capture the GUIDs, some methods like SHtml.ajaxCall() returned a Tuple containing the GUID and the JsExp. This caused confusion and ugly code. So, the GUIDJsExp came into being. Basically, it's backward compatible with the Tuple (String, JsExp), but it functions like a JsExp (although you don't even have to call .toJsCmd because the toString method returns the expresion itself). It should make the ajaxCall()._2.toJsCmd thing into ajaxCall().

  51. abstract class GenericValidator extends XHtmlValidator with Loggable

  52. case class GoneResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    410 Resource Gone

    410 Resource Gone

    The requested Resource used to exist but no longer does.

  53. trait HeaderDefaults extends AnyRef

  54. trait HowStateful extends AnyRef

    A trait defining how stateful the session is

  55. final case class Html5Properties(userAgent: Box[String]) extends HtmlProperties with Product with Serializable

    If you're going to use HTML5, then this is the set of properties to use

  56. trait HtmlProperties extends AnyRef

    This trait encapsulates the various choices related to parsing and emitting HTML/XHTML

  57. trait IdMemoizeTransform extends (NodeSeq) ⇒ NodeSeq

    A mechanism to memoize a transformation and then re-use the most recent html and ID to redraw the content or even use an Ajax call to update the content

  58. class InMemFileParamHolder extends FileParamHolder

    This FileParamHolder stores the uploaded file directly into memory.

  59. final case class InMemoryResponse(data: Array[Byte], headers: List[(String, String)], cookies: List[HTTPCookie], code: Int) extends BasicResponse with Product with Serializable

  60. trait InsecureLiftView extends AnyRef

    If a class is to be used as a lift view (rendering from code rather than a static template) and the method names are to be used as "actions", the view must be marked as "InsecureLiftView" because there exists the ability to execute arbitrary methods based on wire content

  61. trait IntField extends FieldIdentifier

  62. case class InternalServerErrorResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    500 Internal Server Error

    500 Internal Server Error

    The server encountered an unexpected condition which prevented it from fulfilling the request.

  63. case class JavaScriptResponse(js: JsCmd, headers: List[(String, String)], cookies: List[HTTPCookie], code: Int) extends LiftResponse with Product with Serializable

    Impersonates a HTTP response having Content-Type = text/javascript

  64. class JsContext extends AjaxContext

  65. case class JsDelta(when: Long, js: JsCmd) extends Delta with Product with Serializable

  66. class JsonContext extends AjaxContext

  67. case class JsonResponse(json: JsExp, headers: List[(String, String)], cookies: List[HTTPCookie], code: Int) extends LiftResponse with Product with Serializable

  68. abstract class LiftActorJWithListenerManager extends LiftActorJ with ListenerManager

    A LiftActorJ with ListenerManager.

    A LiftActorJ with ListenerManager. Subclass this class to get a Java-usable LiftActorJ with ListenerManager

  69. trait LiftCometActor extends TypedActor[Any, Any] with ForwardableActor[Any, Any] with Dependent

  70. class LiftFilter extends ServletFilterProvider

  71. trait LiftResponse extends AnyRef

  72. class LiftRules extends Factory with FormVendor with LazyLoggable

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

  73. class LiftRulesJ extends AnyRef

  74. class LiftRulesJBridge extends AnyRef

  75. sealed trait LiftRulesMocker extends AnyRef

  76. trait LiftScreen extends AbstractScreen with StatefulSnippet with ScreenWizardRendered

  77. class LiftServlet extends Loggable

  78. class LiftSession extends LiftMerge with Loggable with HowStateful

    The LiftSession class containg the session state information

  79. trait LiftView extends AnyRef

    The preferred way to do lift views.

    The preferred way to do lift views... implement a partial function that dispatches the incoming request to an appropriate method

  80. case class Listen(when: Long, uniqueId: ListenerId, action: (AnswerRender) ⇒ Unit) extends CometMessage with Product with Serializable

  81. case class ListenerId(id: Long) extends Product with Serializable

  82. trait ListenerManager extends AnyRef

    This trait manages a set of Actors in a publish/subscribe pattern.

    This trait manages a set of Actors in a publish/subscribe pattern. When you extend your Actor with this trait, you automatically get handling for sending messages out to all subscribed Actors. Simply override the high-, medium-, or lowPriority handlers to do your message processing. When you want to update all subscribers, just call the updateListeners method. The createUpdate method is used to generate the message that you want sent to all subscribers.

    Note that the AddAListener and RemoveAListener messages (for subscription control) are processed after any highPriority or mediumPriority messages are processed, so take care to avoid overly broad matches in those handlers that might consume internal messages.

    For example, you could write a simple service to provide clock ticks using the following code:

    case object Tick
    
    object Ticker extends ListenerManager with LiftActor {
      import net.liftweb.util.ActorPing
    
      // Set up the initial tick
      ActorPing.schedule(this, Tick, 1000L)
    
      // This is a placeholder, since we're only interested
      // in Ticks
      def createUpdate = "Registered"
    
      override def mediumPriority = {
        case Tick => {
          updateListeners(Tick)
          ActorPing.schedule(this, Tick, 1000L)
    }
    }
    }
    

    A client CometActor could look like:

    class CometClock extends CometListener {
      val registerWith = Ticker
    
      ... handling code ...
    }
    

    See also

    CometListener

  83. trait MVCHelper extends DispatchPF

    Mix this trait into a class to provide support for MVC style coding.

    Mix this trait into a class to provide support for MVC style coding. Each controller line is defined as:

    serve {
      case "user" :: User(user) :: _ => "#name" #> user.firstName
    }
    

    The above code matches /user/4, loads the user with primary key 4 from the database, then applies the transform to the /user.html template replacing the node with the id "name" with the firstName of the user

  84. trait MemoizeTransform extends (NodeSeq) ⇒ NodeSeq

    Memoize the CSS Selector Transform and the most recent NodeSeq sent to the NodeSeq => NodeSeq so that when applyAgain() is called, the NodeSeq most recently used in apply() is used.

  85. class MessageState extends RedirectState

  86. case class MethodNotAllowedResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    405 Method Not Allowed

    405 Method Not Allowed

    This Resource does not allow this method. Use this when the resource can't understand the method no matter the circumstances.

  87. trait MigratorySession extends HowStateful

    Sessions that include this trait will only have access to the container's state via ContainerVars.

    Sessions that include this trait will only have access to the container's state via ContainerVars. This mode is "migratory" so that a session can migrate across app servers. In this mode, functions that access Lift state will give notifications of failure if stateful features of Lift are accessed

  88. trait NamedCometActorSnippet extends AnyRef

    This trait adds a named comet actor on the page.

    This trait adds a named comet actor on the page. *

  89. trait NamedCometActorTrait extends CometActor with Loggable

  90. class NamedCometDispatcher extends LiftActor with Loggable

    This class keeps a list of comet actors that need to update the UI

  91. case class NoContentResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    204 response but without body.

  92. trait NodeResponse extends LiftResponse

  93. final case class NodeSeqFunc(f: (NodeSeq) ⇒ NodeSeq) extends NodeSeqFuncOrSeqNodeSeqFunc with Product with Serializable

  94. sealed trait NodeSeqFuncOrSeqNodeSeqFunc extends (NodeSeq) ⇒ NodeSeq

  95. final case class NormalParamHolder(name: String, value: String) extends ParamHolder with Product with Serializable

  96. case class NotAcceptableResponse(msg: String) extends LiftResponse with HeaderDefaults with Product with Serializable

    406 Not Acceptable

    406 Not Acceptable

    This Resource does not allow this method. Use this when the resource can't understand the method no matter the circumstances.

  97. sealed trait NotFound extends AnyRef

  98. final case class NotFoundAsNode(node: NodeSeq) extends NotFound with Product with Serializable

  99. final case class NotFoundAsResponse(response: LiftResponse) extends NotFound with Product with Serializable

  100. final case class NotFoundAsTemplate(path: ParsePath) extends NotFound with Product with Serializable

  101. case class NotFoundResponse(message: String) extends LiftResponse with HeaderDefaults with Product with Serializable

    404 Not Found

    404 Not Found

    The server has not found anything matching the Request-URI.

  102. case class NotImplementedResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    501 Not Implemented

    501 Not Implemented

    The server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

  103. case class Notice(id: Box[String], msg: NodeSeq) extends CometMessage with Product with Serializable

  104. case class OkResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    200 response but without body.

  105. final case class OldHtmlProperties(userAgent: Box[String]) extends HtmlProperties with Product with Serializable

    This set of properties is based on Lift's current XHTML support

  106. class OnDiskFileParamHolder extends FileParamHolder

    This FileParamHolder stores the uploaded file in a temporary file on disk.

  107. case class OpenSearchResponse(xml: Node, addlHeaders: List[(String, String)] = XmlResponse.addlHeaders) extends XmlNodeResponse with Product with Serializable

    Returning an OpenSearch Description Document.

  108. case class OutputStreamResponse(out: (OutputStream) ⇒ Unit, size: Long, headers: List[(String, String)], cookies: List[HTTPCookie], code: Int) extends BasicResponse with Product with Serializable

    Use this response to write your data directly to the response pipe.

    Use this response to write your data directly to the response pipe. Along with StreamingResponse you have an alternative to send data to the client.

  109. trait Paginator[T] extends Loggable

    Base class for things that require pagination.

    Base class for things that require pagination. Implements a contract for supplying the correct number of browsable pages etc

    T

    the type of item being paginated

  110. trait PaginatorSnippet[T] extends Paginator[T]

    This is the paginator snippet.

    This is the paginator snippet. It provides page navigation and column sorting links. View XHTML is as follows: nav prefix (prefix is configurable by overriding def navPrefix)

    • <nav:first/> - a link to the first page
    • <nav:prev/> - a link to the previous page
    • <nav:allpages/> - individual links to all pages. The contents of this node are used to separate page links.
    • <nav:next/> - a link to the next page
    • <nav:last/> - a link to the last page
    • <nav:records/> - a description of which records are currently being displayed
    • <nav:recordsFrom/> - the first record number being displayed
    • <nav:recordsTo/> - the last record number being displayed
    • <nav:recordsCount/> - the total number of records on all pages
  111. final case class ParamCalcInfo(paramNames: List[String], params: Map[String, List[String]], uploadedFiles: List[FileParamHolder], body: Box[BodyOrInputStream]) extends Product with Serializable

  112. sealed trait ParamHolder extends Serializable

  113. case class ParsePath(partPath: List[String], suffix: String, absolute: Boolean, endSlash: Boolean) extends Product with Serializable

    The representation of an URI path

  114. case class PartialUpdateMsg(cmd: () ⇒ JsCmd) extends CometMessage with Product with Serializable

  115. case class PerformSetupComet2(initialReq: Box[Req]) extends CometMessage with Product with Serializable

  116. case class PermRedirectResponse(uri: String, request: Req, cookies: HTTPCookie*) extends LiftResponse with Product with Serializable

    301 Redirect.

  117. case class PlainTextResponse(text: String, headers: List[(String, String)], code: Int) extends LiftResponse with Product with Serializable

  118. case class ReRender(doAll: Boolean) extends CometMessage with Product with Serializable

  119. case class RedirectResponse(uri: String, request: Req, cookies: HTTPCookie*) extends LiftResponse with Product with Serializable

    302

  120. case class RedirectState(func: Box[() ⇒ Unit], msgs: (String, Value)*) extends Product with Serializable

  121. class RedirectWithState extends RedirectResponse

  122. case class RemoveAListener(who: SimpleActor[Any]) extends Product with Serializable

    This is a message class for use with ListenerManager and CometListener instances.

    This is a message class for use with ListenerManager and CometListener instances.

    See also

    ListenerManager

    CometListener

  123. trait RenderDispatch extends AnyRef

    Mix this into a StatefulSnippet if you want a defined render method.

  124. trait RenderFuncDispatch extends AnyRef

    Mix this into a StatefulSnippet if you want a defined render method.

    Mix this into a StatefulSnippet if you want a defined render method. Differs from RenderDispatch because the render method returns a NodeSeq => NodeSeq

  125. case class RenderOut(xhtml: Box[NodeSeq], fixedXhtml: Box[NodeSeq], script: Box[JsCmd], destroyScript: Box[JsCmd], ignoreHtmlOnJs: Boolean) extends Product with Serializable

    The RenderOut case class contains the rendering for the CometActor.

    The RenderOut case class contains the rendering for the CometActor. Because of the implicit conversions, RenderOut can come from

    xhtml

    is the "normal" render body

    fixedXhtml

    is the "fixed" part of the body. This is ignored unless reRender(true)

    script

    is the script to be executed on render. This is where you want to put your script

    destroyScript

    is executed when the comet widget is redrawn ( e.g., if you register drag or mouse-over or some events, you unregister them here so the page doesn't leak resources.)

    ignoreHtmlOnJs

    -- if the reason for sending the render is a Comet update, ignore the xhtml part and just run the JS commands. This is useful in IE when you need to redraw the stuff inside

    is broken in IE

  126. class Req extends HasParams with UserAgentCalculator

    Contains request information

  127. abstract class RequestMemoize[K, V] extends MemoizeVar[K, V]

    Memoize a value for the duration of the current request (and subsequent Ajax requests made as a result of viewing the page)

  128. abstract class RequestType extends Serializable

  129. abstract class RequestVar[T] extends AnyVar[T, RequestVar[T]] with HasLogUnreadVal

    A typesafe container for data with a lifetime nominally equivalent to the lifetime of a page rendered by an HTTP request.

    A typesafe container for data with a lifetime nominally equivalent to the lifetime of a page rendered by an HTTP request. RequestVars maintain their value throughout the duration of the current HTTP request and any callbacks for servicing AJAX calls associated with the rendered page. RequestVar instances have no value at the beginning of request servicing (excluding AJAX callbacks) and their value is discarded at the end of request processing. They are commonly used to share values across many snippets. Basic usage:

    object MySnippetCompanion { object myRequestVar extends RequestVar[String]("hello") }

    The standard pattern is to create a singleton object extending RequestVar instead of creating an instance variable of a concrete RequestVar subclass. This is preferred because RequestVar will use the name of its instantiating class for part of its state maintenance mechanism.

    If you find it necessary to create a RequestVar subclass of which there may be more than one instance, it is necessary to override the nameSalt() method to return a unique salt value for each instance to prevent name collisions.

  130. trait RequestVarSnapshotGroup extends AnyRef

    Create case objects that implement this trait and use the case objects to denote specific SnapshotGroups for RequestVars

  131. case class ResetContentResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    205 response but without body.

  132. final case class ResponseShortcutException(_response: () ⇒ LiftResponse, redirectTo: Box[String], doNotices: Boolean) extends LiftFlowOfControlException with Product with Serializable

  133. case class ResponseWithReason(response: LiftResponse, reason: String) extends LiftResponse with Product with Serializable

    Wraps a LiftResponse along with a HTTP reason-phrase.

    Wraps a LiftResponse along with a HTTP reason-phrase. The reason-phrase will be set in the HTTP status line after the status code as per HTTP specifications.

    response

    - the response to be wrapped

    reason

    - the reason-phrase

  134. final case class RewriteRequest(path: ParsePath, requestType: RequestType, httpRequest: HTTPRequest) extends Product with Serializable

    This case class is used for pattern matching.

    This case class is used for pattern matching. See LiftRules.statelessRewrite and LiftRules.statefulRewrite

  135. final case class RewriteResponse(path: ParsePath, params: Map[String, String], stopRewriting: Boolean) extends Product with Serializable

  136. trait S extends HasParams with Loggable with UserAgentCalculator

    An object representing the current state of the HTTP request and response.

    An object representing the current state of the HTTP request and response. It uses the DynamicVariable construct such that each thread has its own local session info without passing a huge state construct around. The S object is initialized by LiftSession on request startup.

    See also

    LiftFilter

    LiftSession

  137. trait SHtml extends AnyRef

    The SHtml object defines a suite of XHTML element generator methods to simplify the creation of markup, particularly with forms and AJAX.

  138. class SHtmlJ extends AnyRef

  139. class SHtmlJBridge extends AnyRef

  140. class SJ extends AnyRef

  141. class SJBridge extends AnyRef

  142. case class ScreenFieldInfo(field: BaseField, text: NodeSeq, help: Box[NodeSeq], input: Box[NodeSeq], binding: Box[FieldBinding], transforms: List[(BaseField) ⇒ (NodeSeq) ⇒ NodeSeq]) extends Product with Serializable

  143. trait ScreenWizardRendered extends AnyRef

  144. case class SeeOtherResponse(uri: String, request: Req, cookies: HTTPCookie*) extends LiftResponse with Product with Serializable

    303

  145. final case class SeqNodeSeqFunc(f: Seq[(NodeSeq) ⇒ NodeSeq]) extends NodeSeqFuncOrSeqNodeSeqFunc with Product with Serializable

  146. case class ServiceUnavailableResponse(retryAfter: Long) extends LiftResponse with Product with Serializable

    503 Bad Gateway

    503 Bad Gateway

    The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

  147. case class SessionInfo(session: LiftSession, userAgent: Box[String], ipAddress: Box[String], requestCnt: Int, lastAccess: Long) extends Product with Serializable

    Information about sessions

  148. abstract class SessionMemoize[K, V] extends MemoizeVar[K, V]

    Memoize a value for the duration of the user's session

  149. abstract class SessionVar[T] extends AnyVar[T, SessionVar[T]] with LazyLoggable

    A typesafe container for data with a lifetime nominally equivalent to the lifetime of HttpSession attributes.

    A typesafe container for data with a lifetime nominally equivalent to the lifetime of HttpSession attributes.

    object MySnippetCompanion { object mySessionVar extends SessionVar[String]("hello") }

    The standard pattern is to create a singleton object extending SessionVar instead of creating an instance variable of a concrete SessionVar subclass. This is preferred because SessionVar will use the name of its instantiating class for part of its state maintenance mechanism.

    If you find it necessary to create a SessionVar subclass of which there may be more than one instance, it is necessary to override the nameSalt() method to return a unique salt value for each instance to prevent name collisions.

    Note: SessionVars can be used within CometActors

  150. case class SessionWatcherInfo(sessions: Map[String, SessionInfo]) extends Product with Serializable

  151. trait SimpleController extends AnyRef

    The base trait of Controllers that handle pre-view requests

  152. trait SimpleStateful extends StatefulSnippet with Whence with RenderFuncDispatch

    The simple composition of StatefulSnippet, Whence and RenderFuncDispatch.

    The simple composition of StatefulSnippet, Whence and RenderFuncDispatch. This is the common use of stateful snippets and makes things easier.

  153. trait SimpleStatelessBehavior extends StatelessBehavior

    A simpler way to define behavior if the snippet is invoked.

    A simpler way to define behavior if the snippet is invoked. Just implement the stateless method and all methods for the snippet will use that behavior.

  154. abstract class SnapshotRequestVar[T] extends RequestVar[T]

    This subclass of RequestVars that allow the specification of a RequestVarSnapshotGroup.

    This subclass of RequestVars that allow the specification of a RequestVarSnapshotGroup. You can create a snapshot of all the members of this group in RequestVar.snapshot

  155. class SnippetExecutionException extends SnippetFailureException

    Throw this exception if there's a catostrophic failure executing a snippet

  156. abstract class SnippetFailureException extends LiftFlowOfControlException

    An abstract exception that may be thrown during page rendering.

    An abstract exception that may be thrown during page rendering. The exception is caught and the appropriate report of a SnippetError is generated

  157. abstract class SnippetPFJ extends AnyRef

  158. trait SortedPaginator[T, C] extends Paginator[T]

    In many situations you'll want to sort things in your paginated view.

    In many situations you'll want to sort things in your paginated view. SortedPaginator is a specialized paginator for doing such tasks.

    T: The type of the elements, accessed via def page within the listing snippet C: The type of the columns, used to specify sorting

  159. trait SortedPaginatorSnippet[T, C] extends SortedPaginator[T, C] with PaginatorSnippet[T]

    This trait adds snippet functionality for sorted paginators.

    This trait adds snippet functionality for sorted paginators. You can place bind points in your template for column headers, and it turns them into links That you can click to sort by that column. Simply write, e.g., <th><sort:name/></th><th><sort:email/></th> etc.

  160. class StateInStatelessException extends SnippetFailureException

  161. trait StatefulComet extends CometActor

  162. trait StatefulSnippet extends DispatchSnippet

    The same StatefulSnippet instance is used across a given page rendering.

    The same StatefulSnippet instance is used across a given page rendering.
    If the StatefulSnippet is used to render a form, a hidden field is added to the form that causes the same instance to be used on the page that is the target of the form submission.
    If you want to keep the same snippet for a page rendered via a link (<a href...>) use the StatefulSnippet.link method to create the link. This will cause the registerThisSnippet method to be called and the same instance will be used on the target page.

    class CountGame extends StatefulSnippet  {
     val dispatch: DispatchIt =  {
       case "run" => run _
    }
    
     def run(xhtml: NodeSeq): NodeSeq =  {
       if (lastGuess == number)  {
         bind("count", chooseTemplate("choose", "win", xhtml), "number" --> number, "count" --> count)
    } else  {
         bind("count", chooseTemplate("choose", "guess", xhtml),
           "input" --> text("", guess _),
           "last" --> lastGuess.map(v => if (v < number) v+" is low" else v+"is high").openOr("Make first Guess")
         )
    }
    
     private def guess(in: String)  {
       count += 1
       lastGuess = Full(toInt(in))
    }
    
     private val number = 1 + randomInt(100)
     private var lastGuess: Box[Int] = Empty
     private var count = 0
    
    }
    

  163. trait StatefulSortedPaginatorSnippet[T, C] extends SortedPaginatorSnippet[T, C]

    Sort your paginated views by using lifts functions mapping.

    Sort your paginated views by using lifts functions mapping. The only down side with this style is that your links are session specific and non-bookmarkable. If you mix this trait in to a StatefulSnippet, it should work out the box. Otherwise, implement 'registerThisSnippet.'

  164. trait StatelessBehavior extends AnyRef

    Mix this snippet into any snippet.

    Mix this snippet into any snippet. If the snippet is invoked in response to a stateless request, then the behavior method is called with the method name of the snippet (usually render, but there may be others if you specify a method after the snippet name: MySnippet.dothing).

  165. final case class StatelessReqTest(path: List[String], httpReq: HTTPRequest) extends Product with Serializable

    The data structure that contains information to determine if the request should be treated as a stateful or stateless request

  166. trait StatelessSession extends HowStateful

    Sessions that include this trait will not be retained past the current request and will give notifications of failure if stateful features of Lift are accessed

  167. final case class StreamingResponse(data: AnyRef { def read(buf: Array[Byte]): Int }, onEnd: () ⇒ Unit, size: Long, headers: List[(String, String)], cookies: List[HTTPCookie], code: Int) extends BasicResponse with Product with Serializable

  168. trait StringField extends FieldIdentifier with StringValidators

  169. case class TemporaryRedirectResponse(uri: String, request: Req, cookies: HTTPCookie*) extends LiftResponse with Product with Serializable

    307 Redirect.

  170. abstract class TransientRequestMemoize[K, V] extends MemoizeVar[K, V]

    Memoize a value for the duration of the current HTTP request

  171. abstract class TransientRequestVar[T] extends AnyVar[T, TransientRequestVar[T]] with HasLogUnreadVal

    A typesafe container for data with a lifetime strictly equal to the processing of a single HTTP request.

    A typesafe container for data with a lifetime strictly equal to the processing of a single HTTP request. Unlike ordinary RequestVar instances, TransientRequestVars will not maintain data for servicing of AJAX callbacks from a rendered page. This is useful in cases where the value stored within the RequestVar cannot safely be used across multiple requests; an example of such a value is a JTA UserTransaction which has a lifecycle strictly coupled to the actul HTTP request handling by the enclosing container.

  172. trait TransientSnippet extends AnyRef

    This trait indicates if the snippet instance should be kept around for the duration of the Request.

    This trait indicates if the snippet instance should be kept around for the duration of the Request. There are cases when you don't want a snippet to be kept around.

  173. class UnauthorizedDigestResponse extends UnauthorizedResponse

    401 Unauthorized Response.

  174. case class UnauthorizedResponse(realm: String) extends LiftResponse with Product with Serializable

    401 Unauthorized Response.

  175. case class UnknownRequest(method: String) extends RequestType with Product with Serializable

  176. case class Unlisten(uniqueId: ListenerId) extends CometMessage with Product with Serializable

  177. case class UnsupportedMediaTypeResponse() extends LiftResponse with HeaderDefaults with Product with Serializable

    415 Resource Gone

    415 Resource Gone

    The requested Resource used to exist but no longer does.

  178. case class UpdateDefaultXml(xml: NodeSeq) extends CometMessage with Product with Serializable

    Update the comet XML on each page reload in dev mode

  179. trait UserAgentCalculator extends AnyRef

  180. class VarsJ extends AnyRef

  181. class VarsJBridge extends AnyRef

    The bridge between Scala *Vars implementations and the

  182. class VectorPar2_8_x extends AnyRef

    Vector.

    Vector.par was introduced in 2.9.x , so to be able to use it in Lift builds for scala 2.8.x I am using this implicit conversion to avoid a compiler error. I fake the par method to return a simple Vector

    TODO: Remove after we no longer build for 2.8.x

  183. case class Warning(id: Box[String], msg: NodeSeq) extends CometMessage with Product with Serializable

  184. trait Whence extends AnyRef

    Mix this trait into a snippet class so that you have a convenient value to redirect back to (whence).

    Mix this trait into a snippet class so that you have a convenient value to redirect back to (whence). When you're done with the snippet, S.redirectTo(whence)

  185. case class XHTMLValidationError(msg: String, line: Int, col: Int) extends Product with Serializable

  186. final case class XHtmlInHtml5OutProperties(userAgent: Box[String]) extends HtmlProperties with Product with Serializable

    If you're going to use HTML5 out, but want XHTML in (so you can have mixed case snippet tags and you don't get the Html5 parsers obnoxious table behavior), then this is the set of properties to use

  187. trait XHtmlValidator extends (Node) ⇒ List[XHTMLValidationError]

  188. case class XhtmlResponse(out: Node, __docType: Box[String], _headers: List[(String, String)], cookies: List[HTTPCookie], code: Int, renderInIEMode: Boolean) extends NodeResponse with Product with Serializable

  189. case class XmlMimeResponse(xml: Node, mime: String, addlHeaders: List[(String, String)] = XmlResponse.addlHeaders) extends XmlNodeResponse with Product with Serializable

    Allows you to create custom 200 responses for clients using different Content-Types.

  190. trait XmlNodeResponse extends LiftResponse

  191. class XmlResponse extends XmlNodeResponse

  192. case class registerCometActor(actor: CometActor, name: Box[String]) extends Product with Serializable

    These are the message we pass around to register each named comet actor with a dispatcher that only updates the specific version it monitors

  193. case class unregisterCometActor(actor: CometActor) extends Product with Serializable

  194. trait CometListenee extends CometListener

    This is a legacy trait, left over from Lift's Scala 2.

    This is a legacy trait, left over from Lift's Scala 2.7 support. You should use or migrate to CometListener instead.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use the CometListener trait instead.

    See also

    CometListener

  195. abstract class JsonHandler extends AnyRef

    Used to handles JSON requests

    Used to handles JSON requests

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6) Use JValue=>JsCmd bindings in SHtml (such as jsonCall) instead of this.

  196. Value Members

    1. object AddAListener extends Serializable

    2. object AjaxContext extends Serializable

    3. object AjaxType extends Enumeration

    4. object AnyVar

    5. object AppXmlResponse

    6. object AskRender extends CometMessage with Product with Serializable

    7. object Bindings

      A collection of types and implicit transformations used to allow composition of page elements based upon the types of rendered objects.

      A collection of types and implicit transformations used to allow composition of page elements based upon the types of rendered objects.

      In Lift, a "snippet" is a function from NodeSeq => NodeSeq, where the argument to the function is a template, and the result is a fragment of a page to be rendered. Of course, this is a bit of an abbreviation; the snippet function also has an argument which is the application state made available from S. A DataBinding[T] is very similar in this respect; it is a function from some piece of information of type T to a function from NodeSeq => NodeSeq. Since DataBinding is strongly typed with respect to the type of information being rendered, DataBinding instances are ideal for the rendering of objects that is used to build up snippets. For example:

      import net.liftweb.http.Bindings._
      
      case class MyClass(str: String, i: Int, other: MyOtherClass)
      case class MyOtherClass(foo: String)
      
      trait MyClassBinding extends DataBinding[MyClass] {
        implicit val otherBinding: DataBinding[MyOtherClass]
      
        override def apply(entity: MyClass) = (xhtml: NodeSeq) => {
          val otherTemplate = chooseTemplate("myclass", "other", xhtml)
          bind(
            "myclass", xhtml,
            "str" -> Text("#" + entity.str + "#"),
            "i" -> Text(entity.i.toString),
            "other" -> entity.other.bind(otherTemplate)
          )
        }
      
      }
      
      object myOtherClassBinding extends DataBinding[MyOtherClass] {
        override def apply(other: MyOtherClass) = (xhtml: NodeSeq) => {
          bind("other", xhtml, "foo" -> Text("%" + other.foo + "%"))
        }
      }
      
      object MyClassConcreteBinding extends MyClassBinding {
        override val otherBinding = myOtherClassBinding
      }
      

      In this example, two classes and their associated bindings are constructed; the first binding for MyClass is abstract, needing a specific instance of DataBinding[MyOtherClass] to enable the implicit conversion needed to render the contained MyOtherClass instance. A subtemplate is selected, and the call to other.bind both necessitates the implicit conversion to a Bindings.Binder instance and applies the appropriate formatting. You can see how this usage keeps the concerns of the view and the model nicely separated, while allowing composition over object graphs.

      Please see the tests, as well as this blog post for additional details.

    8. object CSSResponse extends Serializable

    9. object ClearNotices extends CometMessage with Product with Serializable

    10. object ContainerSerializer

    11. object ContentType extends Serializable

      The ContentType companion object that has helper methods for parsing Accept headers and other things that contain multiple ContentType information.

    12. object ContinueResponseException extends Serializable

    13. object CreatedResponse extends Serializable

      201 Created Response

      201 Created Response

      The Json Resource was created. We then return the resource, post-processing, to the client. Usually used with HTTP PUT.

    14. object CurrentCometActor extends ThreadGlobal[LiftCometActor]

    15. object CurrentHTTPReqResp extends ThreadGlobal[(HTTPRequest, HTTPResponse)]

      A ThreadGlobal containing the low-level HTTPRequest and HTTPResponse instances Set very, very early.

    16. object CurrentReq extends ThreadGlobal[Req]

      A Thread-global containing the current Req.

      A Thread-global containing the current Req. Set very, very early

    17. object DefaultNotFound extends NotFound with Product with Serializable

    18. object DefaultRoutines

      Many routines in Lift can be customized in LiftRules, but have default behaviors.

      Many routines in Lift can be customized in LiftRules, but have default behaviors. This singleton contains the default routines. **DO NOT** call these methods directly. Use LiftRules to call them. So, why make them public? So, we can document the default behaviors.

    19. object DeleteRequest extends RequestType with Product with Serializable

    20. object DoRedirectResponse

    21. object DocType

      Stock XHTML doctypes available to the lift programmer.

    22. object Error extends Serializable

    23. object FieldBinding extends Serializable

    24. object FileParamHolder extends Serializable

    25. object ForbiddenResponse extends Serializable

    26. object GUIDJsExp

      The companion object for GUIDJsExp that does helpful implicit conversions.

    27. object GetRequest extends RequestType with Product with Serializable

    28. object HeadRequest extends RequestType with Product with Serializable

    29. object Html5ElemAttr

    30. object JavaScriptResponse extends Serializable

    31. object JsonResponse extends Serializable

    32. object LiftRules extends LiftRulesMocker

      The Lift configuration singleton

    33. object LiftRulesMocker

    34. object LiftScreenRules extends Factory with FormVendor

    35. object LiftSession

    36. object ListenerManager

    37. object MessageState extends Serializable

    38. object NamedCometListener extends Loggable

      Maintain a Map[Value the actor monitors -> Ref to the Actor Dispatcher]

      Maintain a Map[Value the actor monitors -> Ref to the Actor Dispatcher]

      For a url like: http://hostnbame/index/?p=icecream If you name your actor based on the value of p For each flavor that users have on their urls, the map would be like: chocolate -> code.comet.CometClassNames@ea5e9e7 , vanilla -> code.comet.CometClassNames@wv9i7o3, etc

      If we have the actor already on the Map, just return it, because it has to update the UI. If wee do not have this actor on our Map. create a new Dispatcher that will monitor this value, add it to our Map and return the Ref to this new dispatcher so it updates the UI

    39. object NodeSeqFuncOrSeqNodeSeqFunc

    40. object NotAcceptableResponse extends Serializable

    41. object NotFoundResponse extends Serializable

    42. object Notice extends Serializable

    43. object NoticeType extends Serializable

      Defines the notices types

    44. object OnDiskFileParamHolder extends Serializable

    45. object OptionsRequest extends RequestType with Product with Serializable

    46. object OutputStreamResponse extends Serializable

    47. object PageName extends RequestVar[String]

    48. object PlainTextResponse extends Serializable

    49. object PostRequest extends RequestType with Product with Serializable

    50. object PutRequest extends RequestType with Product with Serializable

    51. object Qop extends Enumeration

    52. object RedirectResponse extends Serializable

      Companion object to RedirectResponse

    53. object RedirectState extends Serializable

    54. object RedirectWithState extends Serializable

    55. object Req

      Helper object for constructing Req instances

    56. object RequestType extends Serializable

    57. object RequestVar

      The companion object to RequestVars

    58. object ResourceServer

    59. object ResponseShortcutException extends Serializable

    60. object RewriteResponse extends Serializable

      Maintains the context of resolving the URL when cookies are disabled from container.

      Maintains the context of resolving the URL when cookies are disabled from container. It maintains low coupling such as code within request processing is not aware of the actual response that encodes the URL.

    61. object S extends S

      An object representing the current state of the HTTP request and response.

      An object representing the current state of the HTTP request and response. It uses the DynamicVariable construct such that each thread has its own local session info without passing a huge state construct around. The S object is initialized by LiftSession on request startup.

      See also

      LiftFilter

      LiftSession

    62. object SHtml extends SHtml

      The SHtml object defines a suite of XHTML element generator methods to simplify the creation of markup, particularly with forms and AJAX.

    63. object ScreenFieldInfo extends Serializable

    64. object SeeOtherResponse extends Serializable

      Companion object to RedirectResponse

    65. object SessionMaster extends LiftActor with Loggable

      Manages LiftSessions because the servlet container is less than optimal at timing sessions out.

    66. object ShutDown extends Product with Serializable

      The response from a page saying that it's been rendered

    67. object ShutdownIfPastLifespan extends CometMessage with Product with Serializable

    68. object StrictXHTML1_0Validator extends GenericValidator

    69. object Templates

      Contains functions for obtaining templates

    70. object TransientSnippet

      The companion object to the TransientSnippet trait

    71. object TransitionalXHTML1_0Validator extends GenericValidator

    72. object URLRewriter

    73. object UnauthorizedDigestResponse extends Serializable

      Companion object with builder

    74. object UserAgentCalculator extends Factory

    75. object Warning extends Serializable

    76. object WiringUI

      Surface a user interface on top of Wiring

    77. object XmlResponse

    78. package auth

    79. package jquery

    80. package js

    81. package provider

    82. package rest

    Deprecated Value Members

    1. object ResponseInfo

      Avoid using this in favor of LiftRules.

      Avoid using this in favor of LiftRules.docType

      Annotations
      @deprecated
      Deprecated

      (Since version 2.3) Avoid using this in favor of LiftRules.docType

    2. lazy val TemplateFinder: Templates.type

      Annotations
      @deprecated
      Deprecated

      (Since version 2.3) Use Templates

    Inherited from AnyRef

    Inherited from Any

    Ungrouped

    ... just doing innerHtml on