forked from conwetlab/ngsijs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
NGSI.js
6967 lines (6516 loc) · 255 KB
/
NGSI.js
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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2013-2017 CoNWeT Lab., Universidad Politécnica de Madrid
* Copyright (c) 2018-2022 Future Internet Consulting and Development Solutions S.L.
*
* This file is part of ngsijs.
*
* Ngsijs is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* Ngsijs is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
* License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with ngsijs. If not, see <http://www.gnu.org/licenses/>.
*
* Linking this library statically or dynamically with other modules is
* making a combined work based on this library. Thus, the terms and
* conditions of the GNU Affero General Public License cover the whole
* combination.
*
* As a special exception, the copyright holders of this library give you
* permission to link this library with independent modules to produce an
* executable, regardless of the license terms of these independent
* modules, and to copy and distribute the resulting executable under
* terms of your choice, provided that you also meet, for each linked
* independent module, the terms and conditions of the license of that
* module. An independent module is a module which is not derived from
* or based on this library. If you modify this library, you may extend
* this exception to your version of the library, but you are not
* obligated to do so. If you do not wish to do so, delete this
* exception statement from your version.
*
* Modified by: Fermín Galán Márquez - Telefónica
*/
/* global EventSource, exports, require */
(function () {
"use strict";
/**
* @namespace
* @name NGSI
*/
var NGSI;
const privates = new WeakMap();
/* Detect Node.js */
/* istanbul ignore if */
if ((typeof require === 'function') && typeof exports != null) {
NGSI = exports;
var URL = require('whatwg-url').URL;
} else {
NGSI = {};
var URL = window.URL;
/*
* Basic makeRequest implementation for webbrowsers
*/
var merge = function merge(object) {
/* This is a private method and we alway use a correct object parameters
if (object == null || typeof object !== "object") {
throw new TypeError("object argument must be an object");
}*/
Array.prototype.slice.call(arguments, 1).forEach(function (source) {
if (source != null) {
Object.keys(source).forEach(function (key) {
object[key] = source[key];
});
}
});
return object;
};
var setRequestHeaders = function setRequestHeaders() {
var headers, name;
headers = merge({
'Accept': 'application/json, */*'
}, this.options.requestHeaders);
if (this.options.postBody != null && !('Content-Type' in headers) && this.options.contentType != null) {
headers['Content-Type'] = this.options.contentType;
if (this.options.encoding != null) {
headers['Content-Type'] += '; charset=' + this.options.encoding;
}
}
for (name in headers) {
if (headers[name] != null) {
this.transport.setRequestHeader(name, headers[name]);
}
}
};
var Response = function Response(request) {
Object.defineProperties(this, {
'request': {value: request},
'transport': {value: request.transport},
'status': {value: request.transport.status},
'statusText': {value: request.transport.statusText},
'response': {value: request.transport.response}
});
if (request.options.responseType == null || request.options.responseType === '') {
Object.defineProperties(this, {
'responseText': {value: request.transport.responseText},
'responseXML': {value: request.transport.responseXML}
});
}
};
Response.prototype.getHeader = function getHeader(name) {
try {
return this.transport.getResponseHeader(name);
} catch (e) { return null; }
};
var toQueryString = function toQueryString(parameters) {
var key, query = [];
if (parameters != null && typeof parameters === 'object') {
for (key in parameters) {
if (typeof parameters[key] === 'undefined') {
continue;
} else if (parameters[key] === null) {
query.push(encodeURIComponent(key) + '=');
} else {
query.push(encodeURIComponent(key) + '=' + encodeURIComponent(parameters[key]));
}
}
} else {
return null;
}
if (query.length > 0) {
return query.join('&');
} else {
return null;
}
};
var Request = function Request(url, options) {
this.options = merge({
method: 'POST',
asynchronous: true,
responseType: null,
contentType: null,
encoding: null,
postBody: null
}, options);
Object.defineProperties(this, {
method: {
value: this.options.method.toUpperCase()
}
});
var parameters = toQueryString(this.options.parameters);
if (['PUT', 'POST'].indexOf(this.method) !== -1 && this.options.postBody == null) {
if (parameters != null) {
this.options.postBody = parameters;
if (this.options.contentType == null) {
this.options.contentType = 'application/x-www-form-urlencoded';
}
if (this.options.encoding == null) {
this.options.encoding = 'UTF-8';
}
}
} else /* if (['PUT', 'POST'].indexOf(this.method) === -1 || this.options.postBody != null) */ {
if (parameters != null) {
if (url.search !== "") {
url.search = url.search + '&' + parameters;
} else {
url.search = '?' + parameters;
}
}
}
Object.defineProperties(this, {
url: {
value: url
},
abort: {
value: function () {
this.transport.aborted = true;
this.transport.abort();
return this;
}
}
});
Object.defineProperty(this, 'transport', {value: new XMLHttpRequest()});;
if (this.options.withCredentials === true && this.options.supportsAccessControl) {
this.transport.withCredentials = true;
}
if (this.options.responseType) {
this.transport.responseType = this.options.responseType;
}
this.promise = new Promise(function (resolve, reject) {
this.transport.addEventListener("abort", function (event) {
event.stopPropagation();
event.preventDefault();
reject("aborted");
});
this.transport.addEventListener("load", function () {
var response = new Response(this);
resolve(response);
}.bind(this));
this.transport.addEventListener("error", function () {
reject(new NGSI.ConnectionError(this));
}.bind(this));
}.bind(this));
this.transport.open(this.method, this.url, this.options.asynchronous);
setRequestHeaders.call(this);
this.transport.send(this.options.postBody);
};
Request.prototype.then = function then(onFulfilled, onRejected) {
return this.promise.then(onFulfilled, onRejected);
};
Request.prototype.catch = function _catch(onRejected) {
return this.promise.catch(onRejected);
};
var makeRequest = function makeRequest(url, options) {
return new Request(url, options);
};
}
NGSI.endpoints = {
SERVER_DETAILS: 'version',
v1: {
REGISTER_CONTEXT: 'v1/registry/registerContext',
DISCOVER_CONTEXT_AVAILABILITY: 'v1/registry/discoverContextAvailability',
SUBSCRIBE_CONTEXT_AVAILABILITY: 'v1/registry/subscribeContextAvailability',
UPDATE_CONTEXT_AVAILABILITY_SUBSCRIPTION: 'v1/registry/updateContextAvailabilitySubscription',
UNSUBSCRIBE_CONTEXT_AVAILABILITY: 'v1/registry/unsubscribeContextAvailability',
QUERY_CONTEXT: 'v1/queryContext',
UPDATE_CONTEXT: 'v1/updateContext',
SUBSCRIBE_CONTEXT: 'v1/subscribeContext',
UPDATE_CONTEXT_SUBSCRIPTION: 'v1/updateContextSubscription',
UNSUBSCRIBE_CONTEXT: 'v1/unsubscribeContext',
CONTEXT_TYPES: 'v1/contextTypes'
},
v2: {
BATCH_QUERY_OP: 'v2/op/query',
BATCH_UPDATE_OP: 'v2/op/update',
ENTITY_ATTRS_COLLECTION: 'v2/entities/%(entityId)s/attrs',
ENTITY_ATTR_ENTRY: 'v2/entities/%(entityId)s/attrs/%(attribute)s',
ENTITY_ATTR_VALUE_ENTRY: 'v2/entities/%(entityId)s/attrs/%(attribute)s/value',
ENTITY_COLLECTION: 'v2/entities',
ENTITY_ENTRY: 'v2/entities/%(entityId)s',
REGISTRATION_COLLECTION: 'v2/registrations',
REGISTRATION_ENTRY: 'v2/registrations/%(registrationId)s',
SUBSCRIPTION_COLLECTION: 'v2/subscriptions',
SUBSCRIPTION_ENTRY: 'v2/subscriptions/%(subscriptionId)s',
TYPE_COLLECTION: 'v2/types',
TYPE_ENTRY: 'v2/types/%(typeId)s'
},
ld: {
ENTITY_ATTR_ENTRY: 'ngsi-ld/v1/entities/%(entityId)s/attrs/%(attribute)s',
ENTITY_COLLECTION: 'ngsi-ld/v1/entities',
ENTITY_ENTRY: 'ngsi-ld/v1/entities/%(entityId)s',
ENTITY_ATTRS_COLLECTION: 'ngsi-ld/v1/entities/%(entityId)s/attrs',
SUBSCRIPTION_COLLECTION: 'ngsi-ld/v1/subscriptions',
SUBSCRIPTION_ENTRY: 'ngsi-ld/v1/subscriptions/%(subscriptionId)s',
TEMPORAL_ENTITY_ATTRS_COLLECTION: 'ngsi-ld/v1/temporal/entities/%(entityId)s/attrs',
TEMPORAL_ENTITY_ATTRS_ENTRY: 'ngsi-ld/v1/temporal/entities/%(entityId)s/attrs/%(attribute)s',
TEMPORAL_ENTITY_ATTRS_INSTANCE_ENTRY: 'ngsi-ld/v1/temporal/entities/%(entityId)s/attrs/%(attribute)s/%(instanceId)s',
TEMPORAL_ENTITY_COLLECTION: 'ngsi-ld/v1/temporal/entities',
TEMPORAL_ENTITY_ENTRY: 'ngsi-ld/v1/temporal/entities/%(entityId)s',
TYPE_COLLECTION: 'ngsi-ld/v1/types',
TYPE_ENTRY: 'ngsi-ld/v1/types/%(typeId)s'
}
};
NGSI.proxy_endpoints = {
EVENTSOURCE_COLLECTION: 'eventsource',
CALLBACK_COLLECTION: 'callbacks'
};
/* Request utility functions */
const interpolate = function interpolate(pattern, attributes) {
return pattern.replace(/%\(\w+\)s/g,
function (match) {
return String(attributes[match.slice(2, -2)]);
});
};
const deleteHeader = function deleteHeader(headerName, requestHeaders) {
var headerNameLow = headerName.trim().toLowerCase();
var keys = Object.keys(requestHeaders);
var index = keys.map(function (headerName) {
return headerName.trim().toLowerCase();
}).indexOf(headerNameLow);
if (index !== -1) {
delete requestHeaders[keys[index]];
}
};
const makeJSONRequest2 = function makeJSONRequest2(url, options) {
if (options.postBody != null) {
if (options.contentType == null) {
options.contentType = 'application/json';
}
options.postBody = JSON.stringify(options.postBody);
}
var requestHeaders = JSON.parse(JSON.stringify(this.headers));
if (requestHeaders.Accept == null) {
requestHeaders.Accept = 'application/json';
}
for (var headerName in options.requestHeaders) {
if (options.requestHeaders[headerName] != null) {
deleteHeader(headerName, requestHeaders);
requestHeaders[headerName] = options.requestHeaders[headerName];
}
}
options.requestHeaders = requestHeaders;
return this.makeRequest(url, options).then(
function (response) {
if ([0, 502, 504].indexOf(response.status) !== -1) {
return Promise.reject(new NGSI.ConnectionError());
}
return Promise.resolve(response);
},
function (error) {
// Allow to customize error details by "backends"
if (!(error instanceof NGSI.ConnectionError)) {
error = new NGSI.ConnectionError();
}
return Promise.reject(error);
}
);
};
const ngsi_build_replace_entity_request = function ngsi_build_replace_entity_request(entity, options, parameters) {
if (entity.type != null) {
parameters.type = entity.type;
delete entity.type;
}
if (options.keyValues === true) {
parameters.options = "keyValues";
}
delete entity.id;
return entity;
};
/* Response parsers */
const parse_pagination_options2 = function parse_pagination_options2(options, optionsparams) {
const parameters = {};
const ld = optionsparams == null;
if (options.limit != null) {
if (typeof options.limit !== 'number' || !Number.isInteger(options.limit) || options.limit < (ld ? 0 : 1)) {
throw new TypeError('invalid value for the limit option');
}
parameters.limit = options.limit;
} else {
options.limit = 20;
}
if (options.offset != null) {
if (typeof options.offset !== 'number' || !Number.isInteger(options.offset) || options.offset < 0) {
throw new TypeError('invalid value for the offset option');
}
parameters.offset = options.offset;
} else {
options.offset = 0;
}
if (options.count != null) {
if (typeof options.count !== 'boolean') {
throw new TypeError('invalid value for the count option');
}
if (ld) {
parameters.count = options.count;
} else {
optionsparams.push('count');
}
}
return parameters;
};
const parse_error_response = function parse_error_response(response) {
if (["application/json", "application/ld+json"].indexOf(response.getHeader('Content-Type')) === -1) {
throw new TypeError("Unexpected response mimetype: " + response.getHeader("Content-Type"));
}
return JSON.parse(response.responseText);
};
const parse_bad_request = function parse_bad_request(response, correlator) {
let error;
try {
error = parse_error_response(response);
} catch (e) {
return Promise.reject(new NGSI.InvalidResponseError(null, correlator, response.status, response.responseText));
}
return Promise.reject(new NGSI.BadRequestError({message: error.description, correlator: correlator}));
};
const parse_not_found_response = function parse_not_found_response(response, correlator) {
let error;
try {
error = parse_error_response(response);
} catch (e) {
return Promise.reject(new NGSI.InvalidResponseError(null, correlator, response.status, response.responseText));
}
return Promise.reject(new NGSI.NotFoundError({message: error.description, correlator: correlator}));
};
const parse_too_many_results = function parse_too_many_results(response, correlator) {
let error;
try {
error = parse_error_response(response);
} catch (e) {
return Promise.reject(new NGSI.InvalidResponseError(null, correlator, response.status, response.responseText));
}
return Promise.reject(new NGSI.TooManyResultsError({message: error.description, correlator: correlator}));
};
const parse_not_found_response_ld = function parse_not_found_response_ld(response) {
let error;
try {
error = parse_error_response(response);
} catch (e) {
return Promise.reject(new NGSI.InvalidResponseError(null, null, response.status, response.responseText));
}
return Promise.reject(new NGSI.NotFoundError({message: error.title, details: error.detail}));
};
const parse_bad_request_ld = function parse_bad_request_ld(response) {
let error, exc;
try {
error = parse_error_response(response);
} catch (e) {
return Promise.reject(new NGSI.InvalidResponseError(e.toString(), null, response.status, response.responseText));
}
if (error.type === "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest") {
exc = new NGSI.InvalidRequestError(undefined, error.title, error.detail);
} else {
exc = new NGSI.BadRequestError({message: error.title, details: error.detail});
}
return Promise.reject(exc);
};
/**
* Parses comma-separated value options allowing arrays.
*
* @param value value to be processed
* @param [allow_empty=true] if false, passing an empty string/array value
* (undefined/null is still possible) will throw a TypeError exception.
* @param [option] option name. required if allow_empty is false
*
* @throws {TypeError}
*/
const parse_list_option = function parse_list_option(value, allow_empty, option) {
allow_empty = allow_empty == null ? true : !!allow_empty;
if (Array.isArray(value)) {
if (!allow_empty && value.length === 0) {
throw new TypeError(`invalid empty array value for the ${option} option`);
}
return value.length > 0 ? value.join(',') : undefined;
} else if (value != null) {
value = value.toString().trim();
if (!allow_empty && value === "") {
throw new TypeError(`invalid empty value for the ${option} option`);
}
return value;
} else {
return undefined;
}
};
const init = function init() {
return this.makeRequest(new URL(NGSI.proxy_endpoints.EVENTSOURCE_COLLECTION, this.url), {
supportsAccessControl: true, // required for using CORS on WireCloud
method: 'POST'
}).then(
(response) => {
if ([0, 502, 504].indexOf(response.status) !== -1) {
privates.get(this).promise = null;
return Promise.reject(new NGSI.ConnectionError());
} else if (response.status !== 201) {
privates.get(this).promise = null;
return Promise.reject(new NGSI.InvalidResponseError('Unexpected error code: ' + response.status, null, response.status, response.responseText));
}
let priv = privates.get(this);
try {
priv.source_url = new URL(response.getHeader('Location'));
} catch (e) {
privates.get(this).promise = null;
return Promise.reject(new NGSI.InvalidResponseError('Invalid/missing Location Header', null, response.status, response.responseText));
}
return connect_to_eventsource.call(this);
},
(error) => {
privates.get(this).promise = null;
// Allow to customize error details by "backends"
if (!(error instanceof NGSI.ConnectionError)) {
error = new NGSI.ConnectionError();
}
return Promise.reject(error);
}
);
};
const connect_to_eventsource = function connect_to_eventsource() {
var priv = privates.get(this);
return new Promise(function (resolve, reject) {
let closeTimeout, handle_connection_rejected, handle_connection_timeout;
const wait_event_source_init = function wait_event_source_init(e) {
var data = JSON.parse(e.data);
clearTimeout(closeTimeout);
priv.promise = null;
priv.connection_id = data.id;
priv.source.removeEventListener("error", handle_connection_rejected, true);
priv.source.removeEventListener("init", wait_event_source_init, true);
priv.source.addEventListener("open", () => {
priv.promise = null;
Object.values(priv.callbacks).forEach((callback) => {
callback.method(null, null, true, "connected");
});
}, true);
priv.source.addEventListener("error", (e) => {
const callbacks = Object.values(priv.callbacks);
if (e.target.readyState === e.target.CLOSED) {
priv.promise = null;
priv.source = null;
priv.connection_id = null;
priv.callbacks = {};
priv.callbacksBySubscriptionId = {};
} else {
// Use a resolved promise to mark this connection as connecting
priv.promise = Promise.resolve();
}
callbacks.forEach((callback) => {
callback.method(null, null, true, e.target.readyState === e.target.CLOSED ? "closed" : "disconnected");
});
}, true);
priv.source.addEventListener('notification', function (e) {
var data = JSON.parse(e.data);
priv.callbacks[data.callback_id].method(data.payload, data.headers, false, null);
}, true);
resolve();
};
const abort_event_source = function abort_event_source(message) {
clearTimeout(closeTimeout);
priv.promise = null;
priv.source.removeEventListener('error', handle_connection_rejected, true);
priv.source.removeEventListener('init', wait_event_source_init, true);
priv.source.close();
priv.source = null;
reject(new NGSI.ConnectionError(message));
};
handle_connection_rejected = abort_event_source.bind(null, "Connection rejected");
handle_connection_timeout = abort_event_source.bind(null, "Connection timeout");
priv.source = new EventSource(priv.source_url);
priv.source.addEventListener('error', handle_connection_rejected, true);
priv.source.addEventListener('init', wait_event_source_init, true);
closeTimeout = setTimeout(handle_connection_timeout, 30000);
});
};
const on_callback_subscriptions_get = function on_callback_subscriptions_get() {
var mapping = {};
var callbacks = privates.get(this).callbacks;
for (var key in callbacks) {
mapping[key] = callbacks[key].subscription != null ? callbacks[key].subscription.id : null;
}
return mapping;
};
const on_callback_subscriptions_versioned_get = function on_callback_subscriptions_versioned_get() {
var mapping = {};
var callbacks = privates.get(this).callbacks;
for (var key in callbacks) {
mapping[key] = callbacks[key].subscription;
}
return mapping;
};
const on_connected_get = function on_connected_get() {
var priv = privates.get(this);
return priv.source != null && priv.connection_id != null
};
const on_connecting_get = function on_connecting_get() {
return privates.get(this).promise !== null;
};
const on_connection_id_get = function on_connection_id_get() {
return privates.get(this).connection_id;
};
const on_subscription_callbacks_get = function on_subscription_callbacks_get() {
var mapping = {};
var subscriptions = privates.get(this).callbacksBySubscriptionId;
for (var key in subscriptions) {
mapping[key] = subscriptions[key].callback_id;
}
return mapping;
};
NGSI.ProxyConnection = function ProxyConnection(url, makeRequest /* TODO */) {
try {
url = new URL(url);
} catch (e) {
throw new TypeError("invalid url parameter");
}
if (url.protocol !== "http:" && url.protocol !== "https:") {
throw new TypeError("unsupported protocol: " + url.protocol.substr(0, url.protocol.length - 1));
}
if (url.pathname[url.pathname.length - 1] !== '/') {
url.pathname += '/';
}
this.makeRequest = makeRequest;
privates.set(this, {
callbacks: {},
callbacksBySubscriptionId: {},
connection_id: null,
promise: null,
source: null
});
Object.defineProperties(this, {
callbackSubscriptions: {
get: on_callback_subscriptions_get
},
callbackSubscriptionsVersioned: {
get: on_callback_subscriptions_versioned_get
},
connected: {
get: on_connected_get
},
connecting: {
get: on_connecting_get
},
connection_id: {
get: on_connection_id_get
},
subscriptionCallbacks: {
get: on_subscription_callbacks_get
},
url: {
value: url
}
});
};
/**
* Stablishes the connection with the ngsi proxy.
*
* @returns {Promise}
*/
NGSI.ProxyConnection.prototype.connect = function connect() {
if (this.connected === true) {
return Promise.resolve();
}
var priv = privates.get(this);
if (priv.promise === null) {
priv.promise = init.call(this);
}
return priv.promise;
};
/**
* Requests a new callback endpoint
*
* @param {Function} listener
* function that will be called when a notification arrives through the
* ngsi-proxy callback endpoint.
* @returns {Promise}
*/
NGSI.ProxyConnection.prototype.requestCallback = function requestCallback(callback) {
if (typeof callback !== 'function') {
throw new TypeError('callback parameter must be a function');
}
return this.connect().then(function () {
return this.makeRequest(new URL(NGSI.proxy_endpoints.CALLBACK_COLLECTION, this.url), {
supportsAccessControl: true, // required for using CORS on WireCloud
method: 'POST',
contentType: 'application/json',
postBody: JSON.stringify({connection_id: this.connection_id})
}).then(
(response) => {
if ([200, 201].indexOf(response.status) === -1) {
return Promise.reject(new NGSI.InvalidResponseError('Unexpected error code: ' + response.status, null, response.status, response.responseText));
}
let data = JSON.parse(response.responseText);
let priv = privates.get(this);
priv.callbacks[data.callback_id] = {
callback_id: data.callback_id,
method: callback,
subscription: null
};
return Promise.resolve(data);
},
(error) => {
// Allow to customize error details by "backends"
if (!(error instanceof NGSI.ConnectionError)) {
error = new NGSI.ConnectionError();
}
return Promise.reject(error);
}
);
}.bind(this));
};
/**
* Closes the connection with the ngsi-proxy. All the callback endpoints
* will be removed.
*
* @param {Boolean} [async] Make an asynchronous requests. default: `true`.
*
* @returns {Promise}
*/
NGSI.ProxyConnection.prototype.close = function close(async) {
if (this.connected === false) {
return Promise.resolve();
}
if (async !== false) {
async = true;
}
var priv = privates.get(this);
return this.makeRequest(priv.source_url, {
supportsAccessControl: true, // required for using CORS on WireCloud
method: 'DELETE',
asynchronous: async
}).then(
(response) => {
if (response.status !== 204) {
return Promise.reject(new NGSI.InvalidResponseError('Unexpected error code: ' + response.status, null, response.status, response.responseText));
}
priv.source.close();
priv.source = null;
priv.connection_id = null;
priv.callbacks = {};
priv.callbacksBySubscriptionId = {};
},
(error) => {
// Allow to customize error details by "backends"
if (!(error instanceof NGSI.ConnectionError)) {
error = new NGSI.ConnectionError();
}
return Promise.reject(error);
}
);
};
/**
* Deletes a callback from the ngsi-proxy server
*
* @param {String} callback
* id of the callback to delete
* @returns {Promise}
*/
NGSI.ProxyConnection.prototype.closeCallback = function closeCallback(callback_id) {
return this.makeRequest(new URL(NGSI.proxy_endpoints.CALLBACK_COLLECTION + '/' + callback_id, this.url), {
supportsAccessControl: true, // required for using CORS on WireCloud
method: 'DELETE'
}).then(
(response) => {
if (response.status !== 204) {
return Promise.reject(new NGSI.InvalidResponseError('Unexpected error code: ' + response.status, null, response.status, response.responseText));
}
this.purgeCallback(callback_id);
},
(error) => {
// Allow to customize error details by "backends"
if (!(error instanceof NGSI.ConnectionError)) {
error = new NGSI.ConnectionError();
}
return Promise.reject(error);
}
);
};
/**
* Associates a callback with a the indicated NGSI subscription. If the
* callback is currently not managed by this proxy connection, the
* association is ignored.
*
* @param {String} callback
* id of the callback to associate
* @param {String} subscription
* id of the subscription to associate
* @param {String} version
* version of the API used for creating the subscription
* @returns {NGSI.ProxyConnection}
*/
NGSI.ProxyConnection.prototype.associateSubscriptionId = function associateSubscriptionId(callback, subscription, version) {
var priv = privates.get(this);
if (!(callback in priv.callbacks)) {
return this;
}
if (priv.callbacks[callback].subscription != null) {
throw new TypeError("Already associated callback");
}
priv.callbacksBySubscriptionId[subscription] = priv.callbacks[callback];
priv.callbacks[callback].subscription = {
id: subscription,
version: version
};
return this;
};
/**
* Closes the callback associated with the indicated subscription. If the
* subscription is currently not managed by this proxy connection, the
* operation is ignored.
*
* @param {String} subscription
* id of the subscription to close
* @returns {Promise}
*/
NGSI.ProxyConnection.prototype.closeSubscriptionCallback = function closeSubscriptionCallback(subscription) {
var priv = privates.get(this);
if (subscription in priv.callbacksBySubscriptionId) {
return this.closeCallback(priv.callbacksBySubscriptionId[subscription].callback_id);
} else {
return Promise.resolve();
}
};
/**
* Removes the callback from this proxy connection.
*/
NGSI.ProxyConnection.prototype.purgeCallback = function purgeCallback(callback) {
var priv = privates.get(this);
if (callback in priv.callbacks) {
var subscription = priv.callbacks[callback].subscription;
if (subscription != null) {
delete priv.callbacksBySubscriptionId[subscription.id];
}
delete priv.callbacks[callback];
}
};
/* NGSI Connection Error */
NGSI.Error = class NGSIError extends Error {
constructor(name, message) {
super(message);
this.name = name;
this.message = message || "";
// Maintains proper stack trace for where our error was thrown (only available on V8)
if (Error.captureStackTrace) {
Error.captureStackTrace(this, this.constructor);
}
}
};
/**
* Error raised if there are problems connecting to the context broker
* server. Browsers doesn't provide details about the connection problem due
* security concerns, so this exception doesn't provide those details.
*
* @class
* @extends NGSI.Error
* @name NGSI.ConnectionError
* @summary Exception raised for connection problems.
*/
NGSI.ConnectionError = class ConnectionError extends NGSI.Error {
constructor(message) {
super("ConnectionError", message || "Connection Error");
};
}
/**
* Error raised if the context broker server detected some problems with the
* data provided in the request.
*
* @class
* @extends NGSI.Error
* @name NGSI.InvalidRequestError
* @summary Exception raised when the context broker server reject the
* request.
*/
NGSI.InvalidRequestError = class InvalidRequestError extends NGSI.Error {
constructor(code, message, details) {
super("InvalidRequest", message);
this.code = code;
this.details = details || "";
}
};
/**
* Exception raised when creating an entity that already exists.
* Error code used by the context broker server: 422 Unprocessable
*
* @class
* @extends NGSI.Error
* @name NGSI.AlreadyExistsError
* @summary Exception raised when creating an entity that already exists.
*/
NGSI.AlreadyExistsError = class AlreadyExistsError extends NGSI.Error {
constructor(options) {
super("AlreadyExists", options.message);
this.correlator = options.correlator || null;
}
};
/**
* Exception raised when the provided data has errors.
* Error code used by the context broker server: 400 Bad Request
*
* @class
* @extends NGSI.Error
* @name NGSI.BadRequestError
* @summary Exception raised when creating an entity that already exists.
*/
NGSI.BadRequestError = class BadRequestError extends NGSI.Error {
constructor(options) {
super("BadRequest", options.message);
this.details = options.details || "";
this.correlator = options.correlator || null;
}
};
/**
* Exception raised when the server returns an unexpected response. This
* usually means that the server doesn't conform to the FIWARE NGSI
* Specification or that the server doesn't use a version supported by this
* library.
*
* This also includes some error codes that can be returned by the server,
* but that are not expected when using the library. For example, a context
* broker server can return a `UnsupportedMediaType` error but the library
* always use application/json as Content-Type when sending data to the
* context broker. So, in case such error code is returned, ngsijs will
* raise this exception. Other errors handled by this exception:
* ContentLengthRequired.
*
* @class
* @extends NGSI.Error