程序包 cn.taketoday.test.web.servlet.setup

类 MockMvcFilterDecorator

java.lang.Object

cn.taketoday.test.web.servlet.setup.MockMvcFilterDecorator

所有已实现的接口:

jakarta.servlet.Filter

final class MockMvcFilterDecorator
extends Object
implements jakarta.servlet.Filter

A Filter that invokes a delegate Filter only if the request URL matches the pattern it is mapped to using pattern matching as defined in the Servlet spec.

从以下版本开始:

4.0

作者:

Rob Winch, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private static final String	ALL_MAPPING_PATTERN
private final jakarta.servlet.Filter	delegate
private final EnumSet<jakarta.servlet.DispatcherType>	dispatcherTypes
private final List<String>	endsWithMatches	Patterns that require the request URL to have a specific suffix, e.g. "*.html"
private final List<String>	exactMatches	Patterns that require an exact match, e.g.
private static final String	EXTENSION_MAPPING_PATTERN
private final Function<jakarta.servlet.ServletContext,jakarta.servlet.FilterConfig>	filterConfigInitializer
private final boolean	hasPatterns
private static final String	PATH_MAPPING_PATTERN
private final List<String>	startsWithMatches	Patterns that require the URL to have a specific prefix, e.g.

构造器概要

构造器

构造器	说明
MockMvcFilterDecorator(jakarta.servlet.Filter delegate, String[] urlPatterns)	Create instance with URL patterns only.
MockMvcFilterDecorator(jakarta.servlet.Filter delegate, String filterName, Map<String,String> initParams, EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes, String... urlPatterns)	Create instance with init parameters to initialize the filter with, as well as dispatcher types and URL patterns to match.

方法概要

修饰符和类型	方法	说明
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain filterChain)
private static Function<jakarta.servlet.ServletContext,jakarta.servlet.FilterConfig>	getFilterConfigInitializer(String filterName, Map<String,String> initParams)
void	init(jakarta.servlet.FilterConfig filterConfig)
void	initIfRequired(jakarta.servlet.ServletContext servletContext)
private boolean	initPatterns(String... urlPatterns)
private boolean	matchDispatcherType(jakarta.servlet.DispatcherType dispatcherType)
private boolean	matchRequestPath(String requestPath)

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

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

字段详细资料

ALL_MAPPING_PATTERN

private static final String ALL_MAPPING_PATTERN

另请参阅:

• 常量字段值

EXTENSION_MAPPING_PATTERN

private static final String EXTENSION_MAPPING_PATTERN

另请参阅:

• 常量字段值

PATH_MAPPING_PATTERN

private static final String PATH_MAPPING_PATTERN

另请参阅:

• 常量字段值

delegate

private final jakarta.servlet.Filter delegate

filterConfigInitializer

@Nullable
private final Function<jakarta.servlet.ServletContext,jakarta.servlet.FilterConfig> filterConfigInitializer

dispatcherTypes

@Nullable
private final EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes

hasPatterns

private final boolean hasPatterns

exactMatches

private final List<String> exactMatches

Patterns that require an exact match, e.g. "/test"

startsWithMatches

private final List<String> startsWithMatches

Patterns that require the URL to have a specific prefix, e.g. "/test/*"

endsWithMatches

private final List<String> endsWithMatches

Patterns that require the request URL to have a specific suffix, e.g. "*.html"

构造器详细资料

MockMvcFilterDecorator

public MockMvcFilterDecorator(jakarta.servlet.Filter delegate,
 String[] urlPatterns)

Create instance with URL patterns only.

Note: when this constructor is used, the Filter is not initialized.

MockMvcFilterDecorator

public MockMvcFilterDecorator(jakarta.servlet.Filter delegate,
 @Nullable
 String filterName,
 @Nullable
 Map<String,String> initParams,
 @Nullable
 EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes,
 String... urlPatterns)

Create instance with init parameters to initialize the filter with, as well as dispatcher types and URL patterns to match.

方法详细资料

getFilterConfigInitializer

private static Function<jakarta.servlet.ServletContext,jakarta.servlet.FilterConfig> getFilterConfigInitializer(@Nullable
 String filterName,
 @Nullable
 Map<String,String> initParams)

initPatterns

private boolean initPatterns(String... urlPatterns)

doFilter

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

指定者:

doFilter 在接口中 jakarta.servlet.Filter

抛出:

IOException

jakarta.servlet.ServletException

matchDispatcherType

private boolean matchDispatcherType(jakarta.servlet.DispatcherType dispatcherType)

matchRequestPath

private boolean matchRequestPath(String requestPath)

init

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

指定者:

init 在接口中 jakarta.servlet.Filter

抛出:

jakarta.servlet.ServletException

destroy

public void destroy()

指定者:

destroy 在接口中 jakarta.servlet.Filter

initIfRequired

public void initIfRequired(@Nullable
 jakarta.servlet.ServletContext servletContext)
                    throws jakarta.servlet.ServletException

抛出:

jakarta.servlet.ServletException