001: package org.tigris.scarab.workflow;
002:
003: /* ================================================================
004: * Copyright (c) 2000-2002 CollabNet. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: import java.util.List;
050:
051: import org.apache.turbine.Turbine;
052: import org.tigris.scarab.tools.localization.L10NKeySet;
053: import org.tigris.scarab.util.ScarabException;
054:
055: /**
056: * This class retrieves the appropriate workflow tool. The DefaultWorkflow
057: * is a noop implementation of workflow that always returns true.
058: *
059: * @author <a href="mailto:elicia@tigris.org">Elicia David</a>
060: * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
061: * @author <a href="mailto:jon@collab.net">Jon Scott Stevens</a>
062: * @version $Id: WorkflowFactory.java 9115 2004-05-14 12:10:49Z thierrylach $
063: */
064: public class WorkflowFactory {
065: /** the default is false */
066: private static ThreadLocal forceUseDefault = new ThreadLocal();
067:
068: /**
069: * This is used when you want to force the workflow to
070: * use the default workflow and override whatever is configured.
071: * Set it to true to override and false to turn that off again.
072: * This is useful during xml import to turn off workflow validation
073: * in case the import process doesn't know anything about the
074: * workflow process.
075: */
076: public static void setForceUseDefault(boolean value) {
077: forceUseDefault.set(value ? Boolean.TRUE : Boolean.FALSE);
078: }
079:
080: /**
081: * This is used when you want to force the workflow to
082: * use the default workflow and override whatever is configured.
083: * Set it to true to override and false to turn that off again.
084: * This is useful during xml import to turn off workflow validation
085: * in case the import process doesn't know anything about the
086: * workflow process.
087: */
088: public static boolean getForceUseDefault() {
089: return Boolean.TRUE.equals(forceUseDefault.get());
090: }
091:
092: /**
093: * Creates a new instance of the configured {@link
094: * org.tigris.scarab.workflow.Workflow} implementation, defaulting
095: * to {@link org.tigris.scarab.workflow.DefaultWorkflow} if not
096: * specified.
097: *
098: * @return A <code>Workflow</code> instance.
099: * @exception ScarabException Trouble creating
100: * <code>Workflow</code>.
101: */
102: public static Workflow getInstance() throws ScarabException {
103: Workflow wf = null;
104: String className = null;
105: try {
106: if (getForceUseDefault()) {
107: wf = (Workflow) DefaultWorkflow.class.newInstance();
108: } else {
109: List classNames = Turbine.getConfiguration().getList(
110: "scarab.workflow.classname");
111: if (classNames.size() > 0) {
112: className = (String) classNames.get(0);
113: }
114:
115: Class wfClass = (className != null ? Class
116: .forName(className) : DefaultWorkflow.class);
117: wf = (Workflow) wfClass.newInstance();
118: }
119: } catch (InstantiationException ie) {
120: throw new ScarabException(
121: L10NKeySet.ExceptionInstantiation, className, ie);
122: } catch (IllegalAccessException iae) {
123: throw new ScarabException(
124: L10NKeySet.ExceptionIllegalAccess, className, iae);
125: } catch (ClassNotFoundException cnfe) {
126: throw new ScarabException(
127: L10NKeySet.ExceptionClassNotFound, className, cnfe);
128: }
129: return wf;
130: }
131: }
|