summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-stable-20060304/sca/common/src/main/java/org/apache/tuscany/common/discovery/util/ServiceProviderRegistry.java
blob: 65ede08a32aa7d82085e2d55bbab05595a25bf04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/**
 *
 *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.apache.tuscany.common.discovery.util;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.WeakHashMap;

import org.apache.tuscany.common.io.util.FixedURLInputStream;

//FIXME Port to 1.5 collections

/**
 * A Registry for service  providers defined using the
 * <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html#Service%20Provider">JAR service provider mechanism</a>.
 *
 */
public class ServiceProviderRegistry {

    private Map registry = Collections.synchronizedMap(new WeakHashMap());

    private final static ServiceProviderRegistry instance = new ServiceProviderRegistry();

    /**
     * Constructor.
     */
    public ServiceProviderRegistry() {
        super();
    }

    /**
     * @return Returns the instance.
     */
    public static ServiceProviderRegistry getInstance() {
        return instance;
    }

    /**
     * Get the available providers of a given type.
     *
     * @param clazz
     * @return
     */
    public List getServiceProviders(final Class clazz) {
        List providers = (List) registry.get(clazz);
        if (providers != null)
            return providers;

        providers = (List) AccessController.doPrivileged(new PrivilegedAction() {
            public Object run() {
                return loadServiceProviders(clazz);
            }
        });

        registry.put(clazz, providers);
        return providers;
    }

    /**
     * Get an provider of a given type.
     *
     * @param clazz
     * @return
     */
    public Object getServiceProvider(Class clazz) {
        List providers = getServiceProviders(clazz);
        if (providers.isEmpty())
            return null;
        else {
            return providers.get(0);
        }
    }

    /**
     * Registers an provider programatically
     *
     * @param clazz
     * @param provider
     */
    public void registerServiceProvider(Class clazz, Object provider) {
        getServiceProviders(clazz).add(provider);
    }

    /**
     * Load providers of the given type
     *
     * @param clazz
     * @return
     */
    private List loadServiceProviders(Class clazz) {
        List classNames = new ArrayList();

        // First look for a system property named <SPI className>
        String className = System.getProperty(clazz.getName());
        if (className != null)
            classNames.add(className);

        //	 Find all the class names mentioned in all the META-INF/services/<SPI className>
        ClassLoader loader = Thread.currentThread().getContextClassLoader();
        try {
            Enumeration files = loader.getResources("META-INF/services/" + clazz.getName());
            while (files.hasMoreElements()) {
                URL url = (URL) files.nextElement();
                readClassNames(url, classNames);
            }
        } catch (IOException e) {
        }

        // Instantiate an provider for each of the named classes
        List providers = new ArrayList();
        Iterator i = classNames.iterator();
        while (i.hasNext()) {
            String name = (String) i.next();
            try {
                Class providerClass = Class.forName(name, true, loader);
                providers.add(providerClass.newInstance());
            } catch (Exception e) {
                // Ignore ClassNotFoundException
            }
        }
        return providers;
    }

    /**
     * Read class names from the given URL.
     * @param url
     * @param classNames
     * @throws IOException
     */
    private void readClassNames(URL url, List classNames) throws IOException {
        InputStream is = new FixedURLInputStream(url);
        try {
            BufferedReader in = new BufferedReader(new InputStreamReader(is, "UTF-8"));
            String inputLine = null;
            while ((inputLine = in.readLine()) != null) {
                int i = inputLine.indexOf('#');
                if (i >= 0) {
                    inputLine = inputLine.substring(0, i);
                }
                inputLine = inputLine.trim();
                if (inputLine.length() > 0) {
                    if (!classNames.contains(inputLine)) {
                        classNames.add(inputLine);
                    }
                }
            }
        } finally {
            is.close();
		}
	}

}