-
Notifications
You must be signed in to change notification settings - Fork 420
/
OpcUaClient.java
973 lines (829 loc) · 39.8 KB
/
OpcUaClient.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
/*
* 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.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.function.Function;
import java.util.function.Predicate;
import org.eclipse.milo.opcua.sdk.client.api.ServiceFaultListener;
import org.eclipse.milo.opcua.sdk.client.api.UaClient;
import org.eclipse.milo.opcua.sdk.client.api.config.OpcUaClientConfig;
import org.eclipse.milo.opcua.sdk.client.api.config.OpcUaClientConfigBuilder;
import org.eclipse.milo.opcua.sdk.client.model.ObjectTypeInitializer;
import org.eclipse.milo.opcua.sdk.client.model.VariableTypeInitializer;
import org.eclipse.milo.opcua.sdk.client.session.SessionFsm;
import org.eclipse.milo.opcua.sdk.client.session.SessionFsmFactory;
import org.eclipse.milo.opcua.sdk.client.subscriptions.OpcUaSubscriptionManager;
import org.eclipse.milo.opcua.stack.client.DiscoveryClient;
import org.eclipse.milo.opcua.stack.client.UaStackClient;
import org.eclipse.milo.opcua.stack.core.AttributeId;
import org.eclipse.milo.opcua.stack.core.Identifiers;
import org.eclipse.milo.opcua.stack.core.NamespaceTable;
import org.eclipse.milo.opcua.stack.core.Stack;
import org.eclipse.milo.opcua.stack.core.StatusCodes;
import org.eclipse.milo.opcua.stack.core.UaException;
import org.eclipse.milo.opcua.stack.core.UaServiceFaultException;
import org.eclipse.milo.opcua.stack.core.security.SecurityPolicy;
import org.eclipse.milo.opcua.stack.core.serialization.SerializationContext;
import org.eclipse.milo.opcua.stack.core.serialization.UaRequestMessage;
import org.eclipse.milo.opcua.stack.core.serialization.UaResponseMessage;
import org.eclipse.milo.opcua.stack.core.types.DataTypeManager;
import org.eclipse.milo.opcua.stack.core.types.builtin.ByteString;
import org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject;
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.unsigned.UByte;
import org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger;
import org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort;
import org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode;
import org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn;
import org.eclipse.milo.opcua.stack.core.types.enumerated.UserTokenType;
import org.eclipse.milo.opcua.stack.core.types.structured.AddNodesItem;
import org.eclipse.milo.opcua.stack.core.types.structured.AddNodesRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.AddNodesResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesItem;
import org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowseRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.BrowseResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.CallMethodRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.CallRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.CallResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesItem;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesItem;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription;
import org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadDetails;
import org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadValueId;
import org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails;
import org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.PublishRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.ReadRequest;
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.RegisterNodesRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.RepublishRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.RepublishResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader;
import org.eclipse.milo.opcua.stack.core.types.structured.ServiceFault;
import org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement;
import org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription;
import org.eclipse.milo.opcua.stack.core.types.structured.WriteRequest;
import org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse;
import org.eclipse.milo.opcua.stack.core.types.structured.WriteValue;
import org.eclipse.milo.opcua.stack.core.util.ExecutionQueue;
import org.eclipse.milo.opcua.stack.core.util.ManifestUtil;
import org.eclipse.milo.opcua.stack.core.util.Namespaces;
import org.eclipse.milo.opcua.stack.core.util.Unit;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static com.google.common.collect.Lists.newCopyOnWriteArrayList;
import static org.eclipse.milo.opcua.sdk.client.session.SessionFsm.SessionInitializer;
import static org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.Unsigned.ushort;
import static org.eclipse.milo.opcua.stack.core.util.ConversionUtil.a;
public class OpcUaClient implements UaClient {
public static final String SDK_VERSION =
ManifestUtil.read("X-SDK-Version").orElse("dev");
static {
Logger logger = LoggerFactory.getLogger(OpcUaClient.class);
logger.info("Java version: " + System.getProperty("java.version"));
logger.info("Eclipse Milo OPC UA Stack version: {}", Stack.VERSION);
logger.info("Eclipse Milo OPC UA Client SDK version: {}", SDK_VERSION);
}
/**
* Create an {@link OpcUaClient} configured with {@code config}.
*
* @param config the {@link OpcUaClientConfig}.
* @return an {@link OpcUaClient} configured with {@code config}.
* @throws UaException if the client could not be created (e.g. transport/encoding not supported).
*/
public static OpcUaClient create(OpcUaClientConfig config) throws UaException {
UaStackClient stackClient = UaStackClient.create(config);
return new OpcUaClient(config, stackClient);
}
/**
* Select the first endpoint with no security that allows anonymous connections and create an
* {@link OpcUaClient} with the default configuration.
* <p>
* If the server is not configured with an endpoint with no security or authentication you
* must use {@link #create(String, Function, Function)} to select an endpoint and configure
* any certificates or identity provider that the selected endpoint would require.
*
* @param endpointUrl the endpoint URL of the server to connect to and get endpoints from.
* @return an {@link OpcUaClient} configured to connect to the server identified by
* {@code endpointUrl}.
* @throws UaException if the endpoints could not be retrieved or the client could not be
* created.
*/
public static OpcUaClient create(String endpointUrl) throws UaException {
// select the first EndpointDescription with no security and anonymous authentication
Predicate<EndpointDescription> predicate = e ->
SecurityPolicy.None.getUri().equals(e.getSecurityPolicyUri()) &&
Arrays.stream(e.getUserIdentityTokens())
.anyMatch(p -> p.getTokenType() == UserTokenType.Anonymous);
return create(
endpointUrl,
endpoints -> endpoints.stream()
.filter(predicate)
.findFirst(),
OpcUaClientConfigBuilder::build
);
}
/**
* Create and configure an {@link OpcUaClient} by selecting an {@link EndpointDescription} from a list of endpoints
* retrieved via the GetEndpoints service from the server at {@code endpointUrl} and building an
* {@link OpcUaClientConfig} using that endpoint.
*
* @param endpointUrl the endpoint URL of the server to connect to and retrieve endpoints from.
* @param selectEndpoint a function that selects the {@link EndpointDescription} to connect to from the list of
* endpoints from the server.
* @param buildConfig a function that configures an {@link OpcUaClientConfigBuilder} and then builds and returns
* an {@link OpcUaClientConfig}.
* @return a configured {@link OpcUaClient}.
* @throws UaException if the endpoints could not be retrieved or the client could not be created.
*/
public static OpcUaClient create(
String endpointUrl,
Function<List<EndpointDescription>, Optional<EndpointDescription>> selectEndpoint,
Function<OpcUaClientConfigBuilder, OpcUaClientConfig> buildConfig
) throws UaException {
try {
List<EndpointDescription> endpoints =
DiscoveryClient.getEndpoints(endpointUrl).get();
EndpointDescription endpoint = selectEndpoint.apply(endpoints).orElseThrow(() ->
new UaException(
StatusCodes.Bad_ConfigurationError,
"no endpoint selected"
)
);
OpcUaClientConfigBuilder builder = OpcUaClientConfig.builder()
.setEndpoint(endpoint);
return create(buildConfig.apply(builder));
} catch (InterruptedException | ExecutionException e) {
if (!endpointUrl.endsWith("/discovery")) {
StringBuilder discoveryUrl = new StringBuilder(endpointUrl);
if (!endpointUrl.endsWith("/")) {
discoveryUrl.append("/");
}
discoveryUrl.append("discovery");
return create(discoveryUrl.toString(), selectEndpoint, buildConfig);
} else {
throw UaException.extract(e)
.orElseGet(() -> new UaException(e));
}
}
}
private final Logger logger = LoggerFactory.getLogger(getClass());
private final List<ServiceFaultListener> faultListeners = newCopyOnWriteArrayList();
private final ExecutionQueue faultNotificationQueue;
private final AddressSpace addressSpace;
private final ObjectTypeManager objectTypeManager = new ObjectTypeManager();
private final VariableTypeManager variableTypeManager = new VariableTypeManager();
private final OpcUaSubscriptionManager subscriptionManager;
private final SessionFsm sessionFsm;
private final OpcUaClientConfig config;
private final UaStackClient stackClient;
public OpcUaClient(OpcUaClientConfig config, UaStackClient stackClient) {
this.config = config;
this.stackClient = stackClient;
sessionFsm = SessionFsmFactory.newSessionFsm(this);
sessionFsm.addInitializer((client, session) -> {
logger.debug("SessionInitializer: NamespaceTable");
RequestHeader requestHeader = newRequestHeader(session.getAuthenticationToken());
ReadRequest readRequest = new ReadRequest(
requestHeader,
0.0,
TimestampsToReturn.Neither,
new ReadValueId[]{
new ReadValueId(
Identifiers.Server_NamespaceArray,
AttributeId.Value.uid(),
null,
QualifiedName.NULL_VALUE)
}
);
return client.sendRequest(readRequest)
.thenApply(ReadResponse.class::cast)
.thenApply(response -> Objects.requireNonNull(response.getResults()))
.thenApply(results -> (String[]) results[0].getValue().getValue())
.thenAccept(this::updateNamespaceTable)
.thenApply(v -> Unit.VALUE)
.exceptionally(ex -> {
logger.warn("SessionInitializer: NamespaceTable", ex);
return Unit.VALUE;
});
});
faultNotificationQueue = new ExecutionQueue(config.getExecutor());
addressSpace = new AddressSpace(this);
subscriptionManager = new OpcUaSubscriptionManager(this);
ObjectTypeInitializer.initialize(
stackClient.getNamespaceTable(),
objectTypeManager
);
VariableTypeInitializer.initialize(
stackClient.getNamespaceTable(),
variableTypeManager
);
}
@Override
public OpcUaClientConfig getConfig() {
return config;
}
public UaStackClient getStackClient() {
return stackClient;
}
@Override
public AddressSpace getAddressSpace() {
return addressSpace;
}
public ObjectTypeManager getObjectTypeManager() {
return objectTypeManager;
}
public VariableTypeManager getVariableTypeManager() {
return variableTypeManager;
}
/**
* @see UaStackClient#getStaticDataTypeManager()
*/
public DataTypeManager getStaticDataTypeManager() {
return stackClient.getStaticDataTypeManager();
}
/**
* @see UaStackClient#getDynamicDataTypeManager()
*/
public DataTypeManager getDynamicDataTypeManager() {
return stackClient.getDynamicDataTypeManager();
}
/**
* @see UaStackClient#getStaticSerializationContext()
*/
public SerializationContext getStaticSerializationContext() {
return stackClient.getStaticSerializationContext();
}
/**
* @see UaStackClient#getDynamicSerializationContext()
*/
public SerializationContext getDynamicSerializationContext() {
return stackClient.getDynamicSerializationContext();
}
/**
* Get the local copy of the server's NamespaceTable.
*
* @return the current local value for server's NamespaceTable.
*/
public NamespaceTable getNamespaceTable() {
return stackClient.getNamespaceTable();
}
/**
* Read the server's NamespaceTable and update the local copy.
*
* @return the updated {@link NamespaceTable}.
* @throws UaException if an operation- or service-level error occurs.
*/
public NamespaceTable readNamespaceTable() throws UaException {
try {
return readNamespaceTableAsync().get();
} catch (InterruptedException | ExecutionException e) {
throw UaException.extract(e)
.orElse(new UaException(StatusCodes.Bad_UnexpectedError, e));
}
}
/**
* Read the server's NamespaceTable and update the local copy.
* <p>
* This call completes asynchronously.
*
* @return a {@link CompletableFuture} that completes successfully with the updated
* {@link NamespaceTable} or completes exceptionally if a service- or operation-level error
* occurs.
*/
public CompletableFuture<NamespaceTable> readNamespaceTableAsync() {
return getSession().thenCompose(session -> {
RequestHeader requestHeader = newRequestHeader(session.getAuthenticationToken());
ReadRequest readRequest = new ReadRequest(
requestHeader,
0.0,
TimestampsToReturn.Neither,
new ReadValueId[]{
new ReadValueId(
Identifiers.Server_NamespaceArray,
AttributeId.Value.uid(),
null,
QualifiedName.NULL_VALUE)
}
);
CompletableFuture<String[]> namespaceArray = sendRequest(readRequest)
.thenApply(ReadResponse.class::cast)
.thenApply(response -> Objects.requireNonNull(response.getResults()))
.thenApply(results -> (String[]) results[0].getValue().getValue());
return namespaceArray
.thenAccept(this::updateNamespaceTable)
.thenApply(v -> getNamespaceTable());
});
}
private void updateNamespaceTable(String[] namespaceArray) {
getNamespaceTable().update(uriTable -> {
uriTable.clear();
uriTable.put(ushort(0), Namespaces.OPC_UA);
if (namespaceArray.length > UShort.MAX_VALUE) {
logger.warn("NamespaceTable returned by " +
"server contains " + namespaceArray.length + " entries");
}
for (int i = 1; i < namespaceArray.length && i < UShort.MAX_VALUE; i++) {
String uri = namespaceArray[i];
if (uri != null && !uriTable.containsValue(uri)) {
uriTable.put(ushort(i), uri);
}
}
});
}
/**
* Build a new {@link RequestHeader} using a null authentication token.
*
* @return a new {@link RequestHeader} with a null authentication token.
*/
public RequestHeader newRequestHeader() {
return newRequestHeader(NodeId.NULL_VALUE, config.getRequestTimeout());
}
/**
* Build a new {@link RequestHeader} using {@code authToken}.
*
* @param authToken the authentication token (from the session) to use.
* @return a new {@link RequestHeader}.
*/
public RequestHeader newRequestHeader(NodeId authToken) {
return newRequestHeader(authToken, config.getRequestTimeout());
}
/**
* Build a new {@link RequestHeader} using a null authentication token and a custom {@code requestTimeout}.
*
* @param requestTimeout the custom request timeout to use.
* @return a new {@link RequestHeader} with a null authentication token and a custom request timeout.
*/
public RequestHeader newRequestHeader(UInteger requestTimeout) {
return newRequestHeader(NodeId.NULL_VALUE, requestTimeout);
}
/**
* Build a new {@link RequestHeader} using {@code authToken} and a custom {@code requestTimeout}.
*
* @param authToken the authentication token (from the session) to use.
* @param requestTimeout the custom request timeout to use.
* @return a new {@link RequestHeader}.
*/
public RequestHeader newRequestHeader(NodeId authToken, UInteger requestTimeout) {
return getStackClient().newRequestHeader(authToken, requestTimeout);
}
@Override
public CompletableFuture<UaClient> connect() {
return getStackClient()
.connect()
.thenCompose(c -> sessionFsm.openSession())
.thenApply(s -> OpcUaClient.this);
}
@Override
public CompletableFuture<OpcUaClient> disconnect() {
return sessionFsm
.closeSession()
.exceptionally(ex -> Unit.VALUE)
.thenCompose(u ->
getStackClient()
.disconnect()
.thenApply(c -> OpcUaClient.this))
.exceptionally(ex -> OpcUaClient.this);
}
@Override
public OpcUaSubscriptionManager getSubscriptionManager() {
return subscriptionManager;
}
@Override
public CompletableFuture<ReadResponse> read(double maxAge,
TimestampsToReturn timestampsToReturn,
List<ReadValueId> readValueIds) {
return getSession().thenCompose(session -> {
ReadRequest request = new ReadRequest(
newRequestHeader(session.getAuthenticationToken()),
maxAge,
timestampsToReturn,
a(readValueIds, ReadValueId.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<WriteResponse> write(List<WriteValue> writeValues) {
return getSession().thenCompose(session -> {
WriteRequest request = new WriteRequest(
newRequestHeader(session.getAuthenticationToken()),
a(writeValues, WriteValue.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<HistoryReadResponse> historyRead(HistoryReadDetails historyReadDetails,
TimestampsToReturn timestampsToReturn,
boolean releaseContinuationPoints,
List<HistoryReadValueId> nodesToRead) {
return getSession().thenCompose(session -> {
HistoryReadRequest request = new HistoryReadRequest(
newRequestHeader(session.getAuthenticationToken()),
ExtensionObject.encode(getStaticSerializationContext(), historyReadDetails),
timestampsToReturn,
releaseContinuationPoints,
a(nodesToRead, HistoryReadValueId.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<HistoryUpdateResponse> historyUpdate(List<HistoryUpdateDetails> historyUpdateDetails) {
return getSession().thenCompose(session -> {
ExtensionObject[] details = historyUpdateDetails.stream()
.map(hud -> ExtensionObject.encode(getStaticSerializationContext(), hud))
.toArray(ExtensionObject[]::new);
HistoryUpdateRequest request = new HistoryUpdateRequest(
newRequestHeader(session.getAuthenticationToken()),
details
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<BrowseResponse> browse(ViewDescription viewDescription,
UInteger maxReferencesPerNode,
List<BrowseDescription> nodesToBrowse) {
return getSession().thenCompose(session -> {
BrowseRequest request = new BrowseRequest(
newRequestHeader(session.getAuthenticationToken()),
viewDescription,
maxReferencesPerNode,
a(nodesToBrowse, BrowseDescription.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<BrowseNextResponse> browseNext(boolean releaseContinuationPoints,
List<ByteString> continuationPoints) {
return getSession().thenCompose(session -> {
BrowseNextRequest request = new BrowseNextRequest(
newRequestHeader(session.getAuthenticationToken()),
releaseContinuationPoints,
a(continuationPoints, ByteString.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<TranslateBrowsePathsToNodeIdsResponse> translateBrowsePaths(List<BrowsePath> browsePaths) {
return getSession().thenCompose(session -> {
TranslateBrowsePathsToNodeIdsRequest request = new TranslateBrowsePathsToNodeIdsRequest(
newRequestHeader(session.getAuthenticationToken()),
a(browsePaths, BrowsePath.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<RegisterNodesResponse> registerNodes(List<NodeId> nodesToRegister) {
return getSession().thenCompose(session -> {
RegisterNodesRequest request = new RegisterNodesRequest(
newRequestHeader(session.getAuthenticationToken()),
a(nodesToRegister, NodeId.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<UnregisterNodesResponse> unregisterNodes(List<NodeId> nodesToUnregister) {
return getSession().thenCompose(session -> {
UnregisterNodesRequest request = new UnregisterNodesRequest(
newRequestHeader(session.getAuthenticationToken()),
a(nodesToUnregister, NodeId.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<CallResponse> call(List<CallMethodRequest> methodsToCall) {
return getSession().thenCompose(session -> {
CallRequest request = new CallRequest(
newRequestHeader(session.getAuthenticationToken()),
a(methodsToCall, CallMethodRequest.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<CreateSubscriptionResponse> createSubscription(
double requestedPublishingInterval,
UInteger requestedLifetimeCount,
UInteger requestedMaxKeepAliveCount,
UInteger maxNotificationsPerPublish,
boolean publishingEnabled,
UByte priority) {
return getSession().thenCompose(session -> {
CreateSubscriptionRequest request = new CreateSubscriptionRequest(
newRequestHeader(session.getAuthenticationToken()),
requestedPublishingInterval,
requestedLifetimeCount,
requestedMaxKeepAliveCount,
maxNotificationsPerPublish,
publishingEnabled,
priority
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<ModifySubscriptionResponse> modifySubscription(
UInteger subscriptionId,
double requestedPublishingInterval,
UInteger requestedLifetimeCount,
UInteger requestedMaxKeepAliveCount,
UInteger maxNotificationsPerPublish,
UByte priority) {
return getSession().thenCompose(session -> {
ModifySubscriptionRequest request = new ModifySubscriptionRequest(
newRequestHeader(session.getAuthenticationToken()),
subscriptionId,
requestedPublishingInterval,
requestedLifetimeCount,
requestedMaxKeepAliveCount,
maxNotificationsPerPublish,
priority
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<DeleteSubscriptionsResponse> deleteSubscriptions(List<UInteger> subscriptionIds) {
return getSession().thenCompose(session -> {
DeleteSubscriptionsRequest request = new DeleteSubscriptionsRequest(
newRequestHeader(session.getAuthenticationToken()),
a(subscriptionIds, UInteger.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<TransferSubscriptionsResponse> transferSubscriptions(List<UInteger> subscriptionIds,
boolean sendInitialValues) {
return getSession().thenCompose(session -> {
TransferSubscriptionsRequest request = new TransferSubscriptionsRequest(
newRequestHeader(session.getAuthenticationToken()),
a(subscriptionIds, UInteger.class),
sendInitialValues
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<SetPublishingModeResponse> setPublishingMode(boolean publishingEnabled,
List<UInteger> subscriptionIds) {
return getSession().thenCompose(session -> {
SetPublishingModeRequest request = new SetPublishingModeRequest(
newRequestHeader(session.getAuthenticationToken()),
publishingEnabled,
a(subscriptionIds, UInteger.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<PublishResponse> publish(List<SubscriptionAcknowledgement> subscriptionAcknowledgements) {
return getSession().thenCompose(session -> {
PublishRequest request = new PublishRequest(
newRequestHeader(session.getAuthenticationToken()),
a(subscriptionAcknowledgements, SubscriptionAcknowledgement.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<RepublishResponse> republish(UInteger subscriptionId, UInteger retransmitSequenceNumber) {
return getSession().thenCompose(session -> {
RepublishRequest request = new RepublishRequest(
newRequestHeader(session.getAuthenticationToken()),
subscriptionId,
retransmitSequenceNumber
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<CreateMonitoredItemsResponse> createMonitoredItems(
UInteger subscriptionId,
TimestampsToReturn timestampsToReturn,
List<MonitoredItemCreateRequest> itemsToCreate) {
return getSession().thenCompose(session -> {
CreateMonitoredItemsRequest request = new CreateMonitoredItemsRequest(
newRequestHeader(session.getAuthenticationToken()),
subscriptionId,
timestampsToReturn,
a(itemsToCreate, MonitoredItemCreateRequest.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<ModifyMonitoredItemsResponse> modifyMonitoredItems(
UInteger subscriptionId,
TimestampsToReturn timestampsToReturn,
List<MonitoredItemModifyRequest> itemsToModify) {
return getSession().thenCompose(session -> {
ModifyMonitoredItemsRequest request = new ModifyMonitoredItemsRequest(
newRequestHeader(session.getAuthenticationToken()),
subscriptionId,
timestampsToReturn,
a(itemsToModify, MonitoredItemModifyRequest.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<DeleteMonitoredItemsResponse> deleteMonitoredItems(UInteger subscriptionId,
List<UInteger> monitoredItemIds) {
return getSession().thenCompose(session -> {
DeleteMonitoredItemsRequest request = new DeleteMonitoredItemsRequest(
newRequestHeader(session.getAuthenticationToken()),
subscriptionId,
a(monitoredItemIds, UInteger.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<SetMonitoringModeResponse> setMonitoringMode(UInteger subscriptionId,
MonitoringMode monitoringMode,
List<UInteger> monitoredItemIds) {
return getSession().thenCompose(session -> {
SetMonitoringModeRequest request = new SetMonitoringModeRequest(
newRequestHeader(session.getAuthenticationToken()),
subscriptionId,
monitoringMode,
a(monitoredItemIds, UInteger.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<SetTriggeringResponse> setTriggering(UInteger subscriptionId,
UInteger triggeringItemId,
List<UInteger> linksToAdd,
List<UInteger> linksToRemove) {
return getSession().thenCompose(session -> {
SetTriggeringRequest request = new SetTriggeringRequest(
newRequestHeader(session.getAuthenticationToken()),
subscriptionId,
triggeringItemId,
a(linksToAdd, UInteger.class),
a(linksToRemove, UInteger.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<AddNodesResponse> addNodes(List<AddNodesItem> nodesToAdd) {
return getSession().thenCompose(session -> {
AddNodesRequest request = new AddNodesRequest(
newRequestHeader(session.getAuthenticationToken()),
a(nodesToAdd, AddNodesItem.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<AddReferencesResponse> addReferences(List<AddReferencesItem> referencesToAdd) {
return getSession().thenCompose(session -> {
AddReferencesRequest request = new AddReferencesRequest(
newRequestHeader(session.getAuthenticationToken()),
a(referencesToAdd, AddReferencesItem.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<DeleteNodesResponse> deleteNodes(List<DeleteNodesItem> nodesToDelete) {
return getSession().thenCompose(session -> {
DeleteNodesRequest request = new DeleteNodesRequest(
newRequestHeader(session.getAuthenticationToken()),
a(nodesToDelete, DeleteNodesItem.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<DeleteReferencesResponse> deleteReferences(List<DeleteReferencesItem> referencesToDelete) {
return getSession().thenCompose(session -> {
DeleteReferencesRequest request = new DeleteReferencesRequest(
newRequestHeader(session.getAuthenticationToken()),
a(referencesToDelete, DeleteReferencesItem.class)
);
return sendRequest(request);
});
}
@Override
public CompletableFuture<OpcUaSession> getSession() {
return sessionFsm.getSession();
}
@Override
public <T extends UaResponseMessage> CompletableFuture<T> sendRequest(UaRequestMessage request) {
CompletableFuture<UaResponseMessage> f = getStackClient().sendRequest(request);
if (faultListeners.size() > 0) {
f.whenComplete(this::maybeHandleServiceFault);
}
return f.thenApply(r -> (T) r);
}
private void maybeHandleServiceFault(UaResponseMessage response, Throwable ex) {
if (faultListeners.isEmpty()) return;
if (ex != null) {
if (ex instanceof UaServiceFaultException) {
UaServiceFaultException faultException = (UaServiceFaultException) ex;
ServiceFault serviceFault = faultException.getServiceFault();
logger.debug("Notifying {} ServiceFaultListeners", faultListeners.size());
faultNotificationQueue.submit(() ->
faultListeners.forEach(h -> h.onServiceFault(serviceFault)));
} else if (ex.getCause() instanceof UaServiceFaultException) {
UaServiceFaultException faultException = (UaServiceFaultException) ex.getCause();
ServiceFault serviceFault = faultException.getServiceFault();
logger.debug("Notifying {} ServiceFaultListeners", faultListeners.size());
faultNotificationQueue.submit(() ->
faultListeners.forEach(h -> h.onServiceFault(serviceFault)));
}
}
}
public void addFaultListener(ServiceFaultListener faultListener) {
faultListeners.add(faultListener);
logger.debug("Added ServiceFaultListener: {}", faultListener);
}
public void removeFaultListener(ServiceFaultListener faultListener) {
faultListeners.remove(faultListener);
logger.debug("Removed ServiceFaultListener: {}", faultListener);
}
public void addSessionActivityListener(SessionActivityListener listener) {
sessionFsm.addActivityListener(listener);
logger.debug("Added SessionActivityListener: {}", listener);
}
public void removeSessionActivityListener(SessionActivityListener listener) {
sessionFsm.removeActivityListener(listener);
logger.debug("Removed SessionActivityListener: {}", listener);
}
public void addSessionInitializer(SessionInitializer initializer) {
sessionFsm.addInitializer(initializer);
logger.debug("Added SessionInitializer: {}", initializer);
}
public void removeSessionInitializer(SessionInitializer initializer) {
sessionFsm.removeInitializer(initializer);
logger.debug("Removed SessionInitializer: {}", initializer);
}
}