Packages

c

play.filters.csrf

CSRFActionHelper

class CSRFActionHelper extends AnyRef

Source
CSRFActions.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CSRFActionHelper
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CSRFActionHelper(sessionConfiguration: SessionConfiguration, csrfConfig: CSRFConfig, tokenSigner: CSRFTokenSigner)

    Construct a new CSRFActionHelper and determine the TokenProvider from configuration.

  2. new CSRFActionHelper(sessionConfiguration: SessionConfiguration, csrfConfig: CSRFConfig, tokenSigner: CSRFTokenSigner, tokenProvider: TokenProvider)

Value Members

  1. def addTokenToResponse(request: RequestHeader, result: Result): Result
  2. def clearTokenIfInvalid(request: RequestHeader, errorHandler: ErrorHandler, msg: String): Future[Result]
  3. def generateToken: Token
  4. def getHeaderToken(request: RequestHeader): Option[String]
  5. def getTokenToValidate(request: RequestHeader): Option[String]

    Get the header token, that is, the token that should be validated.

  6. def hasInvalidContentType(request: RequestHeader): Boolean
  7. def isCacheableBySharedCache(result: Result): Boolean

    returns

    false if Cache-Control header is absent or true if it exists but does not contain an explicit directive to prevent caching (e.g. "no-store") in shared caches (e.g. proxies)

  8. def requiresCsrfCheck(request: RequestHeader): Boolean
  9. def tagRequest[A](request: Request[A], token: Token): Request[A]
  10. def tagRequestFromHeader[A](request: Request[A]): Request[A]
  11. def tagRequestFromHeader(request: RequestHeader): RequestHeader

    Tag incoming requests with the token in the header

  12. def tagRequestHeader(request: RequestHeader, token: => Token): RequestHeader
  13. def tagRequestHeaderWithNewToken(request: RequestHeader): RequestHeader
  14. def tagRequestWithNewToken(requestBuilder: RequestBuilder): RequestBuilder
  15. def tagRequestWithNewToken[A](request: Request[A]): Request[A]

Deprecated Value Members

  1. def isCached(result: Result): Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) Renamed to isCacheableBySharedCache