Trait/Object

com.softwaremill.session

SessionDirectives

Related Docs: object SessionDirectives | package session

Permalink

trait SessionDirectives extends OneOffSessionDirectives with RefreshableSessionDirectives

Manages cookie-based sessions with optional refresh tokens. A refresh token is written to a separate cookie.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SessionDirectives
  2. RefreshableSessionDirectives
  3. OneOffSessionDirectives
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def invalidateSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive0

    Permalink

    Invalidate the session cookie.

    Invalidate the session cookie.

    If refreshable, also removes the refresh token cookie and the refresh token token (from the client and token store), if present.

    Note that you should use refreshable if you use refreshable systems even only for some users.

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. def oneOff[T](implicit manager: SessionManager[T]): OneOff[T]

    Permalink
  17. def optionalSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[Option[T]]

    Permalink

    Read an optional session from the session cookie.

  18. def refreshable[T](implicit manager: SessionManager[T], refreshTokenStorage: RefreshTokenStorage[T], ec: ExecutionContext): Refreshable[T]

    Permalink
  19. def requiredSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[T]

    Permalink

    Read a required session from the session cookie.

  20. def session[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[SessionResult[T]]

    Permalink

    Read a session from the session cookie, wrapped in SessionResult describing the possible success/failure outcomes.

    Read a session from the session cookie, wrapped in SessionResult describing the possible success/failure outcomes.

    If refreshable, tries to create a new session based on the refresh token cookie.

  21. def setSession[T](sc: SessionContinuity[T], st: SetSessionTransport, v: T): Directive0

    Permalink

    Set the session cookie with the session content.

    Set the session cookie with the session content. The content is signed, optionally encrypted and with an optional expiry date.

    If refreshable, generates a new token (removing old ones) and stores it in the refresh token cookie.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. def touchOptionalSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[Option[T]]

    Permalink

    Sets the session cookie again with the same data.

    Sets the session cookie again with the same data. Useful when using the SessionConfig.sessionMaxAgeSeconds option, as it sets the expiry date anew.

  25. def touchRequiredSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[T]

    Permalink

    Sets the session cookie again with the same data.

    Sets the session cookie again with the same data. Useful when using the SessionConfig.sessionMaxAgeSeconds option, as it sets the expiry date anew.

  26. def usingCookies: CookieST.type

    Permalink
  27. def usingCookiesOrHeaders: CookieOrHeaderST.type

    Permalink
  28. def usingHeaders: HeaderST.type

    Permalink
  29. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from OneOffSessionDirectives

Inherited from AnyRef

Inherited from Any

Ungrouped