net.liftweb.http

LiftSession

class LiftSession extends LiftMerge with Loggable with HowStateful

The LiftSession class containg the session state information

go to: companion
linear super types: 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
Impl.
  1. Concrete
  2. Abstract

Instance constructors

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

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

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

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

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

  10. 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
  11. 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
  12. 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.

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

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

    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 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
  20. 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
  21. def executeInScope [T] (req: Box[Req], renderVersion: String)(f: ⇒ T) : T

  22. 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
  23. def findAndProcessTemplate (name: List[String]) : Box[Elem]

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

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

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

    Find the comet actor by type and name

    Find the comet actor by type and name

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

    Finds all Comet actors by type

    Finds all Comet actors by type

  26. def fixHtml (in: NodeSeq) : NodeSeq

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

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

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

    Finds a Comet actor by ID

    Finds a Comet actor by ID

  28. 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
  29. 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
  30. val httpSession : Box[HTTPSession]

  31. object ieMode extends SessionVar[Boolean]

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

  34. val logger : Logger

    attributes: protected
    definition classes: Loggable
  35. 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
  36. 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
  37. 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
  38. 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
  39. 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.

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

  40. def postPageJavaScript () : List[JsCmd]

    Get the JavaScript to execute as part of the current page

    Get the JavaScript to execute as part of the current page

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

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

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

    Processes the surround tag and other lift tags

    Processes the surround tag and other lift tags

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

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

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

  47. val requestHtmlProperties : TransientRequestVar[HtmlProperties]

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

    Executes the user's functions based on the query parameters

    Executes the user's functions based on the query parameters

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

  50. def running_? : Boolean

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

  52. val sessionHtmlProperties : SessionVar[HtmlProperties]

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

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

  54. def stateful_? : Boolean

    Test the statefulness of this session.

    Test the statefulness of this session.

    definition classes: HowStateful
  55. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  56. def terminateHint : Unit

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

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

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

  58. 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
  59. val uniqueId : String

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

    Updates the internal functions mapping

    Updates the internal functions mapping

  61. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef

Inherited from HowStateful

Inherited from Loggable

Inherited from LiftMerge

Inherited from AnyRef

Inherited from Any