|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.catalina.valves.ValveBase org.apache.catalina.valves.RequestFilterValve
Implementation of a Valve 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 a set of regular expressions configured for this Valve.
This valve is configured by setting the allow
and/or
deny
properties to a comma-delimited list of regular
expressions (in the syntax supported by the jakarta-regexp library) to
which the appropriate request property will be compared. Evaluation
proceeds as follows:
process()
method.
This Valve may be attached to any Container, depending on the granularity of the filtering you wish to perform.
Field Summary | |
protected java.lang.String |
allow
The comma-delimited set of allow expressions. |
protected org.apache.regexp.REProgram[] |
allows
The set of allow pre-compiled regular expressions we will
evaluate. |
protected org.apache.regexp.REProgram[] |
denies
The set of deny pre-compiled regular expressions we will
evaluate. |
protected java.lang.String |
deny
The comma-delimited set of deny expressions. |
protected static StringManager |
sm
The StringManager for this package. |
Fields inherited from class org.apache.catalina.valves.ValveBase |
container, debug |
Constructor Summary | |
RequestFilterValve()
|
Method Summary | |
java.lang.String |
getAllow()
Return a comma-delimited set of the allow expressions
configured for this Valve, if any; otherwise, return null . |
java.lang.String |
getDeny()
Return a comma-delimited set of the deny expressions
configured for this Valve, if any; otherwise, return null . |
java.lang.String |
getInfo()
Return descriptive information about this Valve implementation. |
abstract void |
invoke(Request request,
Response response,
ValveContext context)
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. |
protected org.apache.regexp.REProgram[] |
precalculate(java.lang.String list)
Return an array of pre-compiled regular expression objects initialized from the specified argument, which must be null or a
comma-delimited list of regular expression patterns. |
protected void |
process(java.lang.String property,
Request request,
Response response,
ValveContext context)
Perform the filtering that has been configured for this Valve, matching against the specified request property. |
void |
setAllow(java.lang.String allow)
Set the comma-delimited set of the allow expressions
configured for this Valve, if any. |
void |
setDeny(java.lang.String deny)
Set the comma-delimited set of the deny expressions
configured for this Valve, if any. |
Methods inherited from class org.apache.catalina.valves.ValveBase |
getContainer, getDebug, setContainer, setDebug |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.String allow
allow
expressions.
protected org.apache.regexp.REProgram[] allows
allow
pre-compiled regular expressions we will
evaluate.
protected org.apache.regexp.REProgram[] denies
deny
pre-compiled regular expressions we will
evaluate.
protected java.lang.String deny
deny
expressions.
protected static StringManager sm
Constructor Detail |
public RequestFilterValve()
Method Detail |
public java.lang.String getAllow()
allow
expressions
configured for this Valve, if any; otherwise, return null
.
public void setAllow(java.lang.String allow)
allow
expressions
configured for this Valve, if any.
allow
- The new set of allow expressionspublic java.lang.String getDeny()
deny
expressions
configured for this Valve, if any; otherwise, return null
.
public void setDeny(java.lang.String deny)
deny
expressions
configured for this Valve, if any.
deny
- The new set of deny expressionspublic java.lang.String getInfo()
getInfo
in interface Valve
getInfo
in class ValveBase
public abstract void invoke(Request request, Response response, ValveContext context) throws java.io.IOException, javax.servlet.ServletException
process()
method to perform the actual filtering.
This method must be implemented by a concrete subclass.
invoke
in interface Valve
invoke
in class ValveBase
request
- The servlet request to be processedresponse
- The servlet response to be createdcontext
- The valve context used to invoke the next valve
in the current processing pipeline
java.io.IOException
- if an input/output error occurs
javax.servlet.ServletException
- if a servlet error occursprotected org.apache.regexp.REProgram[] precalculate(java.lang.String list)
null
or a
comma-delimited list of regular expression patterns.
list
- The comma-separated list of patterns
java.lang.IllegalArgumentException
- if one of the patterns has
invalid syntaxprotected void process(java.lang.String property, Request request, Response response, ValveContext context) throws java.io.IOException, javax.servlet.ServletException
property
- The request property on which to filterrequest
- The servlet request to be processedresponse
- The servlet response to be processedcontext
- The valve context used to invoke the next valve
in the current processing pipeline
java.io.IOException
- if an input/output error occurs
javax.servlet.ServletException
- if a servlet error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |