play.filters.csrf

CSRFAction

class CSRFAction extends EssentialAction

An action that provides CSRF protection.

Source
CSRFActions.scala
Linear Supertypes
EssentialAction, Handler, (RequestHeader) ⇒ Iteratee[Array[Byte], Result], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CSRFAction
  2. EssentialAction
  3. Handler
  4. Function1
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CSRFAction(next: EssentialAction, tokenName: String = CSRFConf.TokenName, cookieName: Option[String] = CSRFConf.CookieName, secureCookie: Boolean = CSRFConf.SecureCookie, createIfNotFound: (RequestHeader) ⇒ Boolean = ..., tokenProvider: TokenProvider = CSRFConf.defaultTokenProvider, errorHandler: ⇒ ErrorHandler = CSRFConf.defaultErrorHandler)

    next

    The composed action that is being protected.

    tokenName

    The key used to store the token in the Play session. Defaults to csrfToken.

    cookieName

    If defined, causes the filter to store the token in a Cookie with this name instead of the session.

    secureCookie

    If storing the token in a cookie, whether this Cookie should set the secure flag. Defaults to whether the session cookie is configured to be secure.

    createIfNotFound

    Whether a new CSRF token should be created if it's not found. Default creates one if it's a GET request that accepts HTML.

    tokenProvider

    A token provider to use.

    errorHandler

    handling failed token error.

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def andThen[A](g: (Iteratee[Array[Byte], Result]) ⇒ A): (RequestHeader) ⇒ A

    Definition Classes
    Function1
    Annotations
    @unspecialized()

  7. def apply(request: RequestHeader): Iteratee[Array[Byte], Result]

    Definition Classes
    CSRFAction → Function1

  8. def apply(): EssentialAction

    Returns itself, for better support in the routes file.

    Returns itself, for better support in the routes file.

    returns

    itself

    Definition Classes
    EssentialAction

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def compose[A](g: (A) ⇒ RequestHeader): (A) ⇒ Iteratee[Array[Byte], Result]

    Definition Classes
    Function1
    Annotations
    @unspecialized()

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  16. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  22. def toString(): String

    Definition Classes
    Function1 → AnyRef → Any

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from EssentialAction

Inherited from Handler

Inherited from (RequestHeader) ⇒ Iteratee[Array[Byte], Result]

Inherited from AnyRef

Inherited from Any

Ungrouped