org.apache.turbine.pipeline
Class ExecutePageValve

java.lang.Object
  org.apache.turbine.pipeline.AbstractValve
      org.apache.turbine.pipeline.ExecutePageValve

All Implemented Interfaces:

Valve

public class ExecutePageValve

extends AbstractValve

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

Version:

$Id: ExecutePageValve.java,v 1.3 2004/08/02 08:57:29 epugh Exp $

Author:

Eric Pugh, Peter Courcoux

Field Summary

(package private) org.apache.commons.logging.Log	log
(package private) TemplateService	templateService

Constructor Summary

ExecutePageValve()
Creates a new instance.

Method Summary

protected void	executePage(PipelineData pipelineData) execute the page generation.
void	invoke(PipelineData pipelineData, ValveContext context) Perform request processing as required by this Valve.

Methods inherited from class org.apache.turbine.pipeline.AbstractValve

getRunData, initialize

Methods inherited from class java.lang.Object

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

Field Detail

log

org.apache.commons.logging.Log log

templateService

TemplateService templateService

Constructor Detail

ExecutePageValve

public ExecutePageValve()

Creates a new instance.

Method Detail

invoke

public void invoke(PipelineData pipelineData,
                   ValveContext context)
            throws java.io.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

Specified by:

invoke in class AbstractValve

Throws:

java.io.IOException

TurbineException

See Also:

org.apache.turbine.Valve#invoke(RunData, ValveContext)

executePage

protected void executePage(PipelineData pipelineData)
                    throws java.lang.Exception

execute the page generation.

Throws:

java.lang.Exception