play.filters.components

Interface NoHttpFiltersComponents

All Superinterfaces:

HttpComponents, HttpConfigurationComponents

public interface NoHttpFiltersComponents
extends HttpComponents

Java component to mix in when no default filters should be mixed in to BuiltInComponents.

Usage:

 public class MyComponents extends BuiltInComponentsFromContext implements NoHttpFiltersComponents {

    public MyComponents(ApplicationLoader.Context context) {
        super(context);
    }

    // required methods implementation

 }
 

See Also:

HttpFiltersComponents.httpFilters()

Method Summary

Modifier and Type	Method and Description
default java.util.List<EssentialFilter>	httpFilters() List of filters, typically provided by mixing in play.filters.HttpFiltersComponents or play.api.NoHttpFiltersComponents.

Methods inherited from interface play.components.HttpComponents

actionCreator, httpRequestHandler, javaHandlerComponents

Methods inherited from interface play.components.HttpConfigurationComponents

httpConfiguration, sessionConfiguration

Method Detail

httpFilters

default java.util.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:

EssentialFilter