org.apache.catalina

Interface Valve

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: 796156 $ $Date: 2009-07-21 08:29:47 +0200 (Tue, 21 Jul 2009) $

Author: Craig R. McClanahan Gunnar Rjnning Peter Donald

Method Summary
voidbackgroundProcess()
Execute a periodic task, such as reloading, etc.
voidevent(Request request, Response response, CometEvent event)
Process a Comet event.
StringgetInfo()
Return descriptive information about this Valve implementation.
ValvegetNext()
Return the next Valve in the pipeline containing this Valve, if any.
voidinvoke(Request request, Response response)

Perform request processing as required by this Valve.

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

  • Examine and/or modify the properties of the specified Request and Response.
voidsetNext(Valve valve)
Set the next Valve in the pipeline containing this Valve.

Method Detail

backgroundProcess

public void backgroundProcess()
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)
Process a Comet event.

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

Throws: IOException if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet ServletException if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

getInfo

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

getNext

public Valve getNext()
Return the next Valve in the pipeline containing this Valve, if any.

invoke

public void invoke(Request request, Response response)

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

Throws: IOException if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet ServletException if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

setNext

public void setNext(Valve valve)
Set the next Valve in the pipeline containing this Valve.

Parameters: valve The new next valve, or null if none

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.