| java.lang.Object
 org.apache.catalina.valves.ValveBase
All known Subclasses: org.apache.catalina.valves.RequestDumperValve, org.apache.catalina.valves.ErrorDispatcherValve, org.apache.catalina.authenticator.AuthenticatorBase, org.apache.catalina.authenticator.SingleSignOn, org.apache.catalina.core.StandardHostValve, org.apache.catalina.core.StandardContextValve, org.apache.catalina.core.StandardWrapperValve, org.apache.catalina.valves.JDBCAccessLogValve, org.apache.catalina.valves.RequestFilterValve, org.apache.catalina.valves.CertificatesValve, org.apache.catalina.valves.ErrorReportValve, org.apache.catalina.valves.AccessLogValve, org.apache.catalina.core.StandardEngineValve,
| ValveBase | | abstract public class ValveBase implements Contained,Valve(Code) | | Convenience base class for implementations of the Valve interface.
A subclass MUST implement an invoke()
method to provide the required functionality, and MAY
implement the Lifecycle interface to provide configuration
management and lifecycle support.
author:
Craig R. McClanahan
version:
$Revision: 1.4 $ $Date: 2002/01/25 20:12:27 $ |
| Field Summary | |
| protected Container | container
The Container whose pipeline this Valve is a component of. | | protected int | debug
The debugging detail level for this component. | | protected static String | info
Descriptive information about this Valve implementation. | | final protected static StringManager | sm
The string manager for this package. |
| Method Summary | |
| public Container | getContainer()
Return the Container with which this Valve is associated, if any. | | public int | getDebug()
Return the debugging detail level for this component. | | public String | getInfo()
Return descriptive information about this Valve implementation. | | abstract public void | invoke(Request request, Response response, ValveContext context)
The implementation-specific logic represented by this Valve. | | public void | setContainer(Container container)
Set the Container with which this Valve is associated, if any. | | public void | setDebug(int debug)
Set the debugging detail level for this component. |
| container | | protected Container container(Code) | | The Container whose pipeline this Valve is a component of.
|
| debug | | protected int debug(Code) | | The debugging detail level for this component.
|
| info | | protected static String info(Code) | | Descriptive information about this Valve implementation. This value
should be overridden by subclasses.
|
| getContainer | | public Container getContainer()(Code) | | Return the Container with which this Valve is associated, if any.
|
| getDebug | | public int getDebug()(Code) | | Return the debugging detail level for this component.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Valve implementation.
|
| invoke | | abstract public void invoke(Request request, Response response, ValveContext context) throws IOException, ServletException(Code) | | The implementation-specific logic represented by this Valve. See the
Valve description for the normal design patterns for this method.
This method MUST be provided by a subclass.
Parameters:
request - The servlet request to be processed
Parameters:
response - The servlet response to be created
Parameters:
context - The valve context used to invoke the next valvein the current processing pipeline
exception:
IOException - if an input/output error occurs
exception:
ServletException - if a servlet error occurs |
| setContainer | | public void setContainer(Container container)(Code) | | Set the Container with which this Valve is associated, if any.
Parameters:
container - The new associated container |
| setDebug | | public void setDebug(int debug)(Code) | | Set the debugging detail level for this component.
Parameters:
debug - The new debugging detail level |
|
|