play.components

Interface HttpComponents

All Superinterfaces:

HttpConfigurationComponents

All Known Subinterfaces:

BuiltInComponents, HttpFiltersComponents, NoHttpFiltersComponents

All Known Implementing Classes:

BuiltInComponentsFromContext, RoutingDslComponentsFromContext

public interface HttpComponents
extends HttpConfigurationComponents

Method Summary

Modifier and Type	Method and Description
ActionCreator	actionCreator()
EssentialFilter[]	httpFilters() List of filters, typically provided by mixing in play.filters.HttpFiltersComponents or play.api.NoHttpFiltersComponents.
HttpRequestHandler	httpRequestHandler()
play.core.j.JavaHandlerComponents	javaHandlerComponents()

Methods inherited from interface play.components.HttpConfigurationComponents

httpConfiguration, sessionConfiguration

Method Detail

actionCreator

ActionCreator actionCreator()

httpFilters

EssentialFilter[] httpFilters()

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 play.filters.components.HttpFiltersComponents {

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

   public EssentialFilter[] httpFilters() {
       LoggingFilter loggingFilter = new LoggingFilter();
       List<EssentialFilter> filters = Arrays.asList(httpFilters());
       filters.add(loggingFilter);
       return filters.toArray();
   }

   // other required methods
 }
 

If you want to filter elements out of the list, you can do the following:

 class MyComponents extends BuiltInComponentsFromContext implements play.filters.HttpFiltersComponents {

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

   public EssentialFilter[] httpFilters() {
     return Arrays
          .stream(httpFilters())
          // accept only filters that are not CSRFFilter
          .filter(f -> !f.getClass().equals(CSRFFilter.class))
          .toArray();
   }

   // other required methods
 }
 

Returns:

an array with the http filters.

See Also:

EssentialFilter

javaHandlerComponents

play.core.j.JavaHandlerComponents javaHandlerComponents()

httpRequestHandler

HttpRequestHandler httpRequestHandler()