Packages

class Session extends AnyRef

Represents a browser session.

Sessions persist between HTTP requests for a single browser session. They are deleted when the browser is closed, or they time-out. Session cookies are used to maintain sessions using a secure UUID.

Sessions can be used to maintain data for a browser session, e.g. a shopping basket.

The context must have first been routed to a io.vertx.scala.ext.web.handler.SessionHandler for sessions to be available.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Session
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Session(_asJava: AnyRef)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJava: AnyRef
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def destroy(): Unit

    Destroy the session

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def get[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Get some data from the session * @param key the key of the data

    Get some data from the session * @param key the key of the data

    returns

    the data

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def id(): String

    returns

    The unique ID of the session. This is generated using a random secure UUID.

  15. def isDestroyed(): Boolean

    returns

    has the session been destroyed?

  16. def isEmpty(): Boolean

    returns

    true if the session has data

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isRegenerated(): Boolean

    returns

    has the session been renewed?

  19. def lastAccessed(): Long

    returns

    the time the session was last accessed

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def oldId(): String

    returns

    old ID if renewed

  24. def put(key: String, obj: AnyRef): Session

    Put some data in a session * @param key the key for the data

    Put some data in a session * @param key the key for the data

    obj

    the data

    returns

    a reference to this, so the API can be used fluently

  25. def regenerateId(): Session

    returns

    The new unique ID of the session.

  26. def remove[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Remove some data from the session * @param key the key of the data

    Remove some data from the session * @param key the key of the data

    returns

    the data that was there or null if none there

  27. def setAccessed(): Unit

    Mark the session as being accessed.

  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def timeout(): Long

    returns

    the amount of time in ms, after which the session will expire, if not accessed.

  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. def value(): String

    The short representation of the session to be added to the session cookie.

    The short representation of the session to be added to the session cookie. By default is the session id. * @return short representation string.

  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped