Package spark.http.matching

Class MatcherFilter

java.lang.Object

spark.http.matching.MatcherFilter

All Implemented Interfaces:

jakarta.servlet.Filter

public class MatcherFilter
extends Object
implements jakarta.servlet.Filter

Matches Spark routes and filters.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ACCEPT_TYPE_REQUEST_MIME_HEADER
private ExceptionMapper	exceptionMapper
private boolean	externalContainer
private boolean	hasOtherHandlers
private static final String	HTTP_METHOD_OVERRIDE_HEADER
private static final org.slf4j.Logger	LOG
private Routes	routeMatcher
private SerializerChain	serializerChain
private final StaticFilesConfiguration	staticFiles

Constructor Summary

Constructors

Constructor	Description
MatcherFilter(Routes routeMatcher, StaticFilesConfiguration staticFiles, ExceptionMapper exceptionMapper, boolean externalContainer, boolean hasOtherHandlers)	Constructor

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse, jakarta.servlet.FilterChain chain)
private String	getHttpMethodFrom(jakarta.servlet.http.HttpServletRequest httpRequest)
void	init(jakarta.servlet.FilterConfig config)

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

ACCEPT_TYPE_REQUEST_MIME_HEADER

private static final String ACCEPT_TYPE_REQUEST_MIME_HEADER

See Also:

• Constant Field Values

HTTP_METHOD_OVERRIDE_HEADER

private static final String HTTP_METHOD_OVERRIDE_HEADER

See Also:

• Constant Field Values

staticFiles

private final StaticFilesConfiguration staticFiles

routeMatcher

private Routes routeMatcher

serializerChain

private SerializerChain serializerChain

exceptionMapper

private ExceptionMapper exceptionMapper

externalContainer

private boolean externalContainer

hasOtherHandlers

private boolean hasOtherHandlers

Constructor Details

MatcherFilter

public MatcherFilter(Routes routeMatcher,
 StaticFilesConfiguration staticFiles,
 ExceptionMapper exceptionMapper,
 boolean externalContainer,
 boolean hasOtherHandlers)

Constructor

Parameters:

routeMatcher - The route matcher

staticFiles - The static files configuration object

externalContainer - Tells the filter that Spark is run in an external web container. If true, chain.doFilter will be invoked if request is not consumed by Spark.

hasOtherHandlers - If true, do nothing if request is not consumed by Spark in order to let others handlers process the request.

Method Details

init

public void init(jakarta.servlet.FilterConfig config)

Specified by:

init in interface jakarta.servlet.Filter

doFilter

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

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

IOException

jakarta.servlet.ServletException

getHttpMethodFrom

private String getHttpMethodFrom(jakarta.servlet.http.HttpServletRequest httpRequest)

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Filter