KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > workflow > WorkflowFactory


1 package org.tigris.scarab.workflow;
2
3 /* ================================================================
4  * Copyright (c) 2000-2002 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */
48
49 import java.util.List JavaDoc;
50
51 import org.apache.turbine.Turbine;
52 import org.tigris.scarab.tools.localization.L10NKeySet;
53 import org.tigris.scarab.util.ScarabException;
54
55 /**
56  * This class retrieves the appropriate workflow tool. The DefaultWorkflow
57  * is a noop implementation of workflow that always returns true.
58  *
59  * @author <a HREF="mailto:elicia@tigris.org">Elicia David</a>
60  * @author <a HREF="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
61  * @author <a HREF="mailto:jon@collab.net">Jon Scott Stevens</a>
62  * @version $Id: WorkflowFactory.java 9115 2004-05-14 12:10:49Z thierrylach $
63  */
64 public class WorkflowFactory
65 {
66     /** the default is false */
67     private static ThreadLocal JavaDoc forceUseDefault = new ThreadLocal JavaDoc();
68
69     /**
70      * This is used when you want to force the workflow to
71      * use the default workflow and override whatever is configured.
72      * Set it to true to override and false to turn that off again.
73      * This is useful during xml import to turn off workflow validation
74      * in case the import process doesn't know anything about the
75      * workflow process.
76      */
77     public static void setForceUseDefault(boolean value)
78     {
79         forceUseDefault.set(value ? Boolean.TRUE : Boolean.FALSE);
80     }
81
82     /**
83      * This is used when you want to force the workflow to
84      * use the default workflow and override whatever is configured.
85      * Set it to true to override and false to turn that off again.
86      * This is useful during xml import to turn off workflow validation
87      * in case the import process doesn't know anything about the
88      * workflow process.
89      */
90     public static boolean getForceUseDefault()
91     {
92         return Boolean.TRUE.equals(forceUseDefault.get());
93     }
94
95     /**
96      * Creates a new instance of the configured {@link
97      * org.tigris.scarab.workflow.Workflow} implementation, defaulting
98      * to {@link org.tigris.scarab.workflow.DefaultWorkflow} if not
99      * specified.
100      *
101      * @return A <code>Workflow</code> instance.
102      * @exception ScarabException Trouble creating
103      * <code>Workflow</code>.
104      */
105     public static Workflow getInstance() throws ScarabException
106     {
107         Workflow wf = null;
108         String JavaDoc className = null;
109         try
110         {
111             if (getForceUseDefault())
112             {
113                 wf = (Workflow) DefaultWorkflow.class.newInstance();
114             }
115             else
116             {
117                 List JavaDoc classNames = Turbine.getConfiguration()
118                     .getList("scarab.workflow.classname");
119                 if (classNames.size() > 0)
120                 {
121                     className = (String JavaDoc) classNames.get(0);
122                 }
123     
124                 Class JavaDoc wfClass = (className != null ? Class.forName(className) :
125                                  DefaultWorkflow.class);
126                 wf = (Workflow) wfClass.newInstance();
127             }
128         }
129         catch (InstantiationException JavaDoc ie)
130         {
131             throw new ScarabException(L10NKeySet.ExceptionInstantiation, className, ie);
132         }
133         catch (IllegalAccessException JavaDoc iae)
134         {
135             throw new ScarabException(L10NKeySet.ExceptionIllegalAccess, className, iae);
136         }
137         catch (ClassNotFoundException JavaDoc cnfe)
138         {
139             throw new ScarabException(L10NKeySet.ExceptionClassNotFound, className, cnfe);
140         }
141         return wf;
142     }
143 }
144
Popular Tags