summaryrefslogtreecommitdiffstats
path: root/tags/java/sca/1.5.1/modules/osgi-runtime/src/main/java/org/apache/tuscany/sca/osgi/runtime/OSGiRuntime.java
blob: 79b1c0a5f4005fd5b6e87eb76c2eb4acc3f43d72 (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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.sca.osgi.runtime;

import java.io.InputStream;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleException;
import org.osgi.service.packageadmin.PackageAdmin;

/**
 * Base OSGiRuntime implementation.
 * 
 * @version $Rev$ $Date$
 */
public abstract class OSGiRuntime {
    private static final Logger logger = Logger.getLogger(OSGiRuntime.class.getName());

    public abstract BundleContext getBundleContext();

    public abstract boolean supportsBundleFragments();
    
    protected abstract BundleContext startRuntime(boolean tuscanyRunningInOSGiContainer) throws Exception;
       
    private static OSGiRuntime instance;
    
    private BundleContext bundleContext;
    
    private PackageAdmin packageAdmin;
    
    private boolean tuscanyRunningInOSGiContainer;
    
    private ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
    
    /**
     * System property org.apache.tuscany.implementation.osgi.runtime.OSGiRuntime can be set to the
     * name of the OSGiRuntime class (eg. EquinoxRuntime). If set, start this runtime and return the
     * system bundlecontext. If not set, start Equinox/Felix/Knopflerfish (in that order) from the
     * classpath.
     * 
     * @throws BundleException
     */
    public static synchronized OSGiRuntime findRuntime() throws Exception {

        if (instance != null) {
        	
            return instance;
        }
        String runtimeClassName = System.getProperty(OSGiRuntime.class.getName());
        

        if (runtimeClassName != null) {
            try {
                Class<?> runtimeClass = OSGiRuntime.class.getClassLoader().loadClass(runtimeClassName);
                Method method = runtimeClass.getMethod("getInstance");
                instance = (OSGiRuntime) method.invoke(null);
                return instance;
                
            } catch (Exception e) {
                throw new BundleException("Could not start OSGi runtime " + runtimeClassName, e);
            }
        }

        try {
            
            instance = EquinoxRuntime.getInstance();
            return instance;
            
        } catch (ClassNotFoundException e) {
            // Ignore
        } catch (Throwable e) {
            logger.log(Level.SEVERE, e.getMessage(), e);
        }

        try {

            instance = FelixRuntime.getInstance();
            return instance;
 
        } catch (ClassNotFoundException e) {
            // Ignore
        } catch (Throwable e) {
            logger.log(Level.SEVERE, e.getMessage(), e);
        }

        try {
       
            instance = KnopflerfishRuntime.getInstance();
            return instance;
            
        } catch (ClassNotFoundException e) {
            // Ignore
        } catch (Throwable e) {
            logger.log(Level.SEVERE, e.getMessage(), e);
        }

        throw new BundleException("Could not start OSGi runtime from the classpath");
    }


    public static synchronized OSGiRuntime getRuntime() throws Exception {
    	return getRuntime(false);
    }

    public static synchronized OSGiRuntime getRuntime(boolean tuscanyRunningInOSGiContainer) throws Exception {
    	
    	instance = findRuntime();
    	
        if (instance != null) {
        	
        	if (instance.bundleContext == null) {
                instance.tuscanyRunningInOSGiContainer = tuscanyRunningInOSGiContainer;
        		instance.startRuntime(tuscanyRunningInOSGiContainer);
        		instance.initialize();
        	}
            return instance;
        }
        return instance;
    }


    public void shutdown() throws Exception {
    	
    	bundleContext = null;
    	packageAdmin = null;
    }

    protected void setBundleContext(BundleContext bundleContext) {
        instance.tuscanyRunningInOSGiContainer = true;
        this.bundleContext = bundleContext;
    }
    
    
    
    public ClassLoader getContextClassLoader() {
        return contextClassLoader;
    }

    protected void setContextClassLoader(ClassLoader contextClassLoader) {
        this.contextClassLoader = contextClassLoader;
    }

    protected void initialize() {
    	
        bundleContext = getBundleContext();

        if (bundleContext != null) {

            org.osgi.framework.ServiceReference packageAdminReference =
                bundleContext.getServiceReference("org.osgi.service.packageadmin.PackageAdmin");
            if (packageAdminReference != null) {

                packageAdmin = (PackageAdmin)bundleContext.getService(packageAdminReference);
            }
        }

    }

    public Bundle findBundle(String bundleSymbolicName, String bundleVersion) {

        if (bundleContext != null) {
            Bundle[] installedBundles = bundleContext.getBundles();
            for (Bundle bundle : installedBundles) {
                if (bundleSymbolicName.equals(bundle.getSymbolicName()) && (bundleVersion == null || bundleVersion
                    .equals(bundle.getHeaders().get("Bundle-Version"))))
                    return bundle;
            }

        }
        return null;
    }
    
    public static synchronized Bundle findInstalledBundle(String bundleLocation) {
    	if (instance != null) {
            if (bundleLocation.startsWith("bundle:")||bundleLocation.startsWith("bundleresource:")) {
                try {
                    return findInstalledBundle(new URL(bundleLocation));
                } catch (MalformedURLException e) {
                    // ignore
                }
            } else {
                return instance.findBundle(bundleLocation);
            }
    	}
    	return null;
    }
    
    public static synchronized Bundle findInstalledBundle(URL bundleURL) {
        if (instance != null) {
            if (instance.bundleContext != null) {
                Bundle[] installedBundles = instance.bundleContext.getBundles();
                for (Bundle bundle : installedBundles) {
                    try {
                        if (bundle.getEntry("/").getHost().equals(bundleURL.getHost()))
                        return bundle;
                    } catch (Exception e) {
                        // Ignore exception
                    }
                }
            }
            return null;
        }
        return null;
    }

    public Bundle findBundle(String bundleLocation) {

        if (bundleContext != null) {        	
            Bundle[] installedBundles = bundleContext.getBundles();
            for (Bundle bundle : installedBundles) {
                if (bundle.getLocation().equals(bundleLocation))
                    return bundle;
            }

        }
        return null;
    }

    public Bundle installBundle(String bundleLocation, InputStream inputStream) {

        try {
            if (bundleContext != null) {
                Bundle bundle = findBundle(bundleLocation);
                if (bundle != null)
                    return bundle;
                if (inputStream == null)
                    bundle = bundleContext.installBundle(bundleLocation);
                else
                    bundle = bundleContext.installBundle(bundleLocation, inputStream);

                if (bundle != null && packageAdmin != null)
                    packageAdmin.refreshPackages(null);

                return bundle;
            }
        } catch (BundleException e) {
        }
        return null;
    }

    /**
     * Stops the OSGi instance.
     *
     * @throws Exception Failed to shutdown the OSGi instance.
     */
    public static synchronized void stop() throws Exception {
        if (instance != null && !instance.tuscanyRunningInOSGiContainer) {
            instance.shutdown();
            instance = null;
        }
    }

}