de.hybris.platform.servicelayer.web

Class AbstractPlatformFilterChain

java.lang.Object

OncePerRequestFilter

de.hybris.platform.servicelayer.web.AbstractPlatformFilterChain

Direct Known Subclasses:

BackOfficeFilterChain, PlatformFilterChain

public abstract class AbstractPlatformFilterChain
extends OncePerRequestFilter

This filter provides a lightweight alternative to the current HybrisInitFilter / RootRequestFilter and the WebSessionFunctions. By intention it is not providing all functionality of the HybrisInitFilter.

Instead of implementing all the different feature into one Filter this filter just provides a internal chain where you can add different other filters to add additional features to your request processing.

As these filters are part of the internal chain, they are only triggered if this filter is triggered, therefore the same filter mapping configuration is automatically applied.

This filter is extending the OncePerRequestFilter class provided by Spring in order to ensure, that the filter (and the configured filter of the internal chain) is only called once.

There are several filters available providing a standard set of features like tenant handling, session handling and catalog version handling. You can simply add these filter to the internal chain by configuring the spring bean definition accordingly.

This filter should be configured in the Spring configuration file of your web application and provide a list of bean ids of the beans which should be used in the internal chain as constructor arguments.

 <bean id="aggregationFilter" class="de.hybris.platform.servicelayer.web.AggregationFilter">
        <constructor-arg>
                <list>
                        <ref bean="profileFilter"/>
                        <ref bean="log4jFilter"/>
                        <ref bean="tenantActivationFilter"/>
                        <ref bean="sessionFilter"/>
                        <ref bean="simpleCatalogVersionFilter"/>
                </list>
        </constructor-arg>
 </bean>
 

In order to use this configured bean instance in your web application, you now have to configure the DelegatingFilterProxy in the web.xml your web application in order to for your configured aggregationFilter to be called during request processing. Do not forget to also define the filter mapping to be used:

 <filter-mapping>
        <filter-name>platformFilterChain</filter-name>
        <url-pattern>/*</url-pattern>
 </filter-mapping>
 

Right now there are no filters which allow you to have the following functionality, which have been provided by the HybrisInitFilter & WebSessionFunctions:

  * Dynamic tenant handling: Switching the tenant dynamically by specifying the tenantId as a query parameter.
  * System Init check: Checking for each request if the hybris system is initialized.
  * Status pages: Serving special pages to the client if the system is currently shutting down or a special info token is
  provided.
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractPlatformFilterChain.InternalFilterChain Simple & straight forward implementation of the FilterChain interface used by the PlatformFilterChain for it's internal chain.

Constructor Summary

Constructors

Constructor and Description
AbstractPlatformFilterChain(List<Filter> internalFilters)

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
protected Collection<String>	getExcludedUrlPaths()
protected abstract boolean	isBackOfficeFilterChain() Returns true if filter is used in backoffice application.
void	setExcludedUrlPaths(List<String> excludedUrlPaths)
protected boolean	shouldBreakFiltering(String requestURI)
protected static <E extends Throwable> void	throwAnyException(Throwable exception)
protected static void	throwUncheckedException(Throwable exception)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPlatformFilterChain

public AbstractPlatformFilterChain(List<Filter> internalFilters)

Method Detail

getExcludedUrlPaths

protected Collection<String> getExcludedUrlPaths()

setExcludedUrlPaths

public void setExcludedUrlPaths(List<String> excludedUrlPaths)

doFilterInternal

protected void doFilterInternal(HttpServletRequest request,
                                HttpServletResponse response,
                                FilterChain filterChain)
                         throws ServletException,
                                IOException

Throws:

ServletException

IOException

isBackOfficeFilterChain

protected abstract boolean isBackOfficeFilterChain()

Returns true if filter is used in backoffice application.

shouldBreakFiltering

protected boolean shouldBreakFiltering(String requestURI)

throwUncheckedException

protected static void throwUncheckedException(Throwable exception)

throwAnyException

protected static <E extends Throwable> void throwAnyException(Throwable exception)
                                                       throws E extends Throwable

Throws:

E extends Throwable