org.apache.catalina
Interface Valve

All Known Implementing Classes:
ValveBase

public interface Valve

A Valve is a request processing component associated with a particular Container. A series of Valves are generally associated with each other into a Pipeline. The detailed contract for a Valve is included in the description of the invoke() method below.

HISTORICAL NOTE: The "Valve" name was assigned to this concept because a valve is what you use in a real world pipeline to control and/or modify flows through it.

Version:
$Revision: 1.5 $ $Date: 2004/08/26 22:05:54 $
Author:
Craig R. McClanahan, Gunnar Rjnning, Peter Donald

Method Summary
 java.lang.String getInfo()
          Return descriptive information about this Valve implementation.
 void invoke(Request request, Response response, ValveContext context)
          Perform request processing as required by this Valve.
 

Method Detail

getInfo

public java.lang.String getInfo()
Return descriptive information about this Valve implementation.


invoke

public void invoke(Request request,
                   Response response,
                   ValveContext context)
            throws java.io.IOException,
                   javax.servlet.ServletException

Perform request processing as required by this Valve.

An individual Valve MAY perform the following actions, in the specified order:

A Valve MUST NOT do any of the following things:

Parameters:
request - The servlet request to be processed
response - The servlet response to be created
context - The valve context used to invoke the next valve in the current processing pipeline
Throws:
java.io.IOException - if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet
javax.servlet.ServletException - if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet


Copyright 2000-2002 Apache Software Foundation. All Rights Reserved.