definitions.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: Definitions.java,v 1.71 2005/07/28 16:33:08 jmettraux Exp $
 */

//
// Definitions.java
//
// [e-mail]
//
// generated with 
// jtmpl 1.0.04 20.11.2001 John Mettraux ([e-mail])
//

package openwfe.org.engine;

import openwfe.org.ApplicationContext;
import openwfe.org.engine.expool.ExpressionPool;
import openwfe.org.engine.expool.ExpressionStore;
import openwfe.org.engine.launch.Launcher;
import openwfe.org.engine.history.History;
import openwfe.org.engine.workitem.WorkItemCoder;
import openwfe.org.engine.workitem.WorkItemCoderLoader;
import openwfe.org.engine.functions.FunctionMap;
import openwfe.org.engine.participants.ParticipantMap;
import openwfe.org.engine.expressions.map.ExpressionMap;


/**
 * Constants for the whole workflow engine
 *
 * <p><font size=2>CVS Info :
 * <br>$Author: jmettraux $
 * <br>$Date: 2005/07/28 16:33:08 $
 * <br>$Id: Definitions.java,v 1.71 2005/07/28 16:33:08 jmettraux Exp $ </font>
 *
 * @author [e-mail]
 */
public abstract class Definitions
{

    public final static String OPENWFE_VERSION = "1.5.4";


    public static final String DEFAULT_EXPRESSION_TIMEOUT
        = "defaultExpressionTimeout";

    //
    // general engine parameters

    public static final String ENGINE_ID
        = "engineId";

    //
    // parameters

    public static final String WORKFLOW_DEFINITION_URL
        = "wfdUrl";

    public static final String WAIT_FOR_RESULT
        = "waitForResult";

    //
    // some variables

    public static final String V_TIMED_OUT
        = "__timed_out__";

    /**
     * A generic attribute name, it's used by the launchers when
     * parsing attributes of an expression.
     */
    public final static String A_VALUE
        = "__value__";

    //
    // service names

    /**
     * An OpenWFE component expects an ExpressionMap to be found under
     * 'expressionMap' in its ApplicationContext.
     */
    public final static String S_EXPRESSION_MAP 
        = "expressionMap";

    /**
     * The expression pool service should be located under 
     * the name 'expressionPool'.
     */
    public final static String S_EXPRESSION_POOL
        = "expressionPool";

    /**
     * The engine's expression store service should be located under
     * 'expressionStore'.
     */
    public final static String S_EXPRESSION_STORE
        = "expressionStore";

    /**
     * An OpenWFE component expects a ParticipantMap to be found under
     * 'participantMap' in its ApplicationContext.
     */
    public final static String S_PARTICIPANT_MAP 
        = "participantMap";

    /**
     * An OpenWFE component expects a WorkflowInstanceBuilder to be found under
     * 'workflowInstanceBuilder' in its ApplicationContext.
     */
    public final static String S_WORKFLOW_INSTANCE_BUILDER
        = "workflowInstanceBuilder";

    /**
     * A 'launcher' is a service that turns a workflow definition into a 
     * workflow instance.
     */
    public final static String S_LAUNCHER
        = "launcher";

    /**
     * The set of services that constitute an OpenWFE engine awaits the
     * function map service to be named 'functionMap'.
     */
    public final static String S_FUNCTION_MAP
        = "functionMap";

    //
    // engine services' get methods

    public static WorkItemCoderLoader getWorkItemCoderLoader 
        (final ApplicationContext context)
    {
        return (WorkItemCoderLoader)ApplicationContext.lookup
            (context,
             "workItemCoderLoader",
             "EngineContext.workItemCoderLoader");
    }

    public static WorkItemCoder getXmlCoder
        (final ApplicationContext context)
    {
        return getWorkItemCoderLoader(context).getXmlCoder();
    }

    public static ExpressionPool getExpressionPool 
        (final ApplicationContext context)
    {
        return (ExpressionPool)ApplicationContext.lookup
            (context,
             S_EXPRESSION_POOL,
             "EngineContext.expressionPool");
    }

    public static History getHistory 
        (final ApplicationContext context)
    {
        return (History)ApplicationContext.lookup
            (context,
             "history",
             "EngineContext.history");
    }

    public static ExpressionStore getExpressionStore 
        (final ApplicationContext context)
    {
        return (ExpressionStore)ApplicationContext.lookup
            (context,
             S_EXPRESSION_STORE,
             "EngineContext.expressionStore");
    }

    public static Launcher getLauncher
        (final ApplicationContext context)
    {
        return (Launcher)context.lookup(S_LAUNCHER);
    }

    public static ParticipantMap getParticipantMap 
        (final ApplicationContext context)
    {
        return (ParticipantMap)ApplicationContext.lookup
            (context,
             S_PARTICIPANT_MAP,
             "EngineContext.participantMap");
    }

    public static ExpressionMap getExpressionMap 
        (final ApplicationContext context)
    {
        return (ExpressionMap)ApplicationContext.lookup
            (context,
             S_EXPRESSION_MAP,
             "EngineContext.expressionMap");
    }

    public static FunctionMap getFunctionMap
        (final ApplicationContext context)
    {
        return (FunctionMap)context.lookup(S_FUNCTION_MAP);
    }

}