org.craftercms.engine.servlet.filter

Class AbstractSiteContextResolvingFilter

java.lang.Object

org.craftercms.engine.servlet.filter.AbstractSiteContextResolvingFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

SiteContextFromCookieResolvingFilter, SiteContextFromDefaultResolvingFilter, SiteContextFromDomainNameMappingResolvingFilter, SiteContextFromRequestUriResolvingFilter

public abstract class AbstractSiteContextResolvingFilter
extends Object
implements javax.servlet.Filter

Abstract Filter that exposes a SiteContext from the SiteContextRegistry as a session attribute. The context to expose is determined by the site name returned by getSiteNameFromRequest(org.springframework.web.context.request.ServletWebRequest).

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected Lock	createContextLock
protected SiteContextFactory	fallbackSiteContextFactory
protected String	fallbackSiteName
static String	SITE_CONTEXT_ATTRIBUTE
static String	SITE_NAME_ATTRIBUTE
protected SiteContextFactory	siteContextFactory
protected SiteContextRegistry	siteContextRegistry

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSiteContextResolvingFilter()

Method Summary

Methods

Modifier and Type	Method and Description
protected SiteContext	createAndRegisterContext(String siteName, boolean fallback)
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	doFilter(org.springframework.web.context.request.ServletWebRequest request, javax.servlet.FilterChain chain)
static SiteContext	getCurrentContext()
protected abstract String	getSiteNameFromRequest(org.springframework.web.context.request.ServletWebRequest request)
protected void	handleNoSiteNameResolved(org.springframework.web.context.request.ServletWebRequest request, javax.servlet.FilterChain chain)
protected void	handleSiteNameResolved(String siteName, org.springframework.web.context.request.ServletWebRequest request, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)
void	setFallbackSiteContextFactory(SiteContextFactory fallbackSiteContextFactory)
void	setFallbackSiteName(String fallbackSiteName)
void	setSiteContextFactory(SiteContextFactory siteContextFactory)
void	setSiteContextRegistry(SiteContextRegistry siteContextRegistry)

Methods inherited from class java.lang.Object

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

Field Detail

SITE_NAME_ATTRIBUTE

public static final String SITE_NAME_ATTRIBUTE

See Also:

Constant Field Values

SITE_CONTEXT_ATTRIBUTE

public static final String SITE_CONTEXT_ATTRIBUTE

See Also:

Constant Field Values

createContextLock

protected Lock createContextLock

siteContextRegistry

protected SiteContextRegistry siteContextRegistry

siteContextFactory

protected SiteContextFactory siteContextFactory

fallbackSiteContextFactory

protected SiteContextFactory fallbackSiteContextFactory

fallbackSiteName

protected String fallbackSiteName

Constructor Detail

AbstractSiteContextResolvingFilter

protected AbstractSiteContextResolvingFilter()

Method Detail

getCurrentContext

public static SiteContext getCurrentContext()

setSiteContextRegistry

public void setSiteContextRegistry(SiteContextRegistry siteContextRegistry)

setSiteContextFactory

public void setSiteContextFactory(SiteContextFactory siteContextFactory)

setFallbackSiteContextFactory

public void setFallbackSiteContextFactory(SiteContextFactory fallbackSiteContextFactory)

setFallbackSiteName

public void setFallbackSiteName(String fallbackSiteName)

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

doFilter

public void doFilter(org.springframework.web.context.request.ServletWebRequest request,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

createAndRegisterContext

protected SiteContext createAndRegisterContext(String siteName,
                                   boolean fallback)

handleSiteNameResolved

protected void handleSiteNameResolved(String siteName,
                          org.springframework.web.context.request.ServletWebRequest request,
                          javax.servlet.FilterChain chain)
                               throws IOException,
                                      javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

handleNoSiteNameResolved

protected void handleNoSiteNameResolved(org.springframework.web.context.request.ServletWebRequest request,
                            javax.servlet.FilterChain chain)
                                 throws IOException,
                                        javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

getSiteNameFromRequest

protected abstract String getSiteNameFromRequest(org.springframework.web.context.request.ServletWebRequest request)