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:

  • Method Details

    • 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 interface HttpComponents
      Returns:
      an array with the http filters.
      See Also: