Package play.filters.components
Interface HttpFiltersComponents
-
- All Superinterfaces:
AllowedHostsComponents
,ConfigurationComponents
,CORSComponents
,CryptoComponents
,CSPComponents
,CSRFComponents
,GzipFilterComponents
,HttpComponents
,HttpConfigurationComponents
,HttpErrorHandlerComponents
,IPFilterComponents
,PekkoComponents
,RedirectHttpsComponents
,SecurityHeadersComponents
public interface HttpFiltersComponents extends AllowedHostsComponents, CORSComponents, CSPComponents, CSRFComponents, GzipFilterComponents, RedirectHttpsComponents, SecurityHeadersComponents, IPFilterComponents, HttpComponents
A compile time default filters components.Usage:
public class MyComponents extends BuiltInComponentsFromContext implements play.filters.components.HttpFiltersComponents { public MyComponents(ApplicationLoader.Context context) { super(context); } // required methods implementation }
- See Also:
NoHttpFiltersComponents
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default List<EssentialFilter>
httpFilters()
List of filters, typically provided by mixing in play.filters.HttpFiltersComponents or play.api.NoHttpFiltersComponents.-
Methods inherited from interface play.filters.components.AllowedHostsComponents
allowedHostsConfig, allowedHostsFilter
-
Methods inherited from interface play.components.ConfigurationComponents
config, configuration
-
Methods inherited from interface play.filters.components.CORSComponents
corsConfig, corsFilter, corsPathPrefixes
-
Methods inherited from interface play.components.CryptoComponents
clock, cookieSigner, csrfTokenSigner
-
Methods inherited from interface play.filters.components.CSPComponents
cspAction, cspConfig, cspFilter, cspProcessor, cspResultProcessor
-
Methods inherited from interface play.filters.components.CSRFComponents
addCSRFTokenAction, csrfAddToken, csrfCheck, csrfConfig, csrfErrorHandler, csrfFilter, csrfTokenProvider, requireCSRFCheckAction
-
Methods inherited from interface play.filters.components.GzipFilterComponents
gzipFilter, gzipFilterConfig
-
Methods inherited from interface play.components.HttpComponents
actionCreator, httpRequestHandler, javaHandlerComponents
-
Methods inherited from interface play.components.HttpConfigurationComponents
httpConfiguration, sessionConfiguration
-
Methods inherited from interface play.components.HttpErrorHandlerComponents
httpErrorHandler, javaContextComponents, scalaHttpErrorHandler
-
Methods inherited from interface play.filters.components.IPFilterComponents
environment, ipFilter, ipFilterConfig
-
Methods inherited from interface play.components.PekkoComponents
actorSystem, coordinatedShutdown, executionContext, materializer
-
Methods inherited from interface play.filters.components.RedirectHttpsComponents
environment, redirectHttpsConfiguration, redirectHttpsFilter
-
Methods inherited from interface play.filters.components.SecurityHeadersComponents
securityHeadersConfig, securityHeadersFilter
-
-
-
-
Method Detail
-
httpFilters
default List<EssentialFilter> httpFilters()
Description copied from interface:HttpComponents
List of filters, typically provided by mixing in play.filters.HttpFiltersComponents or play.api.NoHttpFiltersComponents.In most cases you will want to mixin HttpFiltersComponents and append your own filters:
public class MyComponents extends BuiltInComponentsFromContext implements HttpFiltersComponents { public MyComponents(ApplicationLoader.Context context) { super(context); } public List<EssentialFilter> httpFilters() { List<EssentialFilter> filters = HttpFiltersComponents.super.httpFilters(); filters.add(loggingFilter); return filters; } // other required methods }
If you want to filter elements out of the list, you can do the following:class MyComponents extends BuiltInComponentsFromContext implements HttpFiltersComponents { public MyComponents(ApplicationLoader.Context context) { super(context); } public List<EssentialFilter> httpFilters() { return httpFilters().stream() // accept only filters that are not CSRFFilter .filter(f -> !f.getClass().equals(CSRFFilter.class)) .collect(Collectors.toList()); } // other required methods }
- Specified by:
httpFilters
in interfaceHttpComponents
- Returns:
- an array with the http filters.
- See Also:
EssentialFilter
-
-