Skip to main content
summaryrefslogtreecommitdiffstats
blob: bceb250dcd9c3f35a27f27dd767c3b8ddeb8595c (plain) (blame)
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
/*******************************************************************************
 * Copyright (c) 2010-2011 Composent, Inc. and others. All rights reserved. This
 * program and the accompanying materials are made available under the terms of
 * the Eclipse Public License v1.0 which accompanies this distribution, and is
 * available at http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Composent, Inc. - initial API and implementation
 ******************************************************************************/
package org.eclipse.ecf.osgi.services.remoteserviceadmin;

import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.ecf.internal.osgi.services.remoteserviceadmin.Activator;
import org.eclipse.ecf.internal.osgi.services.remoteserviceadmin.DebugOptions;
import org.eclipse.ecf.internal.osgi.services.remoteserviceadmin.LogUtility;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.util.tracker.BundleTrackerCustomizer;
import org.osgi.util.tracker.ServiceTracker;

public class EndpointDescriptionBundleTrackerCustomizer implements
		BundleTrackerCustomizer {

	private static final String REMOTESERVICE_MANIFESTHEADER = "Remote-Service";
	private static final String XML_FILE_PATTERN = "*.xml";

	private Map<Long, Collection<org.osgi.service.remoteserviceadmin.EndpointDescription>> bundleDescriptionMap = Collections
			.synchronizedMap(new HashMap<Long, Collection<org.osgi.service.remoteserviceadmin.EndpointDescription>>());

	private BundleContext bundleContext;
	private LocatorServiceListener endpointDescriptionHandler;

	private Object endpointDescriptionReaderTrackerLock = new Object();
	private ServiceTracker endpointDescriptionReaderTracker;

	public EndpointDescriptionBundleTrackerCustomizer(
			BundleContext bundleContext,
			LocatorServiceListener endpointDescriptionHandler) {
		this.bundleContext = bundleContext;
		this.endpointDescriptionHandler = endpointDescriptionHandler;
	}

	private IEndpointDescriptionReader getEndpointDescriptionReader() {
		synchronized (endpointDescriptionReaderTrackerLock) {
			if (endpointDescriptionReaderTracker == null) {
				endpointDescriptionReaderTracker = new ServiceTracker(
						bundleContext,
						IEndpointDescriptionReader.class.getName(), null);
				endpointDescriptionReaderTracker.open();
			}
		}
		return (IEndpointDescriptionReader) endpointDescriptionReaderTracker
				.getService();
	}

	public Object addingBundle(Bundle bundle, BundleEvent event) {
		handleAddingBundle(bundle);
		return bundle;
	}

	private void handleAddingBundle(Bundle bundle) {
		if (bundleContext == null)
			return;
		String remoteServicesHeaderValue = (String) bundle.getHeaders().get(
				REMOTESERVICE_MANIFESTHEADER);
		if (remoteServicesHeaderValue != null) {
			// First parse into comma-separated values
			String[] paths = remoteServicesHeaderValue.split(",");
			if (paths != null)
				for (int i = 0; i < paths.length; i++)
					handleEndpointDescriptionPath(bundle, paths[i]);
		}
	}

	private void handleEndpointDescriptionPath(Bundle bundle,
			String remoteServicesHeaderValue) {
		// if it's empty, ignore
		if ("".equals(remoteServicesHeaderValue))
			return;
		Enumeration<URL> e = null;
		// if it endswith a '/', then scan for *.xml files
		if (remoteServicesHeaderValue.endsWith("/")) {
			e = bundle.findEntries(remoteServicesHeaderValue, XML_FILE_PATTERN,
					false);
		} else {
			// Break into path and filename/pattern
			int lastSlashIndex = remoteServicesHeaderValue.lastIndexOf('/');
			if (lastSlashIndex == -1) {
				// no slash...might be a file name or pattern, assumed to be
				// at root of bundle
				e = bundle.findEntries("/", remoteServicesHeaderValue, false);
			} else {
				String path = remoteServicesHeaderValue.substring(0,
						lastSlashIndex);
				if ("".equals(path)) {
					// path is empty so assume it's root
					path = "/";
				}
				String filePattern = remoteServicesHeaderValue
						.substring(lastSlashIndex + 1);
				e = bundle.findEntries(path, filePattern, false);
			}
		}
		// Now process any found
		Collection<org.osgi.service.remoteserviceadmin.EndpointDescription> endpointDescriptions = new ArrayList<org.osgi.service.remoteserviceadmin.EndpointDescription>();
		if (e != null) {
			while (e.hasMoreElements()) {
				org.osgi.service.remoteserviceadmin.EndpointDescription[] eps = handleEndpointDescriptionFile(
						bundle, e.nextElement());
				if (eps != null)
					for (int i = 0; i < eps.length; i++)
						endpointDescriptions.add(eps[i]);
			}
		}
		// finally, handle them
		if (endpointDescriptions.size() > 0) {
			bundleDescriptionMap.put(new Long(bundle.getBundleId()),
					endpointDescriptions);
			for (org.osgi.service.remoteserviceadmin.EndpointDescription ed : endpointDescriptions)
				endpointDescriptionHandler.handleEndpointDescription(ed, true);
		}
	}

	private org.osgi.service.remoteserviceadmin.EndpointDescription[] handleEndpointDescriptionFile(
			Bundle bundle, URL fileURL) {
		InputStream ins = null;
		try {
			IEndpointDescriptionReader endpointDescriptionReader = getEndpointDescriptionReader();
			if (endpointDescriptionReader == null)
				throw new NullPointerException(
						"No endpointDescriptionReader available for handleEndpointDescriptionFile fileURL="
								+ fileURL);
			ins = fileURL.openStream();
			return endpointDescriptionReader.readEndpointDescriptions(ins);
		} catch (Exception e) {
			logError("handleEndpointDescriptionFile",
					"Exception creating endpoint descriptions from fileURL="
							+ fileURL, e);
			return null;
		} finally {
			if (ins != null)
				try {
					ins.close();
				} catch (IOException e) {
					logError("handleEndpointDescriptionFile",
							"Exception closing endpointDescription input fileURL="
									+ fileURL, e);
				}
		}
	}

	private void logError(String method, String message, Throwable t) {
		LogUtility.logError(method, DebugOptions.DISCOVERY, this.getClass(),
				new Status(IStatus.ERROR, Activator.PLUGIN_ID, IStatus.ERROR,
						message, t));
	}

	public void modifiedBundle(Bundle bundle, BundleEvent event, Object object) {
	}

	public void removedBundle(Bundle bundle, BundleEvent event, Object object) {
		handleRemovedBundle(bundle);
	}

	private void handleRemovedBundle(Bundle bundle) {
		Collection<org.osgi.service.remoteserviceadmin.EndpointDescription> endpointDescriptions = bundleDescriptionMap
				.remove(new Long(bundle.getBundleId()));
		if (endpointDescriptions != null)
			for (org.osgi.service.remoteserviceadmin.EndpointDescription ed : endpointDescriptions)
				endpointDescriptionHandler.handleEndpointDescription(ed, false);
	}

	public void close() {
		synchronized (endpointDescriptionReaderTrackerLock) {
			if (endpointDescriptionReaderTracker != null) {
				endpointDescriptionReaderTracker.close();
				endpointDescriptionReaderTracker = null;
			}
		}
		bundleDescriptionMap.clear();
		bundleContext = null;
	}
}

Back to the top