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
|
/*******************************************************************************
* Copyright (c) 2005, 2006 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.core.internal.registry.osgi;
import org.eclipse.core.internal.registry.RegistryMessages;
import org.eclipse.core.internal.runtime.RuntimeLog;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.osgi.service.datalocation.Location;
import org.eclipse.osgi.service.debug.DebugOptions;
import org.osgi.framework.*;
import org.osgi.service.packageadmin.PackageAdmin;
import org.osgi.util.tracker.ServiceTracker;
/**
* The class contains a set of helper methods for the runtime content plugin.
* The closeServices() method should be called before the plugin is stopped.
*
* @since org.eclipse.equinox.registry 3.2
*/
public class OSGIUtils {
private ServiceTracker<?, ?> debugTracker = null;
private ServiceTracker<?, ?> bundleTracker = null;
private ServiceTracker<?, ?> configurationLocationTracker = null;
// OSGI system properties. Copied from EclipseStarter
public static final String PROP_CONFIG_AREA = "osgi.configuration.area"; //$NON-NLS-1$
public static final String PROP_INSTANCE_AREA = "osgi.instance.area"; //$NON-NLS-1$
private static final OSGIUtils singleton = new OSGIUtils();
public static OSGIUtils getDefault() {
return singleton;
}
/**
* Private constructor to block instance creation.
*/
private OSGIUtils() {
super();
initServices();
}
private void initServices() {
BundleContext context = Activator.getContext();
if (context == null) {
RuntimeLog.log(new Status(IStatus.ERROR, RegistryMessages.OWNER_NAME, 0, RegistryMessages.bundle_not_activated, null));
return;
}
debugTracker = new ServiceTracker<>(context, DebugOptions.class.getName(), null);
debugTracker.open();
bundleTracker = new ServiceTracker<>(context, PackageAdmin.class.getName(), null);
bundleTracker.open();
// locations
final String FILTER_PREFIX = "(&(objectClass=org.eclipse.osgi.service.datalocation.Location)(type="; //$NON-NLS-1$
Filter filter = null;
try {
filter = context.createFilter(FILTER_PREFIX + PROP_CONFIG_AREA + "))"); //$NON-NLS-1$
} catch (InvalidSyntaxException e) {
// ignore this. It should never happen as we have tested the above format.
}
configurationLocationTracker = new ServiceTracker<>(context, filter, null);
configurationLocationTracker.open();
}
void closeServices() {
if (debugTracker != null) {
debugTracker.close();
debugTracker = null;
}
if (bundleTracker != null) {
bundleTracker.close();
bundleTracker = null;
}
if (configurationLocationTracker != null) {
configurationLocationTracker.close();
configurationLocationTracker = null;
}
}
public boolean getBooleanDebugOption(String option, boolean defaultValue) {
if (debugTracker == null) {
RuntimeLog.log(new Status(IStatus.ERROR, RegistryMessages.OWNER_NAME, 0, RegistryMessages.bundle_not_activated, null));
return defaultValue;
}
DebugOptions options = (DebugOptions) debugTracker.getService();
if (options != null) {
String value = options.getOption(option);
if (value != null)
return value.equalsIgnoreCase("true"); //$NON-NLS-1$
}
return defaultValue;
}
public PackageAdmin getPackageAdmin() {
if (bundleTracker == null) {
RuntimeLog.log(new Status(IStatus.ERROR, RegistryMessages.OWNER_NAME, 0, RegistryMessages.bundle_not_activated, null));
return null;
}
return (PackageAdmin) bundleTracker.getService();
}
public Bundle getBundle(String bundleName) {
PackageAdmin packageAdmin = getPackageAdmin();
if (packageAdmin == null)
return null;
Bundle[] bundles = packageAdmin.getBundles(bundleName, null);
if (bundles == null)
return null;
//Return the first bundle that is not installed or uninstalled
for (int i = 0; i < bundles.length; i++) {
if ((bundles[i].getState() & (Bundle.INSTALLED | Bundle.UNINSTALLED)) == 0) {
return bundles[i];
}
}
return null;
}
public Bundle[] getFragments(Bundle bundle) {
PackageAdmin packageAdmin = getPackageAdmin();
if (packageAdmin == null)
return null;
return packageAdmin.getFragments(bundle);
}
public boolean isFragment(Bundle bundle) {
PackageAdmin packageAdmin = getPackageAdmin();
if (packageAdmin == null)
return false;
return (packageAdmin.getBundleType(bundle) & PackageAdmin.BUNDLE_TYPE_FRAGMENT) > 0;
}
public Bundle[] getHosts(Bundle bundle) {
PackageAdmin packageAdmin = getPackageAdmin();
if (packageAdmin == null)
return null;
return packageAdmin.getHosts(bundle);
}
public Location getConfigurationLocation() {
if (configurationLocationTracker == null)
return null;
return (Location) configurationLocationTracker.getService();
}
}
|
