| java.lang.Object
 org.apache.catalina.valves.ValveBase
All known Subclasses: org.apache.catalina.valves.JDBCAccessLogValve, org.apache.catalina.valves.SSLValve, org.apache.catalina.authenticator.SingleSignOn, org.apache.catalina.valves.RequestFilterValve, org.apache.catalina.valves.AccessLogValve, org.apache.catalina.ha.session.JvmRouteBinderValve, org.apache.catalina.valves.PersistentValve, org.apache.catalina.ha.tcp.ReplicationValve, org.apache.catalina.core.StandardContextValve, org.apache.catalina.valves.RequestDumperValve, org.apache.catalina.valves.SemaphoreValve, org.apache.catalina.core.StandardHostValve, org.apache.catalina.valves.ErrorReportValve, org.apache.catalina.core.StandardWrapperValve, org.apache.catalina.authenticator.AuthenticatorBase, org.apache.catalina.core.StandardEngineValve, org.apache.catalina.valves.CometConnectionManagerValve,
| ValveBase | | abstract public class ValveBase implements Contained,Valve,MBeanRegistration(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: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $ |
| Method Summary | |
| public void | backgroundProcess()
Execute a periodic task, such as reloading, etc. | | public ObjectName | createObjectName(String domain, ObjectName parent)
| | public void | event(Request request, Response response, CometEvent event)
Process a Comet event. | | public Container | getContainer()
Return the Container with which this Valve is associated, if any. | | public ObjectName | getContainerName()
| | public ObjectName | getController()
| | public String | getDomain()
| | public String | getInfo()
Return descriptive information about this Valve implementation. | | public Valve | getNext()
Return the next Valve in this pipeline, or null if this
is the last Valve in the pipeline. | | public ObjectName | getObjectName()
| | public ObjectName | getParentName(ObjectName valveName)
| | abstract public void | invoke(Request request, Response response)
The implementation-specific logic represented by this Valve. | | public void | postDeregister()
| | public void | postRegister(Boolean registrationDone)
| | public void | preDeregister()
| | public ObjectName | preRegister(MBeanServer server, ObjectName name)
| | public void | setContainer(Container container)
Set the Container with which this Valve is associated, if any. | | public void | setController(ObjectName controller)
| | public void | setNext(Valve valve)
Set the Valve that follows this one in the pipeline it is part of. | | public void | setObjectName(ObjectName oname)
| | public String | toString()
Return a String rendering of this object. |
| container | | protected Container container(Code) | | The Container whose pipeline this Valve is a component of.
|
| containerLog | | protected Log containerLog(Code) | | Container log
|
| info | | protected static String info(Code) | | Descriptive information about this Valve implementation. This value
should be overridden by subclasses.
|
| next | | protected Valve next(Code) | | The next Valve in the pipeline this Valve is a component of.
|
| backgroundProcess | | public void backgroundProcess()(Code) | | Execute a periodic task, such as reloading, etc. This method will be
invoked inside the classloading context of this container. Unexpected
throwables will be caught and logged.
|
| event | | public void event(Request request, Response response, CometEvent event) throws IOException, ServletException(Code) | | Process a Comet event. This method will rarely need to be provided by
a subclass, unless it needs to reassociate a particular object with
the thread that is processing the request.
Parameters:
request - The servlet request to be processed
Parameters:
response - The servlet response to be created
exception:
IOException - if an input/output error occurs, or is thrownby a subsequently invoked Valve, Filter, or Servlet
exception:
ServletException - if a servlet error occurs, or is thrownby a subsequently invoked Valve, Filter, or Servlet |
| getContainer | | public Container getContainer()(Code) | | Return the Container with which this Valve is associated, if any.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Valve implementation.
|
| getNext | | public Valve getNext()(Code) | | Return the next Valve in this pipeline, or null if this
is the last Valve in the pipeline.
|
| getParentName | | public ObjectName getParentName(ObjectName valveName)(Code) | | From the name, extract the parent object name
Parameters:
valveName - The valve name ObjectName The parent name |
| invoke | | abstract public void invoke(Request request, Response response) 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
exception:
IOException - if an input/output error occurs
exception:
ServletException - if a servlet error occurs |
| postDeregister | | public void postDeregister()(Code) | | |
| postRegister | | public void postRegister(Boolean registrationDone)(Code) | | |
| setContainer | | public void setContainer(Container container)(Code) | | Set the Container with which this Valve is associated, if any.
Parameters:
container - The new associated container |
| setNext | | public void setNext(Valve valve)(Code) | | Set the Valve that follows this one in the pipeline it is part of.
Parameters:
valve - The new next valve |
| toString | | public String toString()(Code) | | Return a String rendering of this object.
|
|
|