Class/Object

play.filters.csrf

CSRFFilter

Related Docs: object CSRFFilter | package csrf

Permalink

class CSRFFilter extends EssentialFilter

A filter that provides CSRF protection.

These must be by name parameters because the typical use case for instantiating the filter is in Global, which happens before the application is started. Since the default values for the parameters are loaded from config and hence depend on a started application, they must be by name.

Source
CSRFFilter.scala
Linear Supertypes
EssentialFilter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CSRFFilter
  2. EssentialFilter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CSRFFilter(config: CSRFConfig, tokenSigner: CSRFTokenSigner, tokenProvider: TokenProvider, errorHandler: CSRFErrorHandler)(mat: Materializer)

    Permalink

  2. new CSRFFilter(config: Provider[CSRFConfig], tokenSignerProvider: Provider[CSRFTokenSigner], tokenProvider: TokenProvider, errorHandler: ErrorHandler)(mat: Materializer)

    Permalink
    Annotations
    @Inject()

  3. new CSRFFilter(config: ⇒ CSRFConfig, tokenSigner: ⇒ CSRFTokenSigner, tokenProvider: TokenProvider = ..., errorHandler: ErrorHandler = CSRF.DefaultErrorHandler)(implicit mat: Materializer)

    Permalink

    config

    A csrf configuration object

    tokenProvider

    A token provider to use.

    errorHandler

    handling failed token error.

  4. new CSRFFilter()(implicit mat: Materializer)

    Permalink

    Default constructor, useful from Java

    Default constructor, useful from Java

    Annotations
    @Deprecated
    Deprecated

    in 2.5.0. This constructor uses global state.

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. def apply(next: EssentialAction): EssentialAction

    Permalink
    Definition Classes
    CSRFFilter → EssentialFilter

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def asJava: EssentialFilter

    Permalink
    Definition Classes
    EssentialFilter

  7. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. val errorHandler: ErrorHandler

    Permalink

    handling failed token error.

  11. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. val tokenProvider: TokenProvider

    Permalink

    A token provider to use.

  21. final def wait(): Unit

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

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

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

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

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

Inherited from EssentialFilter

Inherited from AnyRef

Inherited from Any

Ungrouped