net.liftweb.http

LiftSession

class LiftSession extends LiftMerge with Loggable with HowStateful

The LiftSession class containg the session state information

Linear Supertypes
HowStateful, Loggable, LiftMerge, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. LiftSession
  2. HowStateful
  3. Loggable
  4. LiftMerge
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LiftSession(_contextPath: String, uniqueId: String, httpSession: Box[HTTPSession])

Value Members

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

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

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addPostPageJavaScript(func: () ⇒ JsCmd): Unit

    Associate a function that renders JavaScript with the current page.

    Associate a function that renders JavaScript with the current page. This function will be run and the resulting JavaScript will be appended to any rendering associated with this page... the normal page render, Ajax calls, and even Comet calls for this page.

    func

    -- the function that returns JavaScript to be appended to responses associated with this page

  7. def addSessionCleanup(f: (LiftSession) ⇒ Unit): Unit

    Adds a cleanup function that will be executed when session is terminated

  8. def allowContainerState_?: Boolean

    There may be cases when you are allowed container state (e.

    There may be cases when you are allowed container state (e.g., migratory session, but you're not allowed to write Lift non-migratory state, return true here.

    Definition Classes
    HowStateful
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def buildDeferredFunction[T](f: () ⇒ T): () ⇒ T

    During the HTTP request/response cycle or in a CometActor, Lift populates "S" with information about the current session, the current request, etc.

    During the HTTP request/response cycle or in a CometActor, Lift populates "S" with information about the current session, the current request, etc. This method allows you to wrap a function in another function that will snapshot current state (request vars, Req, Loc, etc.) such that when the returned function is executed, it will be executed as if it had been executed in the scope of the thread where it was create. This allows you to farm work out to separate threads, but make it look to those threads as if the scope was the same as if it had been executed on the thread that created the function.

  11. def cleanupUnseenFuncs(): Unit

  12. def clearPostPageJavaScriptForThisPage(): Unit

    Clear the PostPage JavaScript functions for the current page.

    Clear the PostPage JavaScript functions for the current page. This is used by CometActor to remove the PostPage JavaScript functions from the given component during redraw.

  13. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. def cometForHost(hostAndPath: String): (List[(LiftActor, Req)], List[(LiftActor, Req)])

  15. def contextPath: String

    Define the context path for this session.

    Define the context path for this session. This allows different sessions to have different context paths.

  16. def destroySession(): Unit

    Destroy this session and the underlying container session.

  17. def destroySessionAndContinueInNewSession(continuation: () ⇒ Nothing): Nothing

    Destroy the current session, then create a new session and continue the execution of the code.

    Destroy the current session, then create a new session and continue the execution of the code. The continuation function must return Nothing (it must throw an exception... this is typically done by calling S.redirectTo(...)). This method is useful for changing sessions on login. Issue #727.

  18. def doAsStateless[A](f: ⇒ A): A

    Within the scope of the call, this session is forced into statelessness.

    Within the scope of the call, this session is forced into statelessness. This allows for certain URLs in on the site to be stateless and not generate a session, but if a valid session is presented, they have the scope of that session/User

    Definition Classes
    HowStateful
  19. def doCometActorCleanup(): Unit

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

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

    Definition Classes
    AnyRef → Any
  22. def executeInScope[T](req: Box[Req], renderVersion: String)(f: ⇒ T): T

  23. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  24. def findAndProcessTemplate(name: List[String]): Box[Elem]

    Finds a template named name and then runs it throught the Lift processing engine

  25. def findComet(theType: String, name: Box[String]): Box[LiftCometActor]

    Find the comet actor by type and name

  26. def findComet(theType: String): List[LiftCometActor]

    Finds all Comet actors by type

  27. def findFunc(funcName: String): Option[AFuncHolder]

    Find a function in the function lookup table.

    Find a function in the function lookup table. You probably never need to do this, but well, you can look them up.

  28. def fixHtml(in: NodeSeq): NodeSeq

    Apply HTML specific corrections such as adding the context path etc.

  29. def fixSessionTime(): Unit

  30. def getAsyncComponent(id: String): Box[LiftCometActor]

    Finds a Comet actor by ID

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

    Definition Classes
    AnyRef → Any
  32. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  33. val httpSession: Box[HTTPSession]

  34. object ieMode extends SessionVar[Boolean]

  35. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  36. var liftTagProcessing: List[LiftTagPF]

    The partial function that defines how lift tags are processed for this session.

    The partial function that defines how lift tags are processed for this session. Initially composed of LiftRules.liftTagProcessing orElse the default lift tag processing. If you need to change the way a particular session handles lift tags, alter this partial function.

  37. val logger: Logger

    Attributes
    protected
    Definition Classes
    Loggable
  38. def merge(xhtml: NodeSeq, req: Req): Node

    Manages the merge phase of the rendering pipeline

    Manages the merge phase of the rendering pipeline

    Definition Classes
    LiftMerge
  39. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  40. final def notify(): Unit

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

    Definition Classes
    AnyRef
  42. def performHeadMerge(in: NodeSeq, req: Req): Node

    Merge all the head elements into the main head element and move tail stuff to the end of the page.

  43. def postPageJavaScript(): List[JsCmd]

    Get the JavaScript to execute as part of the current page

  44. def postPageJavaScript(pageIds: Seq[String]): List[JsCmd]

    Get the post-page JavaScript functions for a sequence of page IDs.

    Get the post-page JavaScript functions for a sequence of page IDs. This is used by the CometActor to get the post-page JavaScript functions for the comet actor and for the page the the comet actor is associated with

  45. def postPageJavaScript(rv: String): List[JsCmd]

  46. def processSurroundAndInclude(page: String, in: NodeSeq): NodeSeq

    Processes the surround tag and other lift tags

    Processes the surround tag and other lift tags

    page

    the name of the page currently being processed

    in

    the DOM to process

  47. def processTemplate(template: Box[NodeSeq], request: Req, path: ParsePath, code: Int): Box[LiftResponse]

    Convert a template into a Lift Response.

    Convert a template into a Lift Response.

    template

    -- the NodeSeq that makes up the page... or the template will be located via findVisibleTemplate

    request

    -- the Req the led to this rendering

    path

    -- the ParsePath that led to this page

    code

    -- the HTTP response code (usually 200)

    returns

    a Box of LiftResponse with all the proper page rewriting

  48. var progressListener: Box[(Long, Long, Int) ⇒ Unit]

    Set your session-specific progress listener for mime uploads pBytesRead - The total number of bytes, which have been read so far.

    Set your session-specific progress listener for mime uploads 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, ...)

  49. def removeFunction(name: String): HashMap[String, AFuncHolder]

  50. val requestHtmlProperties: TransientRequestVar[HtmlProperties]

  51. def runParams(state: Req): List[Any]

    Executes the user's functions based on the query parameters

  52. def runTemplate(pageName: String, template: NodeSeq): NodeSeq

    A nicely named proxy for processSurroundAndInclude.

    A nicely named proxy for processSurroundAndInclude. This method processes a Lift template

    pageName

    -- the name of the page being processed (for error reporting)

    template

    -- the template to process using Lift's templating engine

  53. def running_?: Boolean

  54. def sendCometActorMessage(theType: String, name: Box[String], msg: Any): Unit

    This method will send a message to a CometActor, whether or not the CometActor is instantiated.

    This method will send a message to a CometActor, whether or not the CometActor is instantiated. If the CometActor already exists in the session, the message will be sent immediately. If the CometActor is not yet instantiated, the message will be sent to the CometActor as part of setup (@see setupComet) if it is created as part of the current HTTP request/response cycle.

    theType

    the type of the CometActor

    name

    the optional name of the CometActor

    msg

    the message to send to the CometActor

  55. def sessionHtmlProperties: (Req) ⇒ HtmlProperties

  56. def setupComet(theType: String, name: Box[String], msg: Any): Unit

    Allows you to send messages to a CometActor that may or may not be set up yet

  57. def stateful_?: Boolean

    Test the statefulness of this session.

    Test the statefulness of this session.

    Definition Classes
    HowStateful
  58. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  59. def terminateHint: Unit

  60. def testStatefulFeature[T](f: ⇒ T): T

    Run the code, but if the session is not stateful, then throw a StateInStatelessException

  61. def toString(): String

    Definition Classes
    AnyRef → Any
  62. val uniqueId: String

  63. def updateFunctionMap(funcs: Map[String, AFuncHolder], uniqueId: String, when: Long): Unit

    Updates the internal functions mapping

  64. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from HowStateful

Inherited from Loggable

Inherited from LiftMerge

Inherited from AnyRef

Inherited from Any