Top Description Fields Constructors Methods
org.apache.catalina.filters

public Class FailedRequestFilter

extends FilterBase
Class Inheritance
Imports
java.io.IOException, jakarta.servlet.FilterChain, .ServletException, .ServletRequest, .ServletResponse, jakarta.servlet.http.HttpServletResponse, org.apache.catalina.Globals, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.http.Parameters.FailReason
Filter that will reject requests if there was a failure during parameter parsing. This filter can be used to ensure that none parameter values submitted by client are lost.

Note that parameter parsing may consume the body of an HTTP request, so caution is needed if the servlet protected by this filter uses request.getInputStream() or request.getReader() calls. In general the risk of breaking a web application by adding this filter is not so high, because parameter parsing does check content type of the request before consuming the request body.

Field Summary

Modifier and TypeField and Description
private final Log
log

Inherited from org.apache.catalina.filters.FilterBase:
sm

Constructor Summary

AccessConstructor and Description
public
FailedRequestFilter()

Method Summary

Modifier and TypeMethod and Description
public void
doFilter(ServletRequest
The request to process
request, ServletResponse
The response associated with the request
response, FilterChain
Provides access to the next filter in the chain for this filter to pass the request and response to for further processing
chain)

Implements jakarta.servlet.Filter.doFilter.

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.

protected Log
getLogger()

Implements abstract org.apache.catalina.filters.FilterBase.getLogger.

protected boolean
isConfigProblemFatal()

Overrides org.apache.catalina.filters.FilterBase.isConfigProblemFatal.

Determines if an exception when calling a setter or an unknown configuration attribute triggers the failure of the this filter which in turn will prevent the web application from starting.

private boolean
isGoodRequest(ServletRequest request)

Inherited from org.apache.catalina.filters.FilterBase:
init

Field Detail

logback to summary
private final Log log

Constructor Detail

FailedRequestFilterback to summary
public FailedRequestFilter()

Method Detail

doFilterback to summary
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException

Implements jakarta.servlet.Filter.doFilter.

Doc from jakarta.servlet.Filter.doFilter.

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Parameters
request:ServletRequest

The request to process

response:ServletResponse

The response associated with the request

chain:FilterChain

Provides access to the next filter in the chain for this filter to pass the request and response to for further processing

Annotations
@SuppressWarnings:deprecation
@Override
Exceptions
IOException:
if an I/O error occurs during this filter's processing of the request
ServletException:
if the processing fails for any other reason
getLoggerback to summary
protected Log getLogger()

Implements abstract org.apache.catalina.filters.FilterBase.getLogger.

Annotations
@Override
isConfigProblemFatalback to summary
protected boolean isConfigProblemFatal()

Overrides org.apache.catalina.filters.FilterBase.isConfigProblemFatal.

Doc from org.apache.catalina.filters.FilterBase.isConfigProblemFatal.

Determines if an exception when calling a setter or an unknown configuration attribute triggers the failure of the this filter which in turn will prevent the web application from starting.

Returns:boolean

true if a problem should trigger the failure of this filter, else false

Annotations
@Override
isGoodRequestback to summary
private boolean isGoodRequest(ServletRequest request)