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
Ordering
- Alphabetic
- By Inheritance
Inherited
- CSRFFilter
- EssentialFilter
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new CSRFFilter(config: CSRFConfig, tokenSigner: CSRFTokenSigner, sessionConfiguration: SessionConfiguration, tokenProvider: TokenProvider, errorHandler: CSRFErrorHandler)(mat: Materializer)
- new CSRFFilter(config: Provider[CSRFConfig], tokenSignerProvider: Provider[CSRFTokenSigner], sessionConfiguration: SessionConfiguration, tokenProvider: TokenProvider, errorHandler: ErrorHandler)(mat: Materializer)
- Annotations
- @Inject()
- new CSRFFilter(config: => CSRFConfig, tokenSigner: => CSRFTokenSigner, sessionConfiguration: => SessionConfiguration, tokenProvider: TokenProvider, errorHandler: ErrorHandler = CSRF.DefaultErrorHandler)(implicit mat: Materializer)
- config
A csrf configuration object
- tokenSigner
the CSRF token signer.
- tokenProvider
A token provider to use.
- errorHandler
handling failed token error.
- new CSRFFilter(config: CSRFConfig, tokenSigner: CSRFTokenSigner, sessionConfiguration: SessionConfiguration, tokenProvider: TokenProvider, errorHandler: CSRFErrorHandler, contextComponents: JavaContextComponents)(mat: Materializer)
- Annotations
- @deprecated
- Deprecated
(Since version 2.8.0) Use constructor without JavaContextComponents
Value Members
- def apply(next: EssentialAction): EssentialAction
- Definition Classes
- CSRFFilter → EssentialFilter
- def asJava: EssentialFilter
- Definition Classes
- EssentialFilter
- val errorHandler: ErrorHandler
- val tokenProvider: TokenProvider