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

Class WebCmsSiteConfigurationFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

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

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

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

@Lazy
 @Component
public class WebCmsSiteConfigurationFilter
extends AbstractWebCmsDomainContextFilter

Implementation of AbstractWebCmsDomainContextFilter that checks WebCmsSiteConfiguration metadata. Every active domain that has WebCmsSiteConfiguration metadata will be taken into account. The domains will be ordered, and their WebCmsSiteConfiguration.getHostNames() inspected in order. The first domain to match will be set as the current domain context.

This class can be extended for further customization.

Since:

0.0.3

Author:

Arne Vandamme

Nested Class Summary

Nested classes/interfaces inherited from class com.foreach.across.modules.webcms.domain.domain.web.AbstractWebCmsDomainContextFilter

AbstractWebCmsDomainContextFilter.DomainContextLookup

Field Summary

Fields inherited from class com.foreach.across.modules.webcms.domain.domain.web.AbstractWebCmsDomainContextFilter

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
WebCmsSiteConfigurationFilter()

Method Summary

Modifier and Type	Method and Description
protected AbstractWebCmsDomainContextFilter.DomainContextLookup	buildDefaultDomainLookup(List<AbstractWebCmsDomainContextFilter.DomainContextLookup> domainSpecificLookups) Uses the WebCmsMultiDomainConfiguration#getDefaultDomainKey() to determine the default domain.
protected List<AbstractWebCmsDomainContextFilter.DomainContextLookup>	buildDomainSpecificLookups() Builds the list of lookups that should be used.
protected AbstractWebCmsDomainContextFilter.DomainContextLookup	createDomainContextLookup(String hostName, WebCmsDomain domain, Object metadata) Create a single DomainContextLookup for a host name and domain.

Methods inherited from class com.foreach.across.modules.webcms.domain.domain.web.AbstractWebCmsDomainContextFilter

compileHostPattern, doFilterInternal

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

Constructor Detail

WebCmsSiteConfigurationFilter

public WebCmsSiteConfigurationFilter()

Method Detail

buildDomainSpecificLookups

protected List<AbstractWebCmsDomainContextFilter.DomainContextLookup> buildDomainSpecificLookups()

Description copied from class: AbstractWebCmsDomainContextFilter

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.

Specified by:

buildDomainSpecificLookups in class AbstractWebCmsDomainContextFilter

Returns:

list of lookups

buildDefaultDomainLookup

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

Uses the WebCmsMultiDomainConfiguration#getDefaultDomainKey() to determine the default domain. If specified, that domain and its metadata will be used for the domain context. The active status of the domain is not taken into account.

If no domain key is specified, then no-domain is used as default domain.

Specified by:

buildDefaultDomainLookup in class AbstractWebCmsDomainContextFilter

Parameters:

domainSpecificLookups - list of lookups for actual domains

Returns:

lookup record

createDomainContextLookup

protected AbstractWebCmsDomainContextFilter.DomainContextLookup createDomainContextLookup(String hostName,
                                                                                          WebCmsDomain domain,
                                                                                          Object metadata)

Create a single DomainContextLookup for a host name and domain. Note that either parameter can be null. If host name is null it usually implies the default (fallback) domain lookup record.

If the metadata is of type WebCmsSiteConfiguration, the Locale to use will be resolved from it.

Parameters:

hostName - to match (can be null)

domain - to select (can be null)

metadata - of the domain (can be null

Returns:

lookup