src.openwfe.org.engine.expressions.ConcurrentFlowExpression Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2001-2006, John Mettraux, OpenWFE.org
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * . Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.  
 * 
 * . 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.
 * 
 * . Neither the name of the "OpenWFE" nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
 *
 * $Id: ConcurrentFlowExpression.java 2718 2006-06-02 05:24:52Z jmettraux $
 */

//
// ConcurrentFlowExpression.java
//
// [email protected]
//
// generated with 
// jtmpl 1.0.04 31.10.2002 John Mettraux ([email protected])
//

package openwfe.org.engine.expressions;

import openwfe.org.ApplicationContext;
import openwfe.org.engine.Definitions;
import openwfe.org.engine.workitem.InFlowWorkItem;
import openwfe.org.engine.expressions.sync.SyncUtils;
import openwfe.org.engine.expressions.sync.SyncExpression;
import openwfe.org.engine.expressions.sync.SynchableExpression;


/**
 * The basic abstract class for expressions that launches their children 
 * concurrently
 *
 * CVS Info :
 * 
$Author: jmettraux $
 * 
$Date: 2006-06-02 07:24:52 +0200 (Fri, 02 Jun 2006) $
 * 
$Id: ConcurrentFlowExpression.java 2718 2006-06-02 05:24:52Z jmettraux $ 
 *
 * @author [email protected]
 */
public abstract class ConcurrentFlowExpression

    extends CleanCompositeFlowExpression

    implements SynchableExpression
    
{

    /*
    private final static org.apache.log4j.Logger log = org.apache.log4j.Logger
        .getLogger(ConcurrentFlowExpression.class.getName());
    */

    //
    // FIELDS

    private SyncExpression syncExpression = null;

    //
    // CONSTRUCTORS

    //
    // BEAN METHODS

    //
    // METHODS

    //
    // METHODS from SynchableExpression

    public SyncExpression getSyncExpression () 
    { 
        return this.syncExpression; 
    }

    public void setSyncExpression (final SyncExpression se) 
    { 
        //log.debug("setSyncExpression() "+se.getClass());

        this.syncExpression = se;
    }

    //
    // METHODS from FlowExpression

    public void apply (final InFlowWorkItem wi) 
        throws ApplyException
    {

        if (getChildren() == null || getChildren().size() < 1)
        {
            //log.debug
            //    ("apply() "+
            //     "No children to throw, replying to parent expression");

            applyToParent(wi);

            return;
        }

        //
        // determine sync expression

        //log.debug("apply() setting syncExpression");

        this.setSyncExpression
            (SyncUtils.determineSyncExpression(this, getChildren(), wi));

        //
        // run this concurrence stuff

        synchronized (this)
        {
            int i;

            for (i = 0; i < getChildren().size(); i++)
            {
                final FlowExpressionId child = 
                    (FlowExpressionId)getChildren().get(i);
                
                getSyncExpression().addChild(child);
            }

            try
            {
                this.getSyncExpression().ready(this);
            }
            catch (final ReplyException re)
            {
                throw new ApplyException
                    ("Failed to tag sync expression as 'ready'", re);
            }

            for (i = 0; i < getChildren().size(); i++)
            {
                final FlowExpressionId child = 
                    (FlowExpressionId)getChildren().get(i);

                getExpressionPool().apply(child, (InFlowWorkItem)wi.clone());
                    //
                    // NB : child will reply to sync expression
            }

            synchronized (this)
            {
                this.storeItself();
            }
        }
    }

}