jvanzyl 01/12/31 07:31:42
Added: src/java/org/apache/turbine/pipeline TurbinePipeline.java
Log:
- This class will be used as the general receptacle for the mapping process
that takes an XML pipeline description and turns it into an object.
Revision Changes Path
1.1
jakarta-turbine-3/src/java/org/apache/turbine/pipeline/TurbinePipeline.java
Index: TurbinePipeline.java
===================================================================
package org.apache.turbine.pipeline;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
import java.io.IOException;
import java.util.ArrayList;
import org.apache.turbine.Pipeline;
import org.apache.turbine.RunData;
import org.apache.turbine.TurbineException;
import org.apache.turbine.Valve;
import org.apache.turbine.ValveContext;
/**
* Base implementation of a {@link org.apache.turbine.Pipeline}.
* Originally based on code from Catalina and ideas from Apache httpd.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
*/
public class TurbinePipeline
implements Pipeline, ValveContext
{
/**
* Name of this pipeline.
*/
protected String name;
/**
* The set of Valves associated with this Pipeline.
*/
protected Valve[] valves = new Valve[0];
/**
* The set of valve definitions associated with this Pipeline.
* From actual valve instances will be initialized from the
* valve definitions.
*/
protected ArrayList valveDefinitions = new ArrayList();
/**
* The per-thread execution state for processing through this
* pipeline. The actual value is a java.lang.Integer object
* containing the subscript into the <code>values</code> array, or
* a subscript equal to <code>values.length</code> if the basic
* Valve is currently being processed.
*/
protected ThreadLocal state = new ThreadLocal();
public void init()
{
}
/**
* Set the name of this pipeline.
*
* @param name Name of this pipeline.
*/
public void setName(String name)
{
this.name = name;
}
/**
* Get the name of this pipeline.
*
* @return String Name of this pipeline.
*/
public String getName()
{
return name;
}
/**
* Add a ValveDefinition to this pipeline.
*/
public void addValveDefinition(ValveDefinition valveDefinition)
{
valveDefinitions.add(valveDefinition);
}
/**
* Return the configured valve definitions.
*
* @return ArrayList Valve definitions for this pipeline.
*/
public ArrayList getValveDefinitions()
{
return valveDefinitions;
}
/**
* Return the ValveDefinition specified by the index i.
*
* @return ValveDefintion
*/
public ValveDefinition getValveDefinition(int i)
{
return (ValveDefinition) valveDefinitions.get(i);
}
/**
* @see org.apache.turbine.Pipeline#addValve(Valve)
*/
public void addValve(Valve valve)
{
// Add this Valve to the set associated with this Pipeline
synchronized (valves)
{
Valve[] results = new Valve[valves.length + 1];
System.arraycopy(valves, 0, results, 0, valves.length);
results[valves.length] = valve;
valves = results;
}
}
/**
* @see org.apache.turbine.Pipeline#getValves()
*/
public Valve[] getValves()
{
synchronized (valves)
{
Valve[] results = new Valve[valves.length];
System.arraycopy(valves, 0, results, 0, valves.length);
return results;
}
}
/**
* @see org.apache.turbine.Pipeline#removeValve(Valve)
*/
public void removeValve(Valve valve)
{
synchronized (valves)
{
// Locate this Valve in our list
int index = -1;
for (int i = 0; i < valves.length; i++)
{
if (valve == valves[i])
{
index = i;
break;
}
}
if (index < 0)
{
return;
}
// Remove this valve from our list
Valve[] results = new Valve[valves.length - 1];
int n = 0;
for (int i = 0; i < valves.length; i++)
{
if (i == index)
{
continue;
}
results[n++] = valves[i];
}
valves = results;
}
}
/**
* @see org.apache.turbine.Pipeline#invoke(RunData)
*/
public void invoke(RunData data)
throws TurbineException, IOException
{
// Initialize the per-thread state for this thread
state.set(new Integer(0));
// Invoke the first Valve in this pipeline for this request
invokeNext(data);
}
/**
* @see org.apache.turbine.ValveContext#invokeNext(RunData)
*/
public void invokeNext(RunData data)
throws TurbineException, IOException
{
// Identify the current subscript for the current request thread
Integer current = (Integer) state.get();
int subscript = current.intValue();
if (subscript < valves.length)
{
// Invoke the requested Valve for the current request
// thread and increment its thread-local state.
state.set(new Integer(subscript + 1));
valves[subscript].invoke(data, this);
}
}
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
