Packages

final class Session extends AnyRef

The state of a given virtual user.

Immutable, so all methods return a new occurrence and leave the original unmodified.

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

Instance Constructors

  1. new Session(wrapped: core.session.Session)

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 asScala(): core.session.Session
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def contains(key: String): Boolean

    key

    the key

    returns

    true is the key is defined

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

    Get a stored value by its key

    Get a stored value by its key

    key

    the storage key

    returns

    the value if it exists, null otherwise

  12. def getBoolean(key: String): Boolean

    Get a stored boolean by its key.

    Get a stored boolean by its key. String representation of Booleans will be parsed.

    key

    the storage key

    returns

    the value if it exists

    Exceptions thrown

    ClassCastException if the value is neither a boolean nor a String

    NullPointerException if the value is undefined

    NumberFormatException if the value is a String that can't be parsed into a boolean

  13. def getBooleanWrapper(key: String): Boolean

    Get a stored Boolean by its key.

    Get a stored Boolean by its key. String representation of Booleans will be parsed.

    key

    the storage key

    returns

    the value if it exists, null otherwise

    Annotations
    @Nullable()
    Exceptions thrown

    ClassCastException if the value is neither a boolean nor a String

    NumberFormatException if the value is a String that can't be parsed into a boolean

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def getDouble(key: String): Double

    Get a stored double by its key.

    Get a stored double by its key. String representation of Doubles will be parsed.

    key

    the storage key

    returns

    the value if it exists

    Exceptions thrown

    ClassCastException if the value is neither a number nor a String

    NullPointerException if the value is undefined

    NumberFormatException if the value is a String that can't be parsed into a double

  16. def getDoubleWrapper(key: String): Double

    Get a stored Double by its key.

    Get a stored Double by its key. String representation of Doubles will be parsed.

    key

    the storage key

    returns

    the value if it exists, null otherwise

    Annotations
    @Nullable()
    Exceptions thrown

    ClassCastException if the value is neither a number nor a String

    NumberFormatException if the value is a String that can't be parsed into a double

  17. def getInt(key: String): Int

    Get a stored int by its key

    Get a stored int by its key

    key

    the storage key

    returns

    the value if it exists

    Exceptions thrown

    ClassCastException if the value is neither a number nor a String

    NullPointerException if the value is undefined

    NumberFormatException if the value is a String that can't be parsed into a int

  18. def getIntegerWrapper(key: String): Integer

    Get a stored Integer by its key.

    Get a stored Integer by its key. String representation of Integers will be parsed.

    key

    the storage key

    returns

    the value if it exists, null otherwise

    Annotations
    @Nullable()
    Exceptions thrown

    ClassCastException if the value is neither a number nor a String

    NumberFormatException if the value is a String that can't be parsed into a int

  19. def getList[T](key: String): List[T]

    Get a stored List by its key.

    Get a stored List by its key.

    key

    the storage key

    returns

    the value if it exists, an empty List otherwise

    Annotations
    @Nonnull() @SuppressWarnings()
    Exceptions thrown

    ClassCastException if the value is not a List

  20. def getLong(key: String): Long

    Get a stored long by its key String representation of Longs will be parsed.

    Get a stored long by its key String representation of Longs will be parsed.

    key

    the storage key

    returns

    the value if it exists

    Exceptions thrown

    ClassCastException if the value is neither a number nor a String

    NullPointerException if the value is undefined

    NumberFormatException if the value is a String that can't be parsed into a long

  21. def getLongWrapper(key: String): Long

    Get a stored Long by its key.

    Get a stored Long by its key. String representation of Longs will be parsed.

    key

    the storage key

    returns

    the value if it exists, null otherwise

    Annotations
    @Nullable()
    Exceptions thrown

    ClassCastException if the value is neither a number nor a String

    NumberFormatException if the value is a String that can't be parsed into a long

  22. def getMap[T](key: String): Map[String, T]

    Get a stored Map by its key.

    Get a stored Map by its key.

    key

    the storage key

    returns

    the value if it exists, an empty Map otherwise

    Annotations
    @Nonnull() @SuppressWarnings()
    Exceptions thrown

    ClassCastException if the value is not a Map

  23. def getSet[T](key: String): Set[T]

    Get a stored Set by its key.

    Get a stored Set by its key.

    key

    the storage key

    returns

    the value if it exists, an empty Set otherwise

    Annotations
    @Nonnull() @SuppressWarnings()
    Exceptions thrown

    ClassCastException if the value is not a Set

  24. def getString(key: String): String

    Get a stored String by its key

    Get a stored String by its key

    key

    the storage key

    returns

    the value if it exists, null otherwise

    Annotations
    @Nullable()
  25. def groups(): List[String]

    Provide the name of the scenario of the virtual user

    Provide the name of the scenario of the virtual user

    returns

    the virtual user's scenario name

  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def isFailed(): Boolean

    returns

    if the Session's status is failure

  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def markAsFailed(): Session

    Force status to failure

    Force status to failure

    returns

    the new instance with the new status

    Annotations
    @Nonnull()
  30. def markAsSucceeded(): Session

    Force status to success

    Force status to success

    returns

    the new instance with the new status

    Annotations
    @Nonnull()
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def remove(key: String): Session

    Remove an existing attribute

    Remove an existing attribute

    key

    the key to remove

    returns

    the new instance with the removed key

    Annotations
    @Nonnull()
  35. def removeAll(keys: <repeated...>[String]): Session

    Remove multiple existing attributes

    Remove multiple existing attributes

    keys

    the keys to remove

    returns

    the new instance with the removed keys

    Annotations
    @Nonnull()
  36. def reset(): Session

    Remove all attributes but Gatling's internal ones

    Remove all attributes but Gatling's internal ones

    returns

    the new instance with a reset user state

    Annotations
    @Nonnull()
  37. def scenario(): String

    Provide the name of the scenario of the virtual user

    Provide the name of the scenario of the virtual user

    returns

    the virtual user's scenario name

  38. def set(key: String, value: AnyRef): Session

    Store (possibly override existing value) a value under a key

    Store (possibly override existing value) a value under a key

    key

    the key

    value

    the value to store

    returns

    the new instance with the new stored value

    Annotations
    @Nonnull()
  39. def setAll(newAttributes: Map[String, AnyRef]): Session

    Store (possibly override existing values) some key value pairs

    Store (possibly override existing values) some key value pairs

    newAttributes

    the new attributes

    returns

    the new instance with the new stored value

    Annotations
    @Nonnull()
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    Session → AnyRef → Any
    Annotations
    @Override()
  42. def userId(): Long

    Provide the unique (for this injector) id of the virtual user

    Provide the unique (for this injector) id of the virtual user

    returns

    the virtual user's id

  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped