KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > discovery > tools > Service


1 /*
2  * ====================================================================
3  *
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if
22  * any, must include the following acknowlegement:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
29  * Foundation" must not be used to endorse or promote products derived
30  * from this software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache"
34  * nor may "Apache" appear in their names without prior written
35  * permission of the Apache 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 APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  *
56  */

57
58 package org.apache.commons.discovery.tools;
59
60 import java.util.Enumeration JavaDoc;
61 import java.util.Vector JavaDoc;
62
63 import org.apache.commons.discovery.ResourceClass;
64 import org.apache.commons.discovery.listeners.GatherResourceClassesListener;
65 import org.apache.commons.discovery.resource.ClassLoaders;
66 import org.apache.commons.discovery.resource.classes.DiscoverClasses;
67 import org.apache.commons.discovery.resource.names.DiscoverServiceNames;
68
69
70 /**
71  * [this was ServiceDiscovery12... the 1.1 versus 1.2 issue
72  * has been abstracted to org.apache.commons.discover.jdk.JDKHooks]
73  *
74  * <p>Implement the JDK1.3 'Service Provider' specification.
75  * ( http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html )
76  * </p>
77  *
78  * This class supports any VM, including JDK1.1, via
79  * org.apache.commons.discover.jdk.JDKHooks.
80  *
81  * The caller will first configure the discoverer by adding ( in the desired
82  * order ) all the places to look for the META-INF/services. Currently
83  * we support loaders.
84  *
85  * The findResources() method will check every loader.
86  *
87  * @author Richard A. Sitze
88  * @author Craig R. McClanahan
89  * @author Costin Manolache
90  * @author James Strachan
91  */

92 public class Service
93 {
94     /** Construct a new service discoverer
95      */

96     protected Service() {
97     }
98     
99     /**
100      * as described in
101      * sun/jdk1.3.1/docs/guide/jar/jar.html#Service Provider,
102      * Except this uses <code>Enumeration</code>
103      * instead of <code>Interator</code>.
104      *
105      * @return Enumeration of class instances (<code>Object</code>)
106      */

107     public static Enumeration JavaDoc providers(Class JavaDoc spiClass) {
108         return providers(new SPInterface(spiClass), null);
109     }
110     
111     /**
112      * This version lets you specify constructor arguments..
113      *
114      * @param spi SPI to look for and load.
115      * @param classLoaders loaders to use in search.
116      * If <code>null</code> then use ClassLoaders.getAppLoaders().
117      */

118     public static Enumeration JavaDoc providers(final SPInterface spi,
119                                         ClassLoaders loaders)
120     {
121         if (loaders == null) {
122             loaders = ClassLoaders.getAppLoaders(spi.getSPClass(),
123                                                  Service.class,
124                                                  true);
125         }
126         
127         
128         GatherResourceClassesListener listener = new GatherResourceClassesListener();
129
130         DiscoverClasses classDiscovery = new DiscoverClasses(loaders);
131         classDiscovery.setListener(listener);
132
133         DiscoverServiceNames discoverServices = new DiscoverServiceNames(loaders);
134         discoverServices.setListener(classDiscovery);
135         discoverServices.find(spi.getSPName());
136
137         final Vector JavaDoc results = listener.getResourceClasses();
138         
139         return new Enumeration JavaDoc() {
140             private Object JavaDoc obj = null;
141             private int idx = 0;
142             
143             public boolean hasMoreElements() {
144                 if (obj == null) {
145                     obj = getNextElement();
146                 }
147                 return obj != null;
148             }
149             
150             public Object JavaDoc nextElement() {
151                 Object JavaDoc o = obj;
152                 obj = null;
153                 return o;
154             }
155             
156             private Object JavaDoc getNextElement() {
157                 while (idx < results.size()) {
158                     try {
159                         return spi.newInstance(((ResourceClass)results.get(idx++)).loadClass());
160                     } catch (Exception JavaDoc e) {
161                         // ignore, retry
162
}
163                 }
164                 return null;
165             }
166         };
167     }
168 }
169
Popular Tags