KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > trove > util > plugin > PluginFactory


1 /* ====================================================================
2  * Trove - Copyright (c) 1999-2001 Walt Disney Internet Group
3  * ====================================================================
4  * The Tea Software License, Version 1.1
5  *
6  * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Walt Disney Internet Group (http://opensource.go.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact opensource@dig.com.
31  *
32  * 5. Products derived from this software may not be called "Tea",
33  * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
34  * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
35  * written permission of the Walt Disney Internet Group.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
41  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
42  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
43  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
44  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
45  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * For more information about Tea, please see http://opensource.go.com/.
51  */

52 package com.go.trove.util.plugin;
53
54 import com.go.trove.util.PropertyMap;
55
56 import java.util.Iterator JavaDoc;
57 import java.util.Set JavaDoc;
58
59 /**
60  * This class is responsible for creating plugins based from a
61  * configuration block.
62  *
63  * @author Scott Jappinen
64  * @version <!--$$Revision:--> 1 <!-- $-->-<!--$$JustDate:--> 01/03/23 <!-- $-->
65  */

66 public class PluginFactory {
67
68     private static final String JavaDoc cClassKey = "class";
69     private static final String JavaDoc cInitKey = "init";
70     private static final String JavaDoc cPluginsKey = "plugins";
71     
72     public static final Plugin createPlugin(String JavaDoc name, PluginFactoryConfig config)
73         throws PluginFactoryException
74     {
75         Plugin result;
76         String JavaDoc className = config.getProperties().getString(cClassKey);
77         PropertyMap props = config.getProperties().subMap(cInitKey);
78         try {
79             Class JavaDoc clazz = Class.forName(className);
80             result = (Plugin) clazz.newInstance();
81             PluginConfig pluginConfig = new PluginConfigSupport
82                 (props, config.getLog(), config.getPluginContext(), name);
83             result.init(pluginConfig);
84         } catch (PluginException e) {
85             throw new PluginFactoryException(e);
86         } catch (ClassNotFoundException JavaDoc e) {
87             throw new PluginFactoryException(e);
88         } catch (InstantiationException JavaDoc e) {
89             throw new PluginFactoryException(e);
90         } catch (IllegalAccessException JavaDoc e) {
91             throw new PluginFactoryException(e);
92         }
93         return result;
94     }
95     
96     public static final Plugin[] createPlugins(PluginFactoryConfig config)
97         throws PluginFactoryException
98     {
99         Plugin[] result;
100         PropertyMap properties = config.getProperties().subMap(cPluginsKey);
101         Set JavaDoc keySet = properties.subMapKeySet();
102         result = new Plugin[keySet.size()];
103         Iterator JavaDoc iterator = keySet.iterator();
104         for (int i=0; iterator.hasNext(); i++) {
105             String JavaDoc name = (String JavaDoc) iterator.next();
106             PropertyMap initProps = properties.subMap(name);
107             PluginFactoryConfig conf = new PluginFactoryConfigSupport
108                 (initProps, config.getLog(), config.getPluginContext());
109             result[i] = createPlugin(name, conf);
110         }
111         return result;
112     }
113
114 }
115
116
Popular Tags