You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by dl...@apache.org on 2002/02/10 00:55:53 UTC
cvs commit: jakarta-turbine-3/src/java/org/apache/turbine/pipeline BypassableValve.java
dlr 02/02/09 15:55:53
Added: src/java/org/apache/turbine/pipeline BypassableValve.java
Log:
Code by James Taylor <ja...@jamestaylor.org> introducing a
conditionally executable set of Valves. I modified James' code to
subclass BranchPointValve.
Revision Changes Path
1.1 jakarta-turbine-3/src/java/org/apache/turbine/pipeline/BypassableValve.java
Index: BypassableValve.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 apache@apache.org.
*
* 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 org.apache.turbine.Pipeline;
import org.apache.turbine.RunData;
import org.apache.turbine.TurbineException;
import org.apache.turbine.Valve;
import org.apache.turbine.ValveContext;
import org.apache.log4j.Category;
/**
* Valve that conditionally executes a set of valves (internally
* contained in a <code>TurbinePipeline</code>).
*
* @author <a href="mailto:james@jamestaylor.org">James Taylor</a>
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
* @version $Id: BypassableValve.java,v 1.1 2002/02/09 23:55:53 dlr Exp $
*/
public abstract class BypassableValve
extends BranchPointValve
{
private static final Category log =
Category.getInstance( BypassableValve.class );
/**
* Sets up our <code>TurbinePipeline</code> instance.
*/
protected BypassableValve()
{
pipelines = new Pipeline[] { new TurbinePipeline() };
}
/**
* Adds the provided valve to the contained pipeline.
*/
public void addValve( Valve valve )
{
pipelines[0].addValve( valve );
}
/**
* @see org.apache.turbine.Valve#initialize
*/
public void initialize()
throws Exception
{
pipelines[0].initialize();
}
/**
* @see org.apache.turbine.Valve#invoke
*/
public void invoke( RunData data, ValveContext context )
throws IOException, TurbineException
{
if ( !bypass(data) )
{
log.debug("Invoking conditional pipeline");
pipelines[0].invoke( data );
}
context.invokeNext( data );
}
/**
* Determine whether the contained valves should be
* run. Subclasses should implement this method.
*
* @return Whether the contained valves should be run.
*/
protected abstract boolean bypass( RunData data );
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: cvs commit: jakarta-turbine-3/src/java/org/apache/turbine/pipeline BypassableValve.java
Posted by Daniel Rall <dl...@finemaltcoding.com>.
James, I renamed this class but am not particularly attached to the
new name if you'd prefer to go with the old (I was looking for a more
hardware store-like metaphor). What I would like to keep is the
change in conditional test name (from "doTest" to "bypass"), and thus
the reversed semantics of the method.
Thanks, Dan
dlr@apache.org writes:
> dlr 02/02/09 15:55:53
>
> Added: src/java/org/apache/turbine/pipeline BypassableValve.java
> Log:
> Code by James Taylor <ja...@jamestaylor.org> introducing a
> conditionally executable set of Valves. I modified James' code to
> subclass BranchPointValve.
>
> Revision Changes Path
> 1.1 jakarta-turbine-3/src/java/org/apache/turbine/pipeline/BypassableValve.java
>
> Index: BypassableValve.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 apache@apache.org.
> *
> * 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 org.apache.turbine.Pipeline;
> import org.apache.turbine.RunData;
> import org.apache.turbine.TurbineException;
> import org.apache.turbine.Valve;
> import org.apache.turbine.ValveContext;
>
> import org.apache.log4j.Category;
>
> /**
> * Valve that conditionally executes a set of valves (internally
> * contained in a <code>TurbinePipeline</code>).
> *
> * @author <a href="mailto:james@jamestaylor.org">James Taylor</a>
> * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
> * @version $Id: BypassableValve.java,v 1.1 2002/02/09 23:55:53 dlr Exp $
> */
> public abstract class BypassableValve
> extends BranchPointValve
> {
> private static final Category log =
> Category.getInstance( BypassableValve.class );
>
> /**
> * Sets up our <code>TurbinePipeline</code> instance.
> */
> protected BypassableValve()
> {
> pipelines = new Pipeline[] { new TurbinePipeline() };
> }
>
> /**
> * Adds the provided valve to the contained pipeline.
> */
> public void addValve( Valve valve )
> {
> pipelines[0].addValve( valve );
> }
>
> /**
> * @see org.apache.turbine.Valve#initialize
> */
> public void initialize()
> throws Exception
> {
> pipelines[0].initialize();
> }
>
> /**
> * @see org.apache.turbine.Valve#invoke
> */
> public void invoke( RunData data, ValveContext context )
> throws IOException, TurbineException
> {
> if ( !bypass(data) )
> {
> log.debug("Invoking conditional pipeline");
> pipelines[0].invoke( data );
> }
>
> context.invokeNext( data );
> }
>
> /**
> * Determine whether the contained valves should be
> * run. Subclasses should implement this method.
> *
> * @return Whether the contained valves should be run.
> */
> protected abstract boolean bypass( RunData data );
> }
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>