xmlwsparammapper.java

一个工作流设计及定义的系统,可以直接与数据库结合进行系统工作流程的定义及应用.

/*
 * Copyright (c) 2005, 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: XmlWsParamMapper.java,v 1.3 2005/05/17 16:41:05 jmettraux Exp $
 */

//
// XmlWsParamMapper.java
//
// [e-mail]
//
// generated with 
// jtmpl 1.1.01 2004/05/19 ([e-mail])
//

package openwfe.org.ws.impl.invoker;


import org.apache.axis.client.Call;

import openwfe.org.Utils;
import openwfe.org.MapUtils;
import openwfe.org.AbstractService;
import openwfe.org.ServiceException;
import openwfe.org.ApplicationContext;
import openwfe.org.xconf.XconfBuilder;
import openwfe.org.xconf.XconfElementBuilder;
import openwfe.org.engine.workitem.Attribute;
import openwfe.org.engine.workitem.AttributeUtils;
import openwfe.org.engine.workitem.InFlowWorkItem;
import openwfe.org.ws.WsException;
import openwfe.org.ws.WsParamMapper;


/**
 * The classical XML config implementation of WsParamMapper
 *
 * <p><font size=2>CVS Info :
 * <br>$Author: jmettraux $
 * <br>$Id: XmlWsParamMapper.java,v 1.3 2005/05/17 16:41:05 jmettraux Exp $ </font>
 *
 * @author [e-mail]
 */
public class XmlWsParamMapper

    extends AbstractService

    implements WsParamMapper, XconfElementBuilder

{

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

    //
    // CONSTANTS & co

    //
    // FIELDS

    private XconfBuilder builder = null;
    private java.util.List mapList = null;

    //
    // CONSTRUCTORS

    public void init 
        (final String serviceName, 
         final ApplicationContext context, 
         final java.util.Map serviceParams)
    throws 
        ServiceException
    {
        super.init(serviceName, context, serviceParams);

        String url = MapUtils.getAsString
            (serviceParams,
             "wsParamMapFile",
             "etc/engine/ws-param-map.xml");

        url = Utils.expandUrl(context.getApplicationDirectory(), url);

        this.builder = new XconfBuilder(url, this);
        this.builder.buildConfig();
    }

    //
    // METHODS from WsParamMapper

    /**
     * The WsParamMapper implementation looks at the participant name found
     * in the workitem and then set call parameters accordingly.
     */
    public Object[] prepareParams (final Call call, final InFlowWorkItem wi)
        throws WsException
    {
        try
        {
            this.builder.refreshConfig();
        }
        catch (final ServiceException se)
        {
            if (this.mapList.size() < 1)
            {
                throw new WsException
                    ("Failed to load/refresh config at "+
                     this.builder.getSourceUrl(), 
                     se);
            }

            log.warn
                ("prepareParams() Failed to load/refresh config at "+
                 this.builder.getSourceUrl(), 
                 se);
        }

        final Map map = determineMap(wi);

        return map.mapParameters(call, wi);
    }

    /**
     * Given a participant name (as found in the given workitem) returns
     * into which field the return value of the webservice invocation should
     * be stored.
     */
    public String determineToField (InFlowWorkItem wi)
        throws WsException
    {
        final Map map = determineMap(wi);

        return map.toField;
    }

    //
    // METHODS from Service

    //
    // METHODS from XconfElementBuilder

    public void clearConfig ()
    {
        this.mapList = new java.util.ArrayList(40);
    }

    /**
     * Parses a 'map' element.
     */
    public void parseElement 
        (final XconfBuilder xconfBuilder, final org.jdom.Element elt)
    throws 
        ServiceException
    {
        this.mapList.add(new Map(elt));
    }

    //
    // METHODS

    private Map determineMap (final InFlowWorkItem wi)
        throws WsException
    {
        final java.util.Iterator it = this.mapList.iterator();
        while (it.hasNext())
        {
            final Map m = (Map)it.next();

            if (wi.getParticipantName().matches(m.participantName)) return m;
        }

        throw new WsException
            ("Couldn't find any param map for participant '"+
             wi.getParticipantName()+"'");
    }

    //
    // STATIC METHODS

    //
    // INNER CLASSES

    private static class Map
    {
        public String participantName = null;
        public java.util.List params = null;
        public String toField = null;

        public Map (final org.jdom.Element elt)
            throws ServiceException
        {
            //
            // participant name

            this.participantName = elt.getAttributeValue("participant-name");

            if (this.participantName == null)
            {
                throw new ServiceException
                    ("Attribute 'participant-name' is missing.");
            }

            //
            // ws-params

            final java.util.List children = elt.getChildren("ws-param");

            this.params = new java.util.ArrayList(children.size());

            final java.util.Iterator it = children.iterator();
            while (it.hasNext())
            {
                final org.jdom.Element e = (org.jdom.Element)it.next();
                this.params.add(new Param(e));
            }

            //
            // to-field

            final org.jdom.Element eReturn = elt.getChild("ws-return");

            this.toField = eReturn.getAttributeValue("to-field");
        }

        public Object[] mapParameters (final Call call, final InFlowWorkItem wi)
            throws WsException
        {
            final Object[] result = new Object[this.params.size()];

            int i = 0;
            final java.util.Iterator it = this.params.iterator();
            while (it.hasNext())
            {
                final Param param = (Param)it.next();

                result[i] = param.fetchParam(wi);

                i++;
            }

            return result;
        }

        private static class Param
        {
            //public String name = null;
            public String fromField = null;
            //public String paramType = null;

            public Param (final org.jdom.Element elt)
            {
                //this.name = elt.getAttributeValue("name");
                this.fromField = elt.getAttributeValue("from-field");
            }

            public Object fetchParam (final InFlowWorkItem wi)
            {
                final Attribute a = wi.getAttributes().get(this.fromField);

                if (a == null) return null;

                return AttributeUtils.owfe2java(a);
            }
        }
    }

}