com.foreach.across.modules.webcms.domain.domain.web

Class AbstractWebCmsDomainContextFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

com.foreach.across.modules.webcms.domain.domain.web.AbstractWebCmsDomainContextFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

Direct Known Subclasses:

WebCmsSiteConfigurationFilter

public abstract class AbstractWebCmsDomainContextFilter
extends org.springframework.web.filter.OncePerRequestFilter

Filter that attempts to set the current WebCmsDomainContext based on the hostname of the current request. Builds a list of AbstractWebCmsDomainContextFilter.DomainContextLookup records and will use the first one that matches for the current hostname. If no domain can be matched on hostname, a default domain will be assigned instead.

A AbstractWebCmsDomainContextFilter.DomainContextLookup record can optionally specify a Locale that should be set for the selected hostname match.

For performance reasons, this base class caches its lookup records. It is strongly advised that domain metadata can be cached eternally as long as the domain itself is not modified.

Extend this class to create your own domain selection logic. Note however that your filter must be created as a bean and requires the WebCmsDomainCache. Only a single filter can be active.

Since:

0.0.3

Author:

Arne Vandamme

See Also:

WebCmsSiteConfigurationFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWebCmsDomainContextFilter.DomainContextLookup Helper for a single hostname lookup that maps to a WebCmsDomainContext and its corresponding default Locale.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_NAME

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor and Description
AbstractWebCmsDomainContextFilter()

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractWebCmsDomainContextFilter.DomainContextLookup	buildDefaultDomainLookup(List<AbstractWebCmsDomainContextFilter.DomainContextLookup> domainSpecificLookups) Builds the AbstractWebCmsDomainContextFilter.DomainContextLookup for the default domain.
protected abstract List<AbstractWebCmsDomainContextFilter.DomainContextLookup>	buildDomainSpecificLookups() Builds the list of lookups that should be used.
protected Pattern	compileHostPattern(String hostName) Convert a configured hostname to a lookup pattern.
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_NAME

public static final String FILTER_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractWebCmsDomainContextFilter

public AbstractWebCmsDomainContextFilter()

Method Detail

doFilterInternal

protected final void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      javax.servlet.FilterChain filterChain)
                               throws javax.servlet.ServletException,
                                      IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

javax.servlet.ServletException

IOException

buildDomainSpecificLookups

protected abstract List<AbstractWebCmsDomainContextFilter.DomainContextLookup> buildDomainSpecificLookups()

Builds the list of lookups that should be used. Fetches all domains, checks if they are active and if their metadata is WebCmsSiteConfiguration. If so, create a lookup for every hostname in the configuration.

The list should not include the default domain lookup.

NOTE: Only called if lookup cache is being refreshed.

Returns:

list of lookups

buildDefaultDomainLookup

protected abstract AbstractWebCmsDomainContextFilter.DomainContextLookup buildDefaultDomainLookup(List<AbstractWebCmsDomainContextFilter.DomainContextLookup> domainSpecificLookups)

Builds the AbstractWebCmsDomainContextFilter.DomainContextLookup for the default domain. This lookup will be used in case no lookup matched based on the hostname.

Any configured AbstractWebCmsDomainContextFilter.DomainContextLookup.hostPattern will be ignored.

NOTE: Only called if lookup cache is being refreshed.

Parameters:

domainSpecificLookups - list of lookups for actual domains

Returns:

lookup

compileHostPattern

protected Pattern compileHostPattern(String hostName)

Convert a configured hostname to a lookup pattern.

• ** will match multiple domain segments
• * will match a single domain segment
• if no port is specified all domains will match regardless of port

Parameters:

hostName - pattern

Returns:

regex pattern