org.apache.turbine.pipeline
Class AbstractValve

java.lang.Object
  extended by org.apache.turbine.pipeline.AbstractValve
All Implemented Interfaces:
Valve
Direct Known Subclasses:
CleanUpValve, DefaultACLCreationValve, DefaultLoginValve, DefaultSessionTimeoutValve, DefaultSessionValidationValve, DetermineActionValve, DetermineRedirectRequestedValve, DetermineTargetValve, ExecutePageValve

public abstract class AbstractValve
extends Object
implements Valve

Valve that can be used as the basis of Valve implementations.

Version:
$Id: AbstractValve.java 757213 2009-03-22 16:43:31Z tv $
Author:
Jason van Zyl, Peter Courcoux

Constructor Summary
AbstractValve()
           
 
Method Summary
 RunData getRunData(PipelineData pipelineData)
          utility for getting RunData out of the pielineData object.
 void initialize()
          Initialize this valve for use in a pipeline.
abstract  void invoke(PipelineData data, 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
 

Constructor Detail

AbstractValve

public AbstractValve()
Method Detail

initialize

public void initialize()
                throws Exception
Initialize this valve for use in a pipeline.

Specified by:
initialize in interface Valve
Throws:
Exception

invoke

public abstract void invoke(PipelineData data,
                            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:

A Valve MUST NOT do any of the following things:

Specified by:
invoke in interface Valve
Parameters:
data - 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:
org.apache.turbine.Valve#invoke(PipelineData, ValveContext)

getRunData

public final RunData getRunData(PipelineData pipelineData)
utility for getting RunData out of the pielineData object.

Parameters:
pipelineData -
Returns:


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