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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
|
/*******************************************************************************
* 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.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.StringTokenizer;
import java.util.TreeMap;
import org.eclipse.ecf.core.identity.ID;
import org.eclipse.ecf.discovery.IServiceProperties;
import org.eclipse.ecf.internal.osgi.services.remoteserviceadmin.DebugOptions;
import org.eclipse.ecf.internal.osgi.services.remoteserviceadmin.LogUtility;
import org.eclipse.ecf.internal.osgi.services.remoteserviceadmin.PropertiesUtil;
import org.osgi.framework.Version;
public abstract class AbstractMetadataFactory {
protected static final String LIST_SEPARATOR = " ";
protected void encodeString(IServiceProperties props, String name,
String value) {
props.setPropertyString(name, value);
}
protected String decodeString(IServiceProperties props, String name) {
return props.getPropertyString(name);
}
protected void encodeLong(IServiceProperties result, String name, Long value) {
result.setPropertyString(name, value.toString());
}
protected Long decodeLong(IServiceProperties props, String name) {
String longAsString = props.getPropertyString(name);
if (longAsString == null)
return new Long(0);
return new Long(longAsString);
}
protected void encodeList(IServiceProperties props, String name,
List<String> list) {
if (list == null)
return;
if (list.size() == 1) {
props.setPropertyString(name, list.get(0));
} else {
final StringBuffer result = new StringBuffer();
for (Iterator<String> i = list.iterator(); i.hasNext();) {
result.append(i.next());
if (i.hasNext())
result.append(LIST_SEPARATOR);
}
// Now add to props
props.setPropertyString(name, result.toString());
}
}
protected List<String> decodeList(IServiceProperties props, String name) {
String value = props.getPropertyString(name);
if (value == null)
return Collections.EMPTY_LIST;
List<String> result = new ArrayList<String>();
final StringTokenizer t = new StringTokenizer(value, LIST_SEPARATOR);
while (t.hasMoreTokens())
result.add(t.nextToken());
return result;
}
protected void decodeOSGiProperties(IServiceProperties props,
Map osgiProperties) {
// org.osgi.framework.Constants.OBJECTCLASS
List<String> interfaces = decodeList(props,
org.osgi.framework.Constants.OBJECTCLASS);
osgiProperties.put(org.osgi.framework.Constants.OBJECTCLASS,
(String[]) interfaces.toArray(new String[interfaces.size()]));
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_PACKAGE_VERSION_
for (String intf : interfaces) {
String packageKey = org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_PACKAGE_VERSION_
+ getPackageName(intf);
String intfVersion = decodeString(props, packageKey);
if (intfVersion != null)
osgiProperties.put(packageKey, intfVersion);
}
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_ID
String endpointId = decodeString(props,
org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_ID);
osgiProperties
.put(org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_ID,
endpointId);
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_SERVICE_ID
Long endpointServiceId = decodeLong(
props,
org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_SERVICE_ID);
osgiProperties
.put(org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_SERVICE_ID,
endpointServiceId);
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_FRAMEWORK_UUID
String fwkuuid = decodeString(
props,
org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_FRAMEWORK_UUID);
osgiProperties
.put(org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_FRAMEWORK_UUID,
fwkuuid);
// org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_IMPORTED_CONFIGS
List<String> configTypes = decodeList(
props,
org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_IMPORTED_CONFIGS);
if (configTypes != null && configTypes.size() > 0)
osgiProperties
.put(org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_IMPORTED_CONFIGS,
(String[]) configTypes
.toArray(new String[configTypes.size()]));
// org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_INTENTS
List<String> intents = decodeList(
props,
org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_INTENTS);
if (intents != null && intents.size() > 0)
osgiProperties
.put(org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_INTENTS,
(String[]) intents.toArray(new String[intents
.size()]));
// org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_CONFIGS_SUPPORTED
List<String> remoteConfigsSupported = decodeList(
props,
org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_CONFIGS_SUPPORTED);
if (remoteConfigsSupported != null && remoteConfigsSupported.size() > 0)
osgiProperties
.put(org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_CONFIGS_SUPPORTED,
(String[]) remoteConfigsSupported
.toArray(new String[remoteConfigsSupported
.size()]));
// org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_INTENTS_SUPPORTED
List<String> remoteIntentsSupported = decodeList(
props,
org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_INTENTS_SUPPORTED);
if (remoteIntentsSupported != null && remoteIntentsSupported.size() > 0)
osgiProperties
.put(org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_INTENTS_SUPPORTED,
(String[]) remoteIntentsSupported
.toArray(new String[remoteIntentsSupported
.size()]));
}
protected EndpointDescription decodeEndpointDescription(
IServiceProperties discoveredServiceProperties) {
Map<String, Object> endpointDescriptionProperties = new TreeMap<String, Object>(
String.CASE_INSENSITIVE_ORDER);
decodeOSGiProperties(discoveredServiceProperties,
endpointDescriptionProperties);
// remote service id
Long remoteServiceId = decodeLong(discoveredServiceProperties,
org.eclipse.ecf.remoteservice.Constants.SERVICE_ID);
endpointDescriptionProperties.put(
org.eclipse.ecf.remoteservice.Constants.SERVICE_ID,
remoteServiceId);
// container id namespace
String containerIDNamespace = decodeString(discoveredServiceProperties,
RemoteConstants.ENDPOINT_CONTAINER_ID_NAMESPACE);
if (containerIDNamespace != null)
endpointDescriptionProperties.put(
RemoteConstants.ENDPOINT_CONTAINER_ID_NAMESPACE,
containerIDNamespace);
// connect target ID
String connectTargetIDName = decodeString(discoveredServiceProperties,
RemoteConstants.ENDPOINT_CONNECTTARGET_ID);
if (connectTargetIDName != null)
endpointDescriptionProperties.put(
RemoteConstants.ENDPOINT_CONNECTTARGET_ID,
connectTargetIDName);
// ID filter
List<String> idFilterNames = decodeList(discoveredServiceProperties,
RemoteConstants.ENDPOINT_IDFILTER_IDS);
Object idFilterNamesval = PropertiesUtil
.convertToStringPlusValue(idFilterNames);
if (idFilterNamesval != null)
endpointDescriptionProperties.put(
RemoteConstants.ENDPOINT_IDFILTER_IDS, idFilterNamesval);
// remote service filter
String remoteServiceFilter = decodeString(discoveredServiceProperties,
RemoteConstants.ENDPOINT_REMOTESERVICE_FILTER);
if (remoteServiceFilter != null)
endpointDescriptionProperties.put(
RemoteConstants.ENDPOINT_REMOTESERVICE_FILTER,
remoteServiceFilter);
// Finally, fill out other properties
decodeNonStandardServiceProperties(discoveredServiceProperties,
endpointDescriptionProperties);
return new EndpointDescription(endpointDescriptionProperties);
}
private String getPackageName(String className) {
int lastDotIndex = className.lastIndexOf(".");
if (lastDotIndex == -1)
return "";
return className.substring(0, lastDotIndex);
}
protected void encodeOSGiServiceProperties(
EndpointDescription endpointDescription, IServiceProperties result) {
// org.osgi.framework.Constants.OBJECTCLASS =
// endpointDescription.getInterfaces();
List<String> interfaces = endpointDescription.getInterfaces();
encodeList(result, org.osgi.framework.Constants.OBJECTCLASS, interfaces);
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_PACKAGE_VERSION_
// version every interface package, make sure to encode package version
// (if specified)
for (String intf : interfaces) {
String intfPackageName = getPackageName(intf);
Version intfVersion = endpointDescription
.getPackageVersion(intfPackageName);
if (intfVersion != null
&& !Version.emptyVersion.equals(intfVersion))
encodeString(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_PACKAGE_VERSION_
+ intfPackageName, intfVersion.toString());
}
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_ID ==
// endpointDescription.getId()
String endpointId = endpointDescription.getId();
encodeString(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_ID,
endpointId);
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_SERVICE_ID
// = endpointDescription.getServiceId()
long endpointServiceId = endpointDescription.getServiceId();
encodeLong(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_SERVICE_ID,
new Long(endpointServiceId));
// org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_FRAMEWORK_UUID
// = endpointDescription.getFrameworkUUID()
String frameworkUUID = endpointDescription.getFrameworkUUID();
if (frameworkUUID != null)
encodeString(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_FRAMEWORK_UUID,
frameworkUUID);
// org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_IMPORTED_CONFIGS
// = endpointDescription.getConfigurationTypes();
List<String> configurationTypes = endpointDescription
.getConfigurationTypes();
if (configurationTypes.size() > 0)
encodeList(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_IMPORTED_CONFIGS,
configurationTypes);
// org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_INTENTS =
// endpointDescription.getIntents()
List<String> serviceIntents = endpointDescription.getIntents();
if (serviceIntents.size() > 0)
encodeList(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_INTENTS,
serviceIntents);
// org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_CONFIGS_SUPPORTED
Map endpointDescriptionProperties = endpointDescription.getProperties();
List<String> remoteConfigsSupported = PropertiesUtil
.getStringPlusProperty(
endpointDescriptionProperties,
org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_CONFIGS_SUPPORTED);
if (remoteConfigsSupported.size() > 0)
encodeList(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_CONFIGS_SUPPORTED,
remoteConfigsSupported);
// org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_INTENTS_SUPPORTED
List<String> remoteIntentsSupported = PropertiesUtil
.getStringPlusProperty(
endpointDescriptionProperties,
org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_INTENTS_SUPPORTED);
if (remoteIntentsSupported.size() > 0)
encodeList(
result,
org.osgi.service.remoteserviceadmin.RemoteConstants.REMOTE_INTENTS_SUPPORTED,
remoteIntentsSupported);
}
protected void encodeServiceProperties(
EndpointDescription endpointDescription, IServiceProperties result) {
encodeOSGiServiceProperties(endpointDescription, result);
// org.eclipse.ecf.remoteservice.Constants.SERVICE_ID =
// endpointDescription.getRemoteServiceId()
long remoteServiceId = endpointDescription.getRemoteServiceId();
encodeLong(result, org.eclipse.ecf.remoteservice.Constants.SERVICE_ID,
new Long(remoteServiceId));
// org.eclipse.ecf.osgi.services.remoteserviceadmin.RemoteConstants.ENDPOINT_CONTAINER_ID_NAMESPACE
// = endpointDescription.getIdNamespace()
String containerIDNamespace = endpointDescription.getIdNamespace();
if (containerIDNamespace != null)
encodeString(result,
RemoteConstants.ENDPOINT_CONTAINER_ID_NAMESPACE,
containerIDNamespace);
// org.eclipse.ecf.osgi.services.remoteserviceadmin.RemoteConstants.ENDPOINT_CONNECTTARGET_ID
// = endpointDescription.getRemoteServiceId()
ID connectTargetID = endpointDescription.getConnectTargetID();
if (connectTargetID != null)
encodeString(result, RemoteConstants.ENDPOINT_CONNECTTARGET_ID,
connectTargetID.getName());
// org.eclipse.ecf.osgi.services.remoteserviceadmin.RemoteConstants.ENDPOINT_IDFILTER_IDS
// = endpointDescription.getIDFilter();
ID[] idFilter = endpointDescription.getIDFilter();
if (idFilter != null && idFilter.length > 0) {
List<String> idNames = new ArrayList<String>();
for (int i = 0; i < idFilter.length; i++)
idNames.add(idFilter[i].getName());
encodeList(result, RemoteConstants.ENDPOINT_IDFILTER_IDS, idNames);
}
// org.eclipse.ecf.osgi.services.remoteserviceadmin.RemoteConstants.ENDPOINT_REMOTESERVICE_FILTER
// = endpointDescription.getRemoteServiceFilter()
String remoteFilter = endpointDescription.getRemoteServiceFilter();
if (remoteFilter != null) {
encodeString(result, RemoteConstants.ENDPOINT_REMOTESERVICE_FILTER,
remoteFilter);
}
// encode non standard properties
encodeNonStandardServiceProperties(endpointDescription.getProperties(),
result);
}
protected void encodeNonStandardServiceProperties(
Map<String, Object> properties, IServiceProperties result) {
for (String key : properties.keySet()) {
if (!PropertiesUtil.isReservedProperty(key)) {
Object val = properties.get(key);
if (val instanceof byte[]) {
result.setPropertyBytes(key, (byte[]) val);
} else if (val instanceof String) {
result.setPropertyString(key, (String) val);
} else {
result.setProperty(key, val);
}
}
}
}
protected void decodeNonStandardServiceProperties(IServiceProperties props,
Map<String, Object> result) {
for (Enumeration keys = props.getPropertyNames(); keys
.hasMoreElements();) {
String key = (String) keys.nextElement();
if (!PropertiesUtil.isReservedProperty(key)) {
byte[] bytes = props.getPropertyBytes(key);
if (bytes != null) {
result.put(key, bytes);
continue;
}
String str = props.getPropertyString(key);
if (str != null) {
result.put(key, str);
continue;
}
Object obj = props.getProperty(key);
if (obj != null) {
result.put(key, obj);
continue;
}
}
}
}
protected void logWarning(String methodName, String message, Throwable t) {
LogUtility.logWarning(methodName, DebugOptions.DISCOVERY,
this.getClass(), message, t);
}
protected void logError(String methodName, String message, Throwable t) {
LogUtility.logError(methodName, DebugOptions.DISCOVERY,
this.getClass(), message, t);
}
public void close() {
// nothing to do
}
}
|
