Package org.craftercms.engine.servlet.filter

Class SiteContextResolvingFilter

java.lang.Object

org.craftercms.engine.servlet.filter.SiteContextResolvingFilter

All Implemented Interfaces:

jakarta.servlet.Filter

public class SiteContextResolvingFilter
extends Object
implements jakarta.servlet.Filter

Filter that uses a SiteContextResolver to resolve the context for the current request. The site context and the site name are then set as request attributes.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected SiteContextResolver	contextResolver
protected String	errorTemplate
protected org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig>	freeMarkerConfigFactory

Constructor Summary

Constructors

Constructor	Description
SiteContextResolvingFilter(String errorTemplate, SiteContextResolver contextResolver, org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig> freeMarkerConfigFactory)

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
protected SiteContext	getContext(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	init(jakarta.servlet.FilterConfig filterConfig)
protected void	renderError(jakarta.servlet.http.HttpServletResponse response, int responseCode)

Methods inherited from class java.lang.Object

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

Field Details

errorTemplate

protected String errorTemplate

contextResolver

protected SiteContextResolver contextResolver

freeMarkerConfigFactory

protected org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig> freeMarkerConfigFactory

Constructor Details

SiteContextResolvingFilter

public SiteContextResolvingFilter(String errorTemplate,
 SiteContextResolver contextResolver,
 org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig> freeMarkerConfigFactory)

Method Details

init

public void init(jakarta.servlet.FilterConfig filterConfig)

Specified by:

init in interface jakarta.servlet.Filter

doFilter

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

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

IOException

jakarta.servlet.ServletException

getContext

protected SiteContext getContext(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

renderError

protected void renderError(jakarta.servlet.http.HttpServletResponse response,
 int responseCode)

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Filter