uk.gov.hmrc.play.bootstrap.frontend.filters
SessionTimeoutFilter
Companion object SessionTimeoutFilter
class SessionTimeoutFilter extends Filter
Filter that manipulates session data if 'ts' session field is older than configured timeout.
If the 'ts' has expired, we wipe the session, add a new SessionId and update the 'ts'. If the 'ts' doesn't exist, or is invalid, we just wipe the authToken.
This filter clears data on the incoming request, so that the controller does not receive any session information. It also changes the SET-COOKIE header for the outgoing request, so that the browser knows the session has expired.
A white-list of session values are omitted from this process.
- Annotations
- @Singleton()
- Alphabetic
- By Inheritance
- SessionTimeoutFilter
- Filter
- EssentialFilter
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SessionTimeoutFilter(mat: Materializer, config: SessionTimeoutFilterConfig, ec: ExecutionContext)
- Annotations
- @Inject()
- new SessionTimeoutFilter(config: SessionTimeoutFilterConfig, mkSessionId: () => String = () => s"session-${UUID.randomUUID()}", clock: () => Instant = () => Instant.now())(implicit ec: ExecutionContext, mat: Materializer)
- config
an instance of
SessionTimeoutFilterConfigrepresenting the various configurable aspects of this class- mat
a
Materializerinstance for Play! to use when dealing with the underlying Akka streams
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(f: (RequestHeader) => Future[Result])(rh: RequestHeader): Future[Result]
- Definition Classes
- SessionTimeoutFilter → Filter
- def apply(next: EssentialAction): EssentialAction
- Definition Classes
- Filter → EssentialFilter
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: EssentialFilter
- Definition Classes
- EssentialFilter
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit val mat: Materializer
- Definition Classes
- SessionTimeoutFilter → Filter
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)