public abstract class RequestFilter extends FilterBase implements CometFilter
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.
Modifier and Type | Field and Description |
---|---|
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.
|
sm
Constructor and Description |
---|
RequestFilter() |
Modifier and Type | Method and Description |
---|---|
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.
|
destroy, getLogger, init
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
doFilterEvent
protected Pattern allow
protected Pattern deny
protected int denyStatus
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 chainIOException
- if an input/output error occursServletException
- 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 processedIOException
- if an input/output error occursServletException
- 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 chainIOException
- if an input/output error occursServletException
- if a servlet error occursCopyright © 2000-2021 Apache Software Foundation. All Rights Reserved.