Package org.craftercms.engine.servlet.filter

Class HttpProxyFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.craftercms.engine.servlet.filter.HttpProxyFilter

All Implemented Interfaces:

jakarta.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

public class HttpProxyFilter
extends org.springframework.web.filter.OncePerRequestFilter

Implementation of Filter that delegates requests to a proxy

Since:

3.1.7

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_HEADER
static final String	CONFIG_KEY_HEADERS_CLIENT
static final String	CONFIG_KEY_HEADERS_SERVER
static final String	CONFIG_KEY_ID
static final String	CONFIG_KEY_NAME
static final String	CONFIG_KEY_PATTERNS
static final String	CONFIG_KEY_SERVERS
static final String	CONFIG_KEY_URL
static final String	CONFIG_KEY_VALUE
protected boolean	enabled	Indicates if the proxy is enabled
protected org.springframework.security.web.util.matcher.RequestMatcher	excludedMatcher
protected org.springframework.web.servlet.mvc.Controller	proxyController	The proxy to use

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

ALREADY_FILTERED_SUFFIX

Constructor Summary

Constructors

Constructor	Description
HttpProxyFilter(boolean enabled, org.springframework.web.servlet.mvc.Controller proxyController, String[] excludedUrls)

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)
protected Map<String,String>	getHeaders(SiteContext siteContext, String requestUri, String headerType)
protected String	getTargetUrl(SiteContext siteContext, String requestUri)
protected boolean	shouldNotFilter(jakarta.servlet.http.HttpServletRequest request)

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

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, 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 Details

CONFIG_KEY_SERVERS

public static final String CONFIG_KEY_SERVERS

See Also:

• Constant Field Values

CONFIG_KEY_PATTERNS

public static final String CONFIG_KEY_PATTERNS

See Also:

• Constant Field Values

CONFIG_KEY_ID

public static final String CONFIG_KEY_ID

See Also:

• Constant Field Values

CONFIG_KEY_URL

public static final String CONFIG_KEY_URL

See Also:

• Constant Field Values

CONFIG_KEY_HEADERS_SERVER

public static final String CONFIG_KEY_HEADERS_SERVER

See Also:

• Constant Field Values

CONFIG_KEY_HEADERS_CLIENT

public static final String CONFIG_KEY_HEADERS_CLIENT

See Also:

• Constant Field Values

CONFIG_KEY_HEADER

public static final String CONFIG_KEY_HEADER

See Also:

• Constant Field Values

CONFIG_KEY_NAME

public static final String CONFIG_KEY_NAME

See Also:

• Constant Field Values

CONFIG_KEY_VALUE

public static final String CONFIG_KEY_VALUE

See Also:

• Constant Field Values

enabled

protected boolean enabled

Indicates if the proxy is enabled

proxyController

protected org.springframework.web.servlet.mvc.Controller proxyController

The proxy to use

excludedMatcher

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

Constructor Details

HttpProxyFilter

@ConstructorProperties({"enabled","proxyController","excludedUrls"})
public HttpProxyFilter(boolean enabled,
 org.springframework.web.servlet.mvc.Controller proxyController,
 String[] excludedUrls)

Method Details

shouldNotFilter

protected boolean shouldNotFilter(jakarta.servlet.http.HttpServletRequest request)

Overrides:

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

doFilterInternal

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

Specified by:

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

Throws:

jakarta.servlet.ServletException

IOException

getTargetUrl

protected String getTargetUrl(SiteContext siteContext,
 String requestUri)

getHeaders

protected Map<String,String> getHeaders(SiteContext siteContext,
 String requestUri,
 String headerType)