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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
|
/*
* Copyright (c) OSGi Alliance (2008, 2009). All Rights Reserved.
*
* 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.osgi.service.remoteserviceadmin;
import static org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_FRAMEWORK_UUID;
import static org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_ID;
import static org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_INTERACE_VERSION_;
import static org.osgi.service.remoteserviceadmin.RemoteConstants.ENDPOINT_URI;
import static org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_IMPORTED_CONFIGS;
import static org.osgi.service.remoteserviceadmin.RemoteConstants.SERVICE_INTENTS;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Dictionary;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import org.osgi.framework.Constants;
import org.osgi.framework.Filter;
import org.osgi.framework.FrameworkUtil;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.framework.Version;
/**
* A description of an endpoint that provides sufficient information for a
* compatible distribution provider to create a connection to this endpoint
*
* An Endpoint Description is easy to transfer between different systems. This
* allows it to be used as a communications device to convey available endpoint
* information to nodes in a network.
*
* An Endpoint Description reflects the perspective of an importer. That is, the
* property keys have been chosen to match filters that are created by client
* bundles that need a service. Therefore the map must not contain any
* service.exported.* property and must contain the service.imported.* ones.
*
* The service.intents property contains the intents provided by the service
* itself combined with the intents added by the exporting distribution
* provider. Qualified intents appear expanded on this property.
*
* @Immutable
* @version $Revision$
*/
public class EndpointDescription {
private final Map<String, Object> properties;
private final List<String> interfaces;
private final long remoteServiceId;
private final String remoteFrameworkUUID;
private final String remoteUri;
/**
* Create an Endpoint Description based on a Map.
*
* @param properties The map to create the Endpoint Description from.
* @throws IllegalArgumentException When the properties are not proper for
* an Endpoint Description
*/
public EndpointDescription(Map<String, Object> properties) {
this(properties, null);
if (properties == null) {
throw new NullPointerException("properties must not be null");
}
}
/**
* Create an Endpoint Description based on a reference and optionally a map
* of additional properties. The properties on the original service take
* precedence over the ones in the map.
*
* @param reference A service reference that can be exported
* @param properties Additional properties to add. Can be <code>null</code>.
* @throws IllegalArgumentException When the properties are not proper for
* an Endpoint Description
*/
public EndpointDescription(ServiceReference reference,
Map<String, Object> properties) {
this(properties, reference);
if (reference == null) {
throw new NullPointerException("reference must not be null");
}
}
private EndpointDescription(Map<String, Object> map,
ServiceReference reference) {
Map<String, Object> props = new TreeMap<String, Object>(
String.CASE_INSENSITIVE_ORDER);
if (map != null) {
try {
props.putAll(map);
}
catch (ClassCastException e) {
IllegalArgumentException iae = new IllegalArgumentException(
"non-String key in properties");
iae.initCause(e);
throw iae;
}
if (props.size() < map.size()) {
throw new IllegalArgumentException(
"duplicate keys with different cases in properties");
}
}
if (reference != null) {
for (String key : reference.getPropertyKeys()) {
if (!props.containsKey(key)) {
props.put(key, reference.getProperty(key));
}
}
}
properties = Collections.unmodifiableMap(props);
/* properties must be initialized before calling the following methods */
interfaces = verifyObjectClassProperty();
remoteServiceId = verifyLongProperty(ENDPOINT_ID);
remoteFrameworkUUID = verifyStringProperty(ENDPOINT_FRAMEWORK_UUID);
remoteUri = verifyStringProperty(ENDPOINT_URI);
}
/**
* Verify and obtain the interface list from the properties.
*
* @return A list with the interface names.
* @throws IllegalArgumentException When the properties do not contain the
* right values for and interface list.
*
*/
private List<String> verifyObjectClassProperty() {
Object o = properties.get(Constants.OBJECTCLASS);
if (o == null) {
return Collections.EMPTY_LIST;
}
if (!(o instanceof String[])) {
throw new IllegalArgumentException(
"objectClass must be of type String[]");
}
String[] objectClass = (String[]) o;
for (String interf : objectClass) {
try {
getInterfaceVersion(interf);
}
catch (IllegalArgumentException e) {
IllegalArgumentException iae = new IllegalArgumentException(
"Improper version for interface " + interf);
iae.initCause(e);
throw iae;
}
}
return Collections.unmodifiableList(Arrays.asList(objectClass));
}
/**
* Verify and obtain a required String property.
*
* @param propName The name of the property
* @return The value of the property.
* @throws IllegalArgumentException when the property is not set or doesn't
* have the correct data type.
*/
private String verifyStringProperty(String propName) {
Object r = properties.get(propName);
if (r == null) {
throw new IllegalArgumentException("Required property not set: "
+ propName);
}
if (!(r instanceof String)) {
throw new IllegalArgumentException(
"Required property is not a String: " + propName);
}
return (String) r;
}
/**
* Verify and obtain a required long property.
*
* @param propName The name of the property
* @return The value of the property.
* @throws IllegalArgumentException when the property is not set or doesn't
* have the correct data type.
*/
private long verifyLongProperty(String propName) {
Object r = properties.get(propName);
if (r == null) {
throw new IllegalArgumentException("Required property not set: "
+ propName);
}
if (!(r instanceof String)) {
throw new IllegalArgumentException(
"Required property is not a string: " + propName);
}
try {
return Long.parseLong((String) r);
}
catch (NumberFormatException e) {
IllegalArgumentException iae = new IllegalArgumentException(
"Required property cannot be parsed as a long: " + propName);
iae.initCause(e);
throw iae;
}
}
/**
* Returns the endpoint's URI.
*
* The URI is an opaque id for an endpoint in URI form. No two different
* endpoints must have the same URI, two Endpoint Descriptions with the same
* URI must represent the same endpoint.
*
* The value of the URI is stored in the
* {@link RemoteConstants#ENDPOINT_URI} property.
*
* @return The URI of the endpoint, never <code>null</code>.
*/
public String getRemoteURI() {
return remoteUri;
}
/**
* Provide the list of interfaces implemented by the exported service.
*
* If this Endpoint Description does not map to a service, then this List
* must be empty.
*
* The value of the interfaces is derived from the <code>objectClass</code>
* property.
*
* @return The read only list of Java interface names accessible by this
* endpoint.
*/
public List<String> getInterfaces() {
return interfaces;
}
/**
* Provide the version of the given interface.
*
* The version is encoded by prefixing the given interface name with
* <code>endpoint.interface.version.</code>, and then using this as an
* endpoint property key. For example:
*
* <pre>
* endpoint.interface.version.com.acme.Foo
* </pre>
*
* The value of this property is in String format and will be converted to a
* <code>Version</code> object by this method.
*
* @param name The name of the interface for which a version is requested.
* @return The version of the given interface or <code>null</code> if the
* interface has no version in this Endpoint Description.
* @throws IllegalArgumentException If the version property value is not
* String.
*/
public Version getInterfaceVersion(String name) {
String key = ENDPOINT_INTERACE_VERSION_ + name;
Object version = properties.get(key);
// [rfeng] Check for existence of the property
if (version == null) {
return null;
}
// [rfeng]
if (!(version instanceof String)) {
throw new IllegalArgumentException(key
+ " property is not a String");
}
return Version.parseVersion((String) version);
}
/**
* Returns the service id for the service exported through this endpoint.
*
* This is the service id under which the framework has registered the
* service. This field together with the Framework UUID is a globally unique
* id for a service.
*
* The value of the remote service id is stored in the
* {@link RemoteConstants#ENDPOINT_ID} endpoint property.
*
* @return Service id of a service or 0 if this Endpoint Description does
* not relate to an OSGi service
*
*/
public long getRemoteServiceID() {
return remoteServiceId;
}
/**
* Returns the configuration types.
*
* A distribution provider exports a service with an endpoint. This endpoint
* uses some kind of communications protocol with a set of configuration
* parameters. There are many different types but each endpoint is
* configured by only one configuration type. However, a distribution
* provider can be aware of different configuration types and provide
* synonyms to increase the change a receiving distribution provider can
* create a connection to this endpoint.
*
* This value of the configuration types is stored in the
* {@link RemoteConstants#SERVICE_IMPORTED_CONFIGS} service property.
*
* @return An unmodifiable list of the configuration types used for the
* associated endpoint and optionally synonyms.
*/
public List<String> getConfigurationTypes() {
return getStringPlusProperty(SERVICE_IMPORTED_CONFIGS);
}
/**
* Return the list of intents implemented by this endpoint.
*
* The intents are based on the service.intents on an imported service,
* except for any intents that are additionally provided by the importing
* distribution provider. All qualified intents must have been expanded.
*
* This value of the intents is stored in the
* {@link RemoteConstants#SERVICE_INTENTS} service property.
*
* @return An unmodifiable list of expanded intents that are provided by
* this endpoint.
*/
public List<String> getIntents() {
return getStringPlusProperty(SERVICE_INTENTS);
}
/**
* Reads a 'String+' property from the properties map, which may be of type
* String, String[] or Collection<String> and returns it as an unmodifiable
* List.
*
* @param key The property
* @return An unmodifiable list
*/
private List<String> getStringPlusProperty(String key) {
Object value = properties.get(key);
if (value == null) {
return Collections.EMPTY_LIST;
}
if (value instanceof String) {
return Collections.singletonList((String) value);
}
if (value instanceof String[]) {
String[] values = (String[]) value;
List<String> result = new ArrayList<String>(values.length);
for (String v : values) {
if (v != null) {
result.add(v);
}
}
return Collections.unmodifiableList(result);
}
if (value instanceof Collection< ? >) {
Collection< ? > values = (Collection< ? >) value;
List<String> result = new ArrayList<String>(values.size());
for (Iterator< ? > iter = values.iterator(); iter.hasNext();) {
Object v = iter.next();
if ((v != null) && (v instanceof String)) {
result.add((String) v);
}
}
return Collections.unmodifiableList(result);
}
return Collections.EMPTY_LIST;
}
/**
* Return the framework UUID for the remote service, if present.
*
* The value of the remote framework uuid is stored in the
* {@link RemoteConstants#ENDPOINT_FRAMEWORK_UUID} endpoint property.
*
* @return Remote Framework UUID, or null if this endpoint is not associated
* with an OSGi service
*/
public String getRemoteFrameworkUUID() {
return remoteFrameworkUUID;
}
/**
* Returns all endpoint properties.
*
* @return An unmodifiable map referring to the properties of this Endpoint
* Description.
*/
public Map<String, Object> getProperties() {
return properties;
}
/**
* Answers if this Endpoint Description refers to the same service instance
* as the given Endpoint Description.
*
* Two Endpoint Descriptions point to the same service if they have the same
* URI or their framework UUIDs and remote service ids are equal.
*
* @param other The Endpoint Description to look at
* @return True if this endpoint description points to the same service as
* the other
*/
public boolean isSameService(EndpointDescription other) {
if (this.equals(other)) {
return true;
}
if (getRemoteFrameworkUUID() == null) {
return false;
}
return (this.getRemoteServiceID() == other.getRemoteServiceID())
&& this.getRemoteFrameworkUUID().equals(
other.getRemoteFrameworkUUID());
}
/**
* Returns a hash code value for the object.
*
* @return An integer which is a hash code value for this object.
*/
public int hashCode() {
return getRemoteURI().hashCode();
}
/**
* Compares this <code>EndpointDescription</code> object to another object.
*
* <p>
* An Endpoint Description is considered to be <b>equal to</b> another
* Endpoint Description if their URIs are equal.
*
* @param other The <code>EndpointDescription</code> object to be compared.
* @return <code>true</code> if <code>object</code> is a
* <code>EndpointDescription</code> and is equal to this object;
* <code>false</code> otherwise.
*/
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (!(other instanceof EndpointDescription)) {
return false;
}
return getRemoteURI().equals(
((EndpointDescription) other).getRemoteURI());
}
/**
* Tests the properties of this <code>EndpointDescription</code> against the
* given filter using a case insensitive match.
*
* @param filter The filter to test.
* @return <code>true</code> If the properties of this
* <code>EndpointDescription</code> match the filter,
* <code>false</code> otherwise.
* @throws IllegalArgumentException If <code>filter</code> contains an
* invalid filter string that cannot be parsed.
*/
public boolean matches(String filter) {
Filter f;
try {
f = FrameworkUtil.createFilter(filter);
}
catch (InvalidSyntaxException e) {
IllegalArgumentException iae = new IllegalArgumentException(e
.getMessage());
iae.initCause(e);
throw iae;
}
Dictionary<String, Object> d = new UnmodifiableDictionary<String, Object>(
properties);
/*
* we can use matchCase here since properties already supports case
* insensitive key lookup.
*/
return f.matchCase(d);
}
/**
* Unmodifiable wrapper for Dictionary.
*/
private static class UnmodifiableDictionary<K, V> extends Dictionary<K, V> {
private final Map<K, V> wrapped;
UnmodifiableDictionary(Map<K, V> wrapped) {
this.wrapped = wrapped;
}
public Enumeration<V> elements() {
return Collections.enumeration(wrapped.values());
}
public V get(Object key) {
return wrapped.get(key);
}
public boolean isEmpty() {
return wrapped.isEmpty();
}
public Enumeration<K> keys() {
return Collections.enumeration(wrapped.keySet());
}
public V put(K key, V value) {
throw new UnsupportedOperationException();
}
public V remove(Object key) {
throw new UnsupportedOperationException();
}
public int size() {
return wrapped.size();
}
}
}
|