RequestFilterValve (Apache Tomcat 6.0.24 API Documentation)

Class RequestFilterValve

public abstract class RequestFilterValve extends ValveBase

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:

The subclass extracts the request property to be filtered, and calls the common process() method.
If there are any deny expressions configured, the property will be compared to each such expression. If a match is found, this request will be rejected with a "Forbidden" HTTP response.
If there are any allow expressions configured, the property will be compared to each such expression. If a match is found, this request will be allowed to pass through to the next Valve in the current pipeline.
If one or more deny expressions was specified but no allow expressions, allow this request to pass through (because none of the deny expressions matched it).
The request will be rejected with a "Forbidden" HTTP response.

This Valve may be attached to any Container, depending on the granularity of the filtering you wish to perform.

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Field Summary
protected String	allow The comma-delimited set of `allow` expressions.
protected Pattern[]	allows The set of `allow` regular expressions we will evaluate.
protected Pattern[]	denies The set of `deny` regular expressions we will evaluate.
protected String	deny The comma-delimited set of `deny` expressions.
protected static StringManager	sm The StringManager for this package.

Field Summary

protected String

allow

The comma-delimited set of allow expressions.

protected Pattern[]

allows

The set of allow regular expressions we will evaluate.

protected Pattern[]

denies

The set of deny regular expressions we will evaluate.

protected String

deny

The comma-delimited set of deny expressions.

protected static StringManager

The StringManager for this package.

Method Summary
String	getAllow() Return a comma-delimited set of the `allow` expressions configured for this Valve, if any; otherwise, return `null`.
String	getDeny() Return a comma-delimited set of the `deny` expressions configured for this Valve, if any; otherwise, return `null`.
String	getInfo() Return descriptive information about this Valve implementation.
abstract void	invoke(Request request, Response response) 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 Pattern[]	precalculate(String list) Return an array of regular expression objects initialized from the specified argument, which must be `null` or a comma-delimited list of regular expression patterns.
protected void	process(String property, Request request, Response response) Perform the filtering that has been configured for this Valve, matching against the specified request property.
void	setAllow(String allow) Set the comma-delimited set of the `allow` expressions configured for this Valve, if any.
void	setDeny(String deny) Set the comma-delimited set of the `deny` expressions configured for this Valve, if any.

Method Summary

String

getAllow()

Return a comma-delimited set of the allow expressions configured for this Valve, if any; otherwise, return null.

String

getDeny()

Return a comma-delimited set of the deny expressions configured for this Valve, if any; otherwise, return null.

String

getInfo()

Return descriptive information about this Valve implementation.

abstract void

invoke(Request request, Response response)

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 Pattern[]

precalculate(String list)

Return an array of regular expression objects initialized from the specified argument, which must be null or a comma-delimited list of regular expression patterns.

protected void

process(String property, Request request, Response response)

Perform the filtering that has been configured for this Valve, matching against the specified request property.

void

setAllow(String allow)

Set the comma-delimited set of the allow expressions configured for this Valve, if any.

void

setDeny(String deny)

Set the comma-delimited set of the deny expressions configured for this Valve, if any.

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. This method must be implemented by a concrete subclass.

Parameters: request The servlet request to be processed response The servlet response to be created

Throws: IOException if an input/output error occurs ServletException if a servlet error occurs

precalculate

Return an array of regular expression objects initialized from the specified argument, which must be null or a comma-delimited list of regular expression patterns.

Parameters: list The comma-separated list of patterns

Throws: IllegalArgumentException if one of the patterns has invalid syntax

process

Perform the filtering that has been configured for this Valve, matching against the specified request property.

Parameters: property The request property on which to filter request The servlet request to be processed response The servlet response to be processed

Throws: IOException if an input/output error occurs ServletException if a servlet error occurs