org.apache.turbine.pipeline

Class CleanUpValve

java.lang.Object

org.apache.turbine.pipeline.CleanUpValve

All Implemented Interfaces:

Valve

public class CleanUpValve
extends Object
implements Valve

Implements the RunData target portion of the "Turbine classic" processing pipeline (from the Turbine 2.x series).

Version:

$Id: CleanUpValve.java 1854797 2019-03-04 20:41:39Z tv $

Author:

Jason van Zyl, Jon S. Stevens, Daniel Rall, Mike Haberman, James Taylor, Martin Poeschl, Peter Courcoux

Constructor Summary

Constructors

Constructor and Description
CleanUpValve() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	cleanUp(PipelineData pipelineData) Perform clean up after processing the request.
void	invoke(PipelineData pipelineData, ValveContext context) Perform request processing as required by this Valve.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.turbine.pipeline.Valve

initialize

Constructor Detail

CleanUpValve

public CleanUpValve()

Creates a new instance.

Method Detail

invoke

public void invoke(PipelineData pipelineData,
                   ValveContext context)
            throws IOException,
                   TurbineException

Description copied from interface: Valve

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.
• Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller.
• Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on.
• If the corresponding Response was not generated (and control was not returned, call the next Valve in the pipeline (if there is one) by executing context.invokeNext().
• Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve via a call to context.invokeNext()).

A Valve MUST NOT do any of the following things:

• Change request properties that have already been used to direct the flow of processing control for this request.
• Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline.
• Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on.
• Modify the HTTP headers included with the Response after the invokeNext() method has returned.
• Perform any actions on the output stream associated with the specified Response after the invokeNext() method has returned.

Specified by:

invoke in interface Valve

Parameters:

pipelineData - The run-time information, including the servlet request and response we are processing.

context - The valve context used to invoke the next valve in the current processing pipeline

Throws:

IOException - Thrown by a subsequent Valve.

TurbineException - Thrown by a subsequent Valve.

See Also:

Valve.invoke(PipelineData, ValveContext)

cleanUp

protected void cleanUp(PipelineData pipelineData)

Perform clean up after processing the request.

Parameters:

pipelineData - The run-time data.