|
Apache Tomcat 7.0.37 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.catalina.filters.FilterBase org.apache.catalina.filters.RequestFilter
public abstract class RequestFilter
Implementation of a Filter that performs filtering based on comparing the appropriate request property (selected based on which subclass you choose to configure into your Container's pipeline) against the regular expressions configured for this Filter.
This filter is configured by setting the allow
and/or
deny
properties to a regular expressions (in the syntax
supported by Pattern
) to which the appropriate request property will
be compared. Evaluation proceeds as follows:
process()
method.
Field Summary | |
---|---|
protected Pattern |
allow
The regular expression used to test for allowed requests. |
protected Pattern |
deny
The regular expression used to test for denied requests. |
protected int |
denyStatus
The HTTP response status code that is used when rejecting denied request. |
Fields inherited from class org.apache.catalina.filters.FilterBase |
---|
sm |
Constructor Summary | |
---|---|
RequestFilter()
|
Method Summary | |
---|---|
abstract void |
doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
Extract the desired request property, and pass it (along with the specified request and response objects) to the protected process() method to perform the actual filtering. |
String |
getAllow()
Return the regular expression used to test for allowed requests for this Filter, if any; otherwise, return null . |
String |
getDeny()
Return the regular expression used to test for denied requests for this Filter, if any; otherwise, return null . |
int |
getDenyStatus()
Return response status code that is used to reject denied request. |
protected boolean |
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. |
protected void |
process(String property,
ServletRequest request,
ServletResponse response,
FilterChain chain)
Perform the filtering that has been configured for this Filter, matching against the specified request property. |
protected void |
processCometEvent(String property,
CometEvent event,
CometFilterChain chain)
Perform the filtering that has been configured for this Filter, matching against the specified request property. |
void |
setAllow(String allow)
Set the regular expression used to test for allowed requests for this Filter, if any. |
void |
setDeny(String deny)
Set the regular expression used to test for denied requests for this Filter, if any. |
void |
setDenyStatus(int denyStatus)
Set response status code that is used to reject denied request. |
Methods inherited from class org.apache.catalina.filters.FilterBase |
---|
destroy, getLogger, init |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.catalina.comet.CometFilter |
---|
doFilterEvent |
Methods inherited from interface javax.servlet.Filter |
---|
destroy, init |
Field Detail |
---|
protected Pattern allow
protected Pattern deny
protected int denyStatus
Constructor Detail |
---|
public RequestFilter()
Method Detail |
---|
public String getAllow()
null
.
public void setAllow(String allow)
allow
- The new allow expressionpublic String getDeny()
null
.
public void setDeny(String deny)
deny
- The new deny expressionpublic int getDenyStatus()
public void setDenyStatus(int denyStatus)
public abstract void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
process()
method to perform the actual filtering.
This method must be implemented by a concrete subclass.
doFilter
in interface Filter
request
- The servlet request to be processedresponse
- The servlet response to be createdchain
- The filter chain
IOException
- if an input/output error occurs
ServletException
- if a servlet error occursprotected boolean isConfigProblemFatal()
FilterBase
isConfigProblemFatal
in class FilterBase
true
if a problem should trigger the failure of this
filter, else false
protected void process(String property, ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
property
- The request property on which to filterrequest
- The servlet request to be processedresponse
- The servlet response to be processed
IOException
- if an input/output error occurs
ServletException
- if a servlet error occursprotected void processCometEvent(String property, CometEvent event, CometFilterChain chain) throws IOException, ServletException
property
- The property to check against the allow/deny rulesevent
- The comet event to be filteredchain
- The comet filter chain
IOException
- if an input/output error occurs
ServletException
- if a servlet error occurs
|
Apache Tomcat 7.0.37 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |