org.apache.turbine.pipeline
Interface Valve

All Known Implementing Classes:
AbstractValve, CleanUpValve, DefaultACLCreationValve, DefaultLoginValve, DefaultSessionTimeoutValve, DefaultSessionValidationValve, DetermineActionValve, DetermineRedirectRequestedValve, DetermineTargetValve, ExecutePageValve

public interface Valve

A Valve is a request processing component. 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.

Author:
Craig R. McClanahan, Gunnar Rjnning, Peter Donald, Daniel Rall
See Also:
#invoke(RunData, ValveContext)

Method Summary
 void initialize()
          Initialize the valve before using in a pipeline.
 void invoke(PipelineData data, ValveContext context)
          Perform request processing as required by this Valve.
 

Method Detail

invoke

void invoke(PipelineData data,
            ValveContext context)
            throws IOException,
                   TurbineException

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:
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.

initialize

void initialize()
                throws Exception
Initialize the valve before using in a pipeline.

Throws:
Exception


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