Package org.craftercms.engine.scripting.impl

Class ScriptFilter

java.lang.Object

org.craftercms.engine.scripting.impl.ScriptFilter

All Implemented Interfaces:

jakarta.servlet.Filter

public class ScriptFilter
extends Object
implements jakarta.servlet.Filter

Servlet filter that passes the request through a series of scripts that act as filters too.

Author:

avasquez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ScriptFilter.FilterMapping

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	disableVariableRestrictions
static final String	EXCLUDE_MAPPINGS_KEY
protected org.springframework.security.web.util.matcher.RequestMatcher	excludedUrlsMatcher
static final String	FILTER_KEY
static final String	FILTER_MAPPINGS_CACHE_KEY
static final String	INCLUDE_MAPPINGS_KEY
protected org.springframework.util.PathMatcher	pathMatcher
protected PluginService	pluginService
static final String	SCRIPT_KEY

Constructor Summary

Constructors

Constructor	Description
ScriptFilter(org.craftercms.core.util.cache.CacheTemplate cacheTemplate)

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain originalChain)
protected boolean	excludeFilter(String requestUri, String[] excludes)
protected List<ScriptFilter.FilterMapping>	getFilterMappings()
protected jakarta.servlet.FilterChain	getScriptFilterChain(jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.FilterChain chain)
protected boolean	includeFilter(String requestUri, String[] includes)
void	init(jakarta.servlet.FilterConfig filterConfig)
void	setDisableVariableRestrictions(boolean disableVariableRestrictions)
void	setExcludedUrls(String[] excludedUrls)
void	setPathMatcher(org.springframework.util.PathMatcher pathMatcher)
void	setPluginService(PluginService pluginService)

Methods inherited from class java.lang.Object

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

Field Details

FILTER_KEY

public static final String FILTER_KEY

See Also:

• Constant Field Values

SCRIPT_KEY

public static final String SCRIPT_KEY

See Also:

• Constant Field Values

INCLUDE_MAPPINGS_KEY

public static final String INCLUDE_MAPPINGS_KEY

See Also:

• Constant Field Values

EXCLUDE_MAPPINGS_KEY

public static final String EXCLUDE_MAPPINGS_KEY

See Also:

• Constant Field Values

FILTER_MAPPINGS_CACHE_KEY

public static final String FILTER_MAPPINGS_CACHE_KEY

See Also:

• Constant Field Values

pathMatcher

protected org.springframework.util.PathMatcher pathMatcher

disableVariableRestrictions

protected boolean disableVariableRestrictions

pluginService

protected PluginService pluginService

excludedUrlsMatcher

protected org.springframework.security.web.util.matcher.RequestMatcher excludedUrlsMatcher

Constructor Details

ScriptFilter

public ScriptFilter(org.craftercms.core.util.cache.CacheTemplate cacheTemplate)

Method Details

setPathMatcher

public void setPathMatcher(org.springframework.util.PathMatcher pathMatcher)

setDisableVariableRestrictions

public void setDisableVariableRestrictions(boolean disableVariableRestrictions)

setPluginService

public void setPluginService(PluginService pluginService)

setExcludedUrls

public void setExcludedUrls(String[] excludedUrls)

init

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

Specified by:

init in interface jakarta.servlet.Filter

Throws:

jakarta.servlet.ServletException

doFilter

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

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

IOException

jakarta.servlet.ServletException

getScriptFilterChain

protected jakarta.servlet.FilterChain getScriptFilterChain(jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.FilterChain chain)

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Filter

getFilterMappings

protected List<ScriptFilter.FilterMapping> getFilterMappings()

excludeFilter

protected boolean excludeFilter(String requestUri,
 String[] excludes)

includeFilter

protected boolean includeFilter(String requestUri,
 String[] includes)