程序包 cn.taketoday.web.servlet.filter

类 CorsFilter

java.lang.Object

cn.taketoday.web.servlet.filter.GenericFilterBean

cn.taketoday.web.servlet.filter.OncePerRequestFilter

cn.taketoday.web.servlet.filter.CorsFilter

所有已实现的接口:

cn.taketoday.beans.factory.Aware, cn.taketoday.beans.factory.BeanNameAware, cn.taketoday.beans.factory.DisposableBean, cn.taketoday.beans.factory.InitializingBean, cn.taketoday.context.ApplicationContextAware, cn.taketoday.context.EnvironmentAware, cn.taketoday.core.env.EnvironmentCapable, ServletContextAware, Filter

public class CorsFilter
extends OncePerRequestFilter
implements cn.taketoday.context.ApplicationContextAware

Filter that handles CORS preflight requests and intercepts CORS simple and actual requests thanks to a CorsProcessor implementation (DefaultCorsProcessor by default) in order to add the relevant CORS response headers (like Access-Control-Allow-Origin) using the provided CorsConfigurationSource

从以下版本开始:

3.0

作者:

Sebastien Deleuze, TODAY 2020/12/8 22:27

另请参阅:

• CORS W3C recommendation
• UrlBasedCorsConfigurationSource

字段概要

字段

修饰符和类型	字段	说明
private cn.taketoday.context.ApplicationContext	applicationContext
private final CorsConfigurationSource	configSource
private CorsProcessor	processor

从类继承的字段 cn.taketoday.web.servlet.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

从类继承的字段 cn.taketoday.web.servlet.filter.GenericFilterBean

logger

构造器概要

构造器

构造器	说明
CorsFilter(CorsConfigurationSource configSource)	Constructor accepting a CorsConfigurationSource used by the filter to find the CorsConfiguration to use for each incoming request.

方法概要

修饰符和类型	方法	说明
protected void	doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)	Same contract as for doFilter, but guaranteed to be just invoked once per request within a single request thread.
void	setApplicationContext(cn.taketoday.context.ApplicationContext applicationContext)
void	setCorsProcessor(CorsProcessor processor)	Configure a custom CorsProcessor to use to apply the matched CorsConfiguration for a request.

从类继承的方法 cn.taketoday.web.servlet.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

从类继承的方法 cn.taketoday.web.servlet.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

从类继承的方法 java.lang.Object

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

字段详细资料

configSource

private final CorsConfigurationSource configSource

processor

private CorsProcessor processor

applicationContext

@Nullable
private cn.taketoday.context.ApplicationContext applicationContext

构造器详细资料

CorsFilter

public CorsFilter(CorsConfigurationSource configSource)

Constructor accepting a CorsConfigurationSource used by the filter to find the CorsConfiguration to use for each incoming request.

方法详细资料

setCorsProcessor

public void setCorsProcessor(CorsProcessor processor)

Configure a custom CorsProcessor to use to apply the matched CorsConfiguration for a request.

By default DefaultCorsProcessor is used.

setApplicationContext

public void setApplicationContext(@Nullable
 cn.taketoday.context.ApplicationContext applicationContext)
                           throws cn.taketoday.beans.BeansException

指定者:

setApplicationContext 在接口中 cn.taketoday.context.ApplicationContextAware

抛出:

cn.taketoday.beans.BeansException

doFilterInternal

protected void doFilterInternal(HttpServletRequest request,
 HttpServletResponse response,
 FilterChain filterChain)
                         throws IOException,
ServletException

从类复制的说明: OncePerRequestFilter

Same contract as for doFilter, but guaranteed to be just invoked once per request within a single request thread. See OncePerRequestFilter.shouldNotFilterAsyncDispatch() for details.

Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.

指定者:

doFilterInternal 在类中 OncePerRequestFilter

抛出:

IOException

ServletException