/
AddressSpace.java
1443 lines (1228 loc) · 57.6 KB
/
AddressSpace.java
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) 2019 the Eclipse Milo Authors
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.milo.opcua.sdk.client;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import com.google.common.base.Preconditions;
import com.google.common.collect.Sets;
import org.eclipse.milo.opcua.sdk.client.ObjectTypeManager.ObjectNodeConstructor;
import org.eclipse.milo.opcua.sdk.client.nodes.UaDataTypeNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaMethodNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaObjectTypeNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaReferenceTypeNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaVariableTypeNode;
import org.eclipse.milo.opcua.sdk.client.nodes.UaViewNode;
import org.eclipse.milo.opcua.stack.core.AttributeId;
import org.eclipse.milo.opcua.stack.core.BuiltinReferenceType;
import org.eclipse.milo.opcua.stack.core.Identifiers;
import org.eclipse.milo.opcua.stack.core.StatusCodes;
import org.eclipse.milo.opcua.stack.core.UaException;
import org.eclipse.milo.opcua.stack.core.types.builtin.DataValue;
import org.eclipse.milo.opcua.stack.core.types.builtin.ExpandedNodeId;
import org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText;
import org.eclipse.milo.opcua.stack.core.types.builtin.NodeId;
import org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName;
import org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode;
import org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte;
import org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger;
import org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection;
import org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseResultMask;
import org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass;
import org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult;
import org.eclipse.milo.opcua.stack.core.types.structured.ReadResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId;
import org.eclipse.milo.opcua.stack.core.types.structured.ReferenceDescription;
import org.eclipse.milo.opcua.stack.core.util.FutureUtils;
import static java.util.concurrent.CompletableFuture.completedFuture;
import static org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.Unsigned.uint;
import static org.eclipse.milo.opcua.stack.core.util.ConversionUtil.l;
public class AddressSpace {
private NodeCache nodeCache = new NodeCache();
private BrowseOptions browseOptions = new BrowseOptions();
private final OpcUaClient client;
public AddressSpace(OpcUaClient client) {
this.client = client;
}
/**
* Get a {@link UaNode} instance for the Node identified by {@code nodeId}.
*
* @param nodeId the {@link NodeId} identifying the Node to get.
* @return a {@link UaNode} instance for the Node identified by {@code nodeId}.
* @throws UaException if an error occurs while creating the Node.
*/
public UaNode getNode(NodeId nodeId) throws UaException {
try {
return getNodeAsync(nodeId).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Get a {@link UaNode} instance for the Node identified by {@code nodeId}.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} identifying the Node to get.
* @return a CompletableFuture that completes successfully with the UaNode instance or
* completes exceptionally if a service-level error occurs.
*/
public CompletableFuture<? extends UaNode> getNodeAsync(NodeId nodeId) {
UaNode cachedNode = nodeCache.getIfPresent(nodeId);
if (cachedNode != null) {
return completedFuture(cachedNode);
} else {
return createNode(nodeId).whenComplete((node, ex) -> {
if (node != null) {
nodeCache.put(nodeId, node);
}
});
}
}
/**
* Get a {@link UaObjectNode} instance for the ObjectNode identified by {@code nodeId}.
* <p>
* The type definition will be read when the instance is created. If this type definition is
* registered with the {@link ObjectTypeManager} a {@link UaObjectNode} of the appropriate
* subclass will be returned.
*
* @param nodeId the {@link NodeId} identifying the ObjectNode to get.
* @return a {@link UaObjectNode} instance for the ObjectNode identified by {@code nodeId}.
* @throws UaException if an error occurs while creating the ObjectNode.
*/
public UaObjectNode getObjectNode(NodeId nodeId) throws UaException {
try {
return getObjectNodeAsync(nodeId).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Get a {@link UaObjectNode} instance for the ObjectNode identified by {@code nodeId},
* assuming the type definition identified by {@code typeDefinitionId}.
* <p>
* If this type definition is registered with the {@link ObjectTypeManager} a
* {@link UaObjectNode} of the appropriate subclass will be returned.
*
* @param nodeId the {@link NodeId} identifying the ObjectNode to get.
* @param typeDefinitionId the {@link NodeId} identifying the type definition.
* @return a {@link UaObjectNode} instance for the ObjectNode identified by {@code nodeId}.
* @throws UaException if an error occurs while creating the ObjectNode.
*/
public UaObjectNode getObjectNode(NodeId nodeId, NodeId typeDefinitionId) throws UaException {
try {
return getObjectNodeAsync(nodeId, typeDefinitionId).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Get a {@link UaObjectNode} instance for the ObjectNode identified by {@code nodeId}.
* <p>
* The type definition will be read when the instance is created. If this type definition is
* registered with the {@link ObjectTypeManager} a {@link UaObjectNode} of the appropriate
* subclass will be returned.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} identifying the ObjectNode to get.
* @return a CompletableFuture that completes successfully with a {@link UaObjectNode} instance
* for the ObjectNode identified by {@code nodeId} or completes exceptionally if an error
* occurs creating the ObjectNode.
*/
public CompletableFuture<UaObjectNode> getObjectNodeAsync(NodeId nodeId) {
UaNode cachedNode = nodeCache.getIfPresent(nodeId);
if (cachedNode instanceof UaObjectNode) {
return completedFuture((UaObjectNode) cachedNode);
} else {
CompletableFuture<NodeId> typeDefinitionFuture = readTypeDefinition(nodeId);
return typeDefinitionFuture.thenCompose(typeDefinitionId -> getObjectNodeAsync(nodeId, typeDefinitionId));
}
}
/**
* Get a {@link UaObjectNode} instance for the ObjectNode identified by {@code nodeId},
* assuming the type definition identified by {@code typeDefinitionId}.
* <p>
* If this type definition is registered with the {@link ObjectTypeManager} a
* {@link UaObjectNode} of the appropriate subclass will be returned.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} identifying the ObjectNode to get.
* @param typeDefinitionId the {@link NodeId} identifying the type definition.
* @return a CompletableFuture that completes successfully with a {@link UaObjectNode} instance
* for the ObjectNode identified by {@code nodeId} or completes exceptionally if an error
* occurs creating the ObjectNode.
*/
public CompletableFuture<UaObjectNode> getObjectNodeAsync(NodeId nodeId, NodeId typeDefinitionId) {
UaNode cachedNode = nodeCache.getIfPresent(nodeId);
if (cachedNode instanceof UaObjectNode) {
return completedFuture((UaObjectNode) cachedNode);
} else {
CompletableFuture<ReadResponse> future = readAttributes(nodeId, AttributeId.OBJECT_ATTRIBUTES);
return future.thenApply(response -> {
List<DataValue> attributeValues = l(response.getResults());
UaObjectNode node = newObjectNode(nodeId, typeDefinitionId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
}
/**
* Get a {@link UaVariableNode} instance for the VariableNode identified by {@code nodeId}.
* <p>
* The type definition will be read when the instance is created. If this type definition is
* registered with the {@link VariableTypeManager} a {@link UaVariableNode} of the appropriate
* subclass will be returned.
*
* @param nodeId the {@link NodeId} identifying the VariableNode to get.
* @return a {@link UaVariableNode} instance for the VariableNode identified by {@code nodeId}.
* @throws UaException if an error occurs while creating the VariableNode.
*/
public UaVariableNode getVariableNode(NodeId nodeId) throws UaException {
try {
return getVariableNodeAsync(nodeId).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Get a {@link UaVariableNode} instance for the VariableNode identified by {@code nodeId},
* assuming the type definition identified by {@code typeDefinitionId}.
* <p>
* If this type definition is registered with the {@link VariableTypeManager} a
* {@link UaVariableNode} of the appropriate subclass will be returned.
*
* @param nodeId the {@link NodeId} identifying the VariableNode to get.
* @param typeDefinitionId the {@link NodeId} identifying the type definition.
* @return a {@link UaVariableNode} instance for the VariableNode identified by {@code nodeId}.
* @throws UaException if an error occurs while creating the VariableNode.
*/
public UaVariableNode getVariableNode(NodeId nodeId, NodeId typeDefinitionId) throws UaException {
try {
return getVariableNodeAsync(nodeId, typeDefinitionId).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Get a {@link UaVariableNode} instance for the VariableNode identified by {@code nodeId}.
* <p>
* The type definition will be read when the instance is created. If this type definition is
* registered with the {@link VariableTypeManager} a {@link UaVariableNode} of the appropriate
* subclass will be returned.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} identifying the VariableNode to get.
* @return a CompletableFuture that completes successfully with a {@link UaVariableNode}
* instance for the VariableNode identified by {@code nodeId} or completes exceptionally if an
* error occurs while creating the VariableNode.
*/
public CompletableFuture<UaVariableNode> getVariableNodeAsync(NodeId nodeId) {
UaNode cachedNode = nodeCache.getIfPresent(nodeId);
if (cachedNode instanceof UaVariableNode) {
return completedFuture((UaVariableNode) cachedNode);
} else {
CompletableFuture<NodeId> typeDefinitionFuture = readTypeDefinition(nodeId);
return typeDefinitionFuture.thenCompose(typeDefinitionId -> getVariableNodeAsync(nodeId, typeDefinitionId));
}
}
/**
* Get a {@link UaVariableNode} instance for the VariableNode identified by {@code nodeId},
* assuming the type definition identified by {@code typeDefinitionId}.
* <p>
* If this type definition is registered with the {@link VariableTypeManager} a
* {@link UaVariableNode} of the appropriate subclass will be returned.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} identifying the VariableNode to get.
* @param typeDefinitionId the {@link NodeId} identifying the type definition.
* @return a CompletableFuture that completes successfully with a {@link UaVariableNode}
* instance for the VariableNode identified by {@code nodeId} or completes exceptionally if an
* error occurs while creating the VariableNode.
*/
public CompletableFuture<UaVariableNode> getVariableNodeAsync(NodeId nodeId, NodeId typeDefinitionId) {
UaNode cachedNode = nodeCache.getIfPresent(nodeId);
if (cachedNode instanceof UaVariableNode) {
return completedFuture((UaVariableNode) cachedNode);
} else {
CompletableFuture<ReadResponse> future = readAttributes(nodeId, AttributeId.VARIABLE_ATTRIBUTES);
return future.thenApply(response -> {
List<DataValue> attributeValues = l(response.getResults());
UaVariableNode node = newVariableNode(nodeId, typeDefinitionId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
}
/**
* Call the Browse service to get a {@link UaNode}'s references using the currently configured
* {@link BrowseOptions}.
*
* @param node the {@link UaNode} to browse.
* @return a List of {@link ReferenceDescription}s.
* @throws UaException if a service-level error occurs.
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public List<ReferenceDescription> browse(UaNode node) throws UaException {
return browse(node, getBrowseOptions());
}
/**
* Call the Browse service to get a {@link UaNode}'s references.
*
* @param node the {@link UaNode} to browse.
* @param browseOptions the {@link BrowseOptions} to browse with.
* @return a List of {@link ReferenceDescription}s.
* @throws UaException if a service-level error occurs.
*/
public List<ReferenceDescription> browse(UaNode node, BrowseOptions browseOptions) throws UaException {
try {
return browseAsync(node, browseOptions).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Call the Browse service to get a Node's references using the currently configured
* {@link BrowseOptions}.
*
* @param nodeId the {@link NodeId} of the Node to browse.
* @return a List of {@link ReferenceDescription}s.
* @throws UaException if a service-level error occurs.
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public List<ReferenceDescription> browse(NodeId nodeId) throws UaException {
return browse(nodeId, getBrowseOptions());
}
/**
* Call the Browse service to get a Node's references.
*
* @param nodeId the {@link NodeId} of the Node to browse.
* @param browseOptions the {@link BrowseOptions} to browse with.
* @return a List of {@link ReferenceDescription}s.
* @throws UaException if a service-level error occurs.
*/
public List<ReferenceDescription> browse(NodeId nodeId, BrowseOptions browseOptions) throws UaException {
try {
return browseAsync(nodeId, browseOptions).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Call the Browse service to get a {@link UaNode}'s references using the currently configured
* {@link BrowseOptions}.
* <p>
* This call completes asynchronously.
*
* @param node the {@link UaNode} to browse.
* @return a CompletableFuture that completes successfully with the List of references or
* completes exceptionally if a service-level error occurs.
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public CompletableFuture<List<ReferenceDescription>> browseAsync(UaNode node) {
return browseAsync(node.getNodeId(), getBrowseOptions());
}
/**
* Call the Browse service to get a {@link UaNode}'s references.
* <p>
* This call completes asynchronously.
*
* @param node the {@link UaNode} to browse.
* @param browseOptions the {@link BrowseOptions} to browse with.
* @return a CompletableFuture that completes successfully with the List of references or
* completes exceptionally if a service-level error occurs.
*/
public CompletableFuture<List<ReferenceDescription>> browseAsync(UaNode node, BrowseOptions browseOptions) {
return browseAsync(node.getNodeId(), browseOptions);
}
/**
* Call the Browse service to get a Node's references using the currently configured
* {@link BrowseOptions}.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} of the Node to browse.
* @return a CompletableFuture that completes successfully with the List of references or
* completes exceptionally if a service-level error occurs.
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public CompletableFuture<List<ReferenceDescription>> browseAsync(NodeId nodeId) {
return browseAsync(nodeId, getBrowseOptions());
}
/**
* Call the Browse service to get a Node's references.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} of the Node to browse.
* @param browseOptions the {@link BrowseOptions} to browse with.
* @return a CompletableFuture that completes successfully with the List of references or
* completes exceptionally if a service-level error occurs.
*/
public CompletableFuture<List<ReferenceDescription>> browseAsync(NodeId nodeId, BrowseOptions browseOptions) {
BrowseDescription browseDescription = new BrowseDescription(
nodeId,
browseOptions.getBrowseDirection(),
browseOptions.getReferenceTypeId(),
browseOptions.isIncludeSubtypes(),
browseOptions.getNodeClassMask(),
uint(BrowseResultMask.All.getValue())
);
return BrowseHelper.browse(client, browseDescription);
}
/**
* Browse from {@code node} using the currently configured {@link BrowseOptions}.
*
* @param node the {@link UaNode} to start the browse from.
* @return a List of {@link UaNode}s referenced by {@code node} given the currently configured
* {@link BrowseOptions}.
* @throws UaException if an error occurs while browsing or creating Nodes.
* @see #browseNodes(UaNode, BrowseOptions)
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public List<? extends UaNode> browseNodes(UaNode node) throws UaException {
return browseNodes(node, getBrowseOptions());
}
/**
* Browse from {@code node} using {@code browseOptions}.
*
* @param node the {@link UaNode} to start the browse from.
* @param browseOptions the {@link BrowseOptions} to use.
* @return a List of {@link UaNode}s referenced by {@code node} given {@code browseOptions}.
* @throws UaException if an error occurs while browsing or creating Nodes.
*/
public List<? extends UaNode> browseNodes(UaNode node, BrowseOptions browseOptions) throws UaException {
try {
return browseNodesAsync(node, browseOptions).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Browse from {@code nodeId} using the currently configured {@link BrowseOptions}.
*
* @param nodeId the {@link NodeId} to start the browse from.
* @return a List of {@link UaNode}s referenced by {@code nodeId} given the currently configured
* {@link BrowseOptions}.
* @throws UaException if an error occurs while browsing or creating Nodes.
* @see #browseNodes(UaNode, BrowseOptions)
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public List<? extends UaNode> browseNodes(NodeId nodeId) throws UaException {
return browseNodes(nodeId, getBrowseOptions());
}
/**
* Browse from {@code nodeId} using {@code browseOptions}.
*
* @param nodeId the {@link NodeId} to start the browse from.
* @param browseOptions the {@link BrowseOptions} to use.
* @return a List of {@link UaNode}s referenced by {@code nodeId} given {@code browseOptions}.
* @throws UaException if an error occurs while browsing or creating Nodes.
*/
public List<? extends UaNode> browseNodes(NodeId nodeId, BrowseOptions browseOptions) throws UaException {
try {
return browseNodesAsync(nodeId, browseOptions).get();
} catch (ExecutionException | InterruptedException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Browse from {@code node} using the currently configured {@link BrowseOptions}.
* <p>
* This call completes asynchronously.
*
* @param node the {@link UaNode} to start the browse from.
* @return a CompletableFuture that completes successfully with a List of {@link UaNode}s
* referenced by {@code node} given the currently configured {@link BrowseOptions} or completes
* exceptionally if a service-level error occurs.
* @see #browseNodesAsync(UaNode, BrowseOptions)
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public CompletableFuture<List<? extends UaNode>> browseNodesAsync(UaNode node) {
return browseNodesAsync(node.getNodeId());
}
/**
* Browse from {@code node} using {@code browseOptions}.
* <p>
* This call completes asynchronously.
*
* @param node the {@link UaNode} to start the browse from.
* @param browseOptions the {@link BrowseOptions} to use.
* @return a CompletableFuture that completes successfully with a List of {@link UaNode}s
* referenced by {@code node} given the currently configured {@link BrowseOptions} or completes
* exceptionally if a service-level error occurs.
*/
public CompletableFuture<List<? extends UaNode>> browseNodesAsync(UaNode node, BrowseOptions browseOptions) {
return browseNodesAsync(node.getNodeId(), browseOptions);
}
/**
* Browse from {@code nodeId} using the currently configured {@link BrowseOptions}.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} to start the browse from.
* @return a CompletableFuture that completes successfully with a List of {@link UaNode}s
* referenced by {@code node} given the currently configured {@link BrowseOptions} or completes
* exceptionally if a service-level error occurs.
* @see #browseNodesAsync(UaNode, BrowseOptions)
* @see #getBrowseOptions()
* @see #modifyBrowseOptions(Consumer)
* @see #setBrowseOptions(BrowseOptions)
*/
public CompletableFuture<List<? extends UaNode>> browseNodesAsync(NodeId nodeId) {
return browseNodesAsync(nodeId, getBrowseOptions());
}
/**
* Browse from {@code nodeId} using {@code browseOptions}.
* <p>
* This call completes asynchronously.
*
* @param nodeId the {@link NodeId} to start the browse from.
* @param browseOptions the {@link BrowseOptions} to use.
* @return a CompletableFuture that completes successfully with a List of {@link UaNode}s
* referenced by {@code node} given the currently configured {@link BrowseOptions} or completes
* exceptionally if a service-level error occurs.
*/
public CompletableFuture<List<? extends UaNode>> browseNodesAsync(NodeId nodeId, BrowseOptions browseOptions) {
BrowseDescription browseDescription = new BrowseDescription(
nodeId,
browseOptions.getBrowseDirection(),
browseOptions.getReferenceTypeId(),
browseOptions.isIncludeSubtypes(),
browseOptions.getNodeClassMask(),
uint(BrowseResultMask.All.getValue())
);
CompletableFuture<List<ReferenceDescription>> browse = BrowseHelper.browse(client, browseDescription);
return browse.thenCompose(references -> {
List<CompletableFuture<? extends UaNode>> cfs = references.stream()
.map(reference -> {
NodeClass nodeClass = reference.getNodeClass();
ExpandedNodeId xNodeId = reference.getNodeId();
ExpandedNodeId xTypeDefinitionId = reference.getTypeDefinition();
switch (nodeClass) {
case Object:
case Variable: {
CompletableFuture<CompletableFuture<? extends UaNode>> ff =
toNodeIdAsync(xNodeId).thenCombine(
toNodeIdAsync(xTypeDefinitionId),
(targetNodeId, typeDefinitionId) -> {
if (nodeClass == NodeClass.Object) {
return getObjectNodeAsync(targetNodeId, typeDefinitionId);
} else {
return getVariableNodeAsync(targetNodeId, typeDefinitionId);
}
}
);
return unwrap(ff);
}
default: {
// TODO specialized getNode for other NodeClasses?
return toNodeIdAsync(xNodeId).thenCompose(this::getNodeAsync);
}
}
})
.collect(Collectors.toList());
return sequence(cfs);
});
}
private static CompletableFuture<List<? extends UaNode>> sequence(
List<CompletableFuture<? extends UaNode>> cfs
) {
if (cfs.isEmpty()) {
return completedFuture(Collections.emptyList());
}
@SuppressWarnings("rawtypes")
CompletableFuture[] fa = cfs.toArray(new CompletableFuture[0]);
return CompletableFuture.allOf(fa).thenApply(v -> {
List<UaNode> results = new ArrayList<>(cfs.size());
for (CompletableFuture<? extends UaNode> cf : cfs) {
results.add(cf.join());
}
return results;
});
}
private static CompletableFuture<? extends UaNode> unwrap(
CompletableFuture<CompletableFuture<? extends UaNode>> future
) {
return future.thenCompose(node -> node);
}
/**
* Convert {@code xni} to a {@link NodeId} in the server, reading the namespace table from the
* server if necessary.
* <p>
* Returns {@link NodeId#NULL_VALUE} if the conversion could not be completed for any reason.
*
* @param xni the {@link ExpandedNodeId} to convert to a {@link NodeId}.
* @return a {@link NodeId} local to the server, or {@link NodeId#NULL_VALUE} if conversion
* could not be completed for any reason.
*/
public NodeId toNodeId(ExpandedNodeId xni) {
try {
return toNodeIdAsync(xni).get();
} catch (ExecutionException | InterruptedException e) {
return NodeId.NULL_VALUE;
}
}
/**
* Convert {@code xni} to a {@link NodeId} in the server, reading the namespace table from the
* server if necessary.
* <p>
* Returns {@link NodeId#NULL_VALUE} if the conversion could not be completed for any reason.
*
* @param xni the {@link ExpandedNodeId} to convert to a {@link NodeId}.
* @return a {@link NodeId} local to the server, or {@link NodeId#NULL_VALUE} if conversion
* could not be completed for any reason.
*/
public CompletableFuture<NodeId> toNodeIdAsync(ExpandedNodeId xni) {
// TODO should this fail with Bad_NodeIdUnknown instead of returning NodeId.NULL_VALUE?
if (xni.isLocal()) {
Optional<NodeId> local = xni.toNodeId(client.getNamespaceTable());
return local.map(CompletableFuture::completedFuture).orElse(
client.readNamespaceTableAsync()
.thenCompose(
namespaceTable ->
completedFuture(xni.toNodeId(namespaceTable).orElse(NodeId.NULL_VALUE))
)
.exceptionally(e -> NodeId.NULL_VALUE)
);
} else {
return completedFuture(NodeId.NULL_VALUE);
}
}
/**
* Get the default {@link BrowseOptions} used during browse calls that don't have an explicit
* {@link BrowseOptions} parameter.
*
* @return the default {@link BrowseOptions}.
*/
public synchronized BrowseOptions getBrowseOptions() {
return browseOptions;
}
/**
* Modify the default {@link BrowseOptions} used during browse calls that don't have an
* explicit {@link BrowseOptions} parameter.
*
* @param builderConsumer a {@link Consumer} that receives a {@link BrowseOptions.Builder}.
*/
public synchronized void modifyBrowseOptions(Consumer<BrowseOptions.Builder> builderConsumer) {
BrowseOptions.Builder builder = new BrowseOptions.Builder(browseOptions);
builderConsumer.accept(builder);
setBrowseOptions(builder.build());
}
/**
* Set a new default {@link BrowseOptions} used during browse calls that don't have an explicit
* {@link BrowseOptions} parameter.
*
* @param browseOptions the new default {@link BrowseOptions}.
*/
public synchronized void setBrowseOptions(BrowseOptions browseOptions) {
this.browseOptions = browseOptions;
}
/**
* Get the current {@link NodeCache}.
*
* @return the current {@link NodeCache}.
*/
public synchronized NodeCache getNodeCache() {
return nodeCache;
}
/**
* Set a new {@link NodeCache}.
*
* @param nodeCache a new {@link NodeCache}.
*/
public synchronized void setNodeCache(NodeCache nodeCache) {
this.nodeCache = nodeCache;
}
private CompletableFuture<NodeId> readTypeDefinition(NodeId nodeId) {
CompletableFuture<BrowseResult> browseFuture = client.browse(new BrowseDescription(
nodeId,
BrowseDirection.Forward,
Identifiers.HasTypeDefinition,
false,
uint(NodeClass.ObjectType.getValue() | NodeClass.VariableType.getValue()),
uint(BrowseResultMask.All.getValue())
));
return browseFuture.thenCompose(result -> {
if (result.getStatusCode().isGood()) {
Optional<ExpandedNodeId> typeDefinitionId = l(result.getReferences())
.stream()
.filter(r -> Objects.equals(Identifiers.HasTypeDefinition, r.getReferenceTypeId()))
.map(ReferenceDescription::getNodeId)
.findFirst();
return typeDefinitionId.map(this::toNodeIdAsync)
.orElse(completedFuture(NodeId.NULL_VALUE));
} else {
return completedFuture(NodeId.NULL_VALUE);
}
});
}
/**
* Create a {@link UaNode} instance without prior knowledge of the {@link NodeClass} or type
* definition, if applicable.
*
* @param nodeId the {@link NodeId} of the Node to create.
* @return a {@link UaNode} instance for the Node identified by {@code nodeId}.
*/
private CompletableFuture<? extends UaNode> createNode(NodeId nodeId) {
CompletableFuture<ReadResponse> future = readAttributes(nodeId, AttributeId.BASE_ATTRIBUTES);
return future.thenCompose(response -> {
List<DataValue> results = l(response.getResults());
return createNodeFromBaseAttributes(nodeId, results);
});
}
private CompletableFuture<? extends UaNode> createNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Integer nodeClassValue = (Integer) baseAttributeValues.get(1).getValue().getValue();
if (nodeClassValue == null) {
return FutureUtils.failedUaFuture(StatusCodes.Bad_NodeClassInvalid);
}
NodeClass nodeClass = NodeClass.from(nodeClassValue);
if (nodeClass == null) {
return FutureUtils.failedUaFuture(StatusCodes.Bad_NodeClassInvalid);
}
switch (nodeClass) {
case DataType:
return createDataTypeNodeFromBaseAttributes(nodeId, baseAttributeValues);
case Method:
return createMethodNodeFromBaseAttributes(nodeId, baseAttributeValues);
case Object:
return createObjectNodeFromBaseAttributes(nodeId, baseAttributeValues);
case ObjectType:
return createObjectTypeNodeFromBaseAttributes(nodeId, baseAttributeValues);
case ReferenceType:
return createReferenceTypeNodeFromBaseAttributes(nodeId, baseAttributeValues);
case Variable:
return createVariableNodeFromBaseAttributes(nodeId, baseAttributeValues);
case VariableType:
return createVariableTypeNodeFromBaseAttributes(nodeId, baseAttributeValues);
case View:
return createViewNodeFromBaseAttributes(nodeId, baseAttributeValues);
default:
throw new IllegalArgumentException("NodeClass: " + nodeClass);
}
}
private CompletableFuture<UaDataTypeNode> createDataTypeNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Set<AttributeId> remainingAttributes = Sets.difference(
AttributeId.DATA_TYPE_ATTRIBUTES,
AttributeId.BASE_ATTRIBUTES
);
CompletableFuture<ReadResponse> attributesFuture = readAttributes(nodeId, remainingAttributes);
return attributesFuture.thenApply(response -> {
List<DataValue> attributeValues = new ArrayList<>(baseAttributeValues);
Collections.addAll(attributeValues, response.getResults());
UaDataTypeNode node = newDataTypeNode(nodeId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
private CompletableFuture<UaMethodNode> createMethodNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Set<AttributeId> remainingAttributes = Sets.difference(
AttributeId.METHOD_ATTRIBUTES,
AttributeId.BASE_ATTRIBUTES
);
CompletableFuture<ReadResponse> attributesFuture = readAttributes(nodeId, remainingAttributes);
return attributesFuture.thenApply(response -> {
List<DataValue> attributeValues = new ArrayList<>(baseAttributeValues);
Collections.addAll(attributeValues, response.getResults());
UaMethodNode node = newMethodNode(nodeId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
private CompletableFuture<UaObjectNode> createObjectNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Set<AttributeId> remainingAttributes = Sets.difference(
AttributeId.OBJECT_ATTRIBUTES,
AttributeId.BASE_ATTRIBUTES
);
CompletableFuture<ReadResponse> attributesFuture = readAttributes(nodeId, remainingAttributes);
CompletableFuture<NodeId> typeDefinitionFuture = readTypeDefinition(nodeId);
return attributesFuture.thenCombine(typeDefinitionFuture, (response, typeDefinitionId) -> {
List<DataValue> attributeValues = new ArrayList<>(baseAttributeValues);
Collections.addAll(attributeValues, response.getResults());
UaObjectNode node = newObjectNode(nodeId, typeDefinitionId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
private CompletableFuture<UaObjectTypeNode> createObjectTypeNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Set<AttributeId> remainingAttributes = Sets.difference(
AttributeId.OBJECT_TYPE_ATTRIBUTES,
AttributeId.BASE_ATTRIBUTES
);
CompletableFuture<ReadResponse> attributesFuture = readAttributes(nodeId, remainingAttributes);
return attributesFuture.thenApply(response -> {
List<DataValue> attributeValues = new ArrayList<>(baseAttributeValues);
Collections.addAll(attributeValues, response.getResults());
UaObjectTypeNode node = newObjectTypeNode(nodeId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
private CompletableFuture<UaReferenceTypeNode> createReferenceTypeNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Set<AttributeId> remainingAttributes = Sets.difference(
AttributeId.REFERENCE_TYPE_ATTRIBUTES,
AttributeId.BASE_ATTRIBUTES
);
CompletableFuture<ReadResponse> attributesFuture = readAttributes(nodeId, remainingAttributes);
return attributesFuture.thenApply(response -> {
List<DataValue> attributeValues = new ArrayList<>(baseAttributeValues);
Collections.addAll(attributeValues, response.getResults());
UaReferenceTypeNode node = newReferenceTypeNode(nodeId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
private CompletableFuture<UaVariableNode> createVariableNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Set<AttributeId> remainingAttributes = Sets.difference(
AttributeId.VARIABLE_ATTRIBUTES,
AttributeId.BASE_ATTRIBUTES
);
CompletableFuture<ReadResponse> attributesFuture = readAttributes(nodeId, remainingAttributes);
CompletableFuture<NodeId> typeDefinitionFuture = readTypeDefinition(nodeId);
return attributesFuture.thenCombine(typeDefinitionFuture, (response, typeDefinitionId) -> {
List<DataValue> attributeValues = new ArrayList<>(baseAttributeValues);
Collections.addAll(attributeValues, response.getResults());
UaVariableNode node = newVariableNode(nodeId, typeDefinitionId, attributeValues);
nodeCache.put(node.getNodeId(), node);
return node;
});
}
private CompletableFuture<UaVariableTypeNode> createVariableTypeNodeFromBaseAttributes(
NodeId nodeId,
List<DataValue> baseAttributeValues
) {
Set<AttributeId> remainingAttributes = Sets.difference(
AttributeId.VARIABLE_TYPE_ATTRIBUTES,
AttributeId.BASE_ATTRIBUTES
);
CompletableFuture<ReadResponse> attributesFuture = readAttributes(nodeId, remainingAttributes);
return attributesFuture.thenApply(response -> {
List<DataValue> attributeValues = new ArrayList<>(baseAttributeValues);
Collections.addAll(attributeValues, response.getResults());