This class differs from {@link AddressSpaceComposite} in how it routes operations to address
+ * spaces:
+ *
+ *
Consider a scenario where the composite manages devices, each represented by an {@link
+ * AddressSpaceFragment}. Nodes use String-based identifiers with a device prefix syntax like {@code
+ * "[device]Foo.Bar.Baz"}:
+ *
+ *
getAddressSpaces();
+
+ /**
+ * Returns the {@link AddressSpaceFragment} responsible for the given {@link NodeId}, if one
+ * exists.
+ *
+ * If no address space is responsible for the given {@link NodeId}, return {@link
+ * Optional#empty()}.
+ *
+ * @param nodeId the {@link NodeId} to find the responsible address space for.
+ * @return an {@link Optional} containing the responsible {@link AddressSpaceFragment}, or empty
+ * if none exists.
+ */
+ protected abstract Optional getAddressSpace(NodeId nodeId);
+
+ private AddressSpaceFragment getAddressSpaceInternal(NodeId nodeId) {
+ return getAddressSpace(nodeId).orElse(new EmptyAddressSpaceFragment(server));
+ }
+
+ // region ViewServices
+
+ @Override
+ public List browse(
+ BrowseContext context, ViewDescription view, List nodeIds) {
+
+ List initialResults =
+ groupMapCollate(
+ nodeIds,
+ this::getAddressSpaceInternal,
+ (AddressSpace asx) ->
+ group -> {
+ var ctx = new BrowseContext(server, context.getSession().orElse(null));
+
+ return asx.browse(ctx, view, group);
+ });
+
+ final var finalResults = new ArrayList();
+
+ for (int i = 0; i < initialResults.size(); i++) {
+ NodeId nodeId = nodeIds.get(i);
+ ReferenceResult initialResult = initialResults.get(i);
+
+ if (initialResult instanceof ReferenceList rl) {
+ final var references = new LinkedHashSet<>(rl.references());
+
+ // Gather additional references from all AddressSpaces except
+ // the "primary", which is the one we called browse on above.
+
+ var browseContext = new BrowseContext(server, context.getSession().orElse(null));
+
+ AddressSpaceFragment primary = getAddressSpaceInternal(nodeId);
+
+ for (AddressSpace asx : getAddressSpaces()) {
+ if (asx != primary) {
+ ReferenceList gatherResult = asx.gather(browseContext, view, nodeId);
+
+ references.addAll(gatherResult.references());
+ }
+ }
+
+ finalResults.add(ReferenceResult.of(new ArrayList<>(references)));
+ } else {
+ finalResults.add(initialResult);
+ }
+ }
+
+ return finalResults;
+ }
+
+ @Override
+ public ReferenceList gather(BrowseContext context, ViewDescription view, NodeId nodeId) {
+ var referenceStreams = new ArrayList>();
+
+ for (AddressSpace asx : getAddressSpaces()) {
+ var browseContext = new BrowseContext(server, context.getSession().orElse(null));
+
+ ReferenceList result = asx.gather(browseContext, view, nodeId);
+ referenceStreams.add(result.references().stream());
+ }
+
+ List references =
+ referenceStreams.stream().flatMap(Function.identity()).distinct().toList();
+
+ return ReferenceResult.of(references);
+ }
+
+ @Override
+ public List registerNodes(RegisterNodesContext context, List nodeIds) {
+ return groupMapCollate(
+ nodeIds,
+ this::getAddressSpaceInternal,
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new RegisterNodesContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.registerNodes(ctx, group);
+ });
+ }
+
+ @Override
+ public void unregisterNodes(UnregisterNodesContext context, List nodeIds) {
+ groupMapCollate(
+ nodeIds,
+ this::getAddressSpaceInternal,
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new UnregisterNodesContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ asx.unregisterNodes(ctx, group);
+
+ return Collections.nCopies(group.size(), Unit.VALUE);
+ });
+ }
+
+ @Override
+ public UInteger getViewCount() {
+ return getAddressSpaces().stream()
+ .map(AddressSpace::getViewCount)
+ .reduce(uint(0), UInteger::add);
+ }
+
+ // endregion
+
+ // region AttributeServices
+
+ @Override
+ public List read(
+ ReadContext context,
+ Double maxAge,
+ TimestampsToReturn timestamps,
+ List readValueIds) {
+
+ return groupMapCollate(
+ readValueIds,
+ readValueId -> getAddressSpaceInternal(readValueId.getNodeId()),
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new ReadContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.read(ctx, maxAge, timestamps, group);
+ });
+ }
+
+ @Override
+ public List write(WriteContext context, List writeValues) {
+ return groupMapCollate(
+ writeValues,
+ writeValue -> getAddressSpaceInternal(writeValue.getNodeId()),
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new WriteContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.write(ctx, group);
+ });
+ }
+
+ // endregion
+
+ // region AttributeHistoryServices
+
+ @Override
+ public List historyRead(
+ HistoryReadContext context,
+ HistoryReadDetails details,
+ TimestampsToReturn timestamps,
+ List readValueIds) {
+
+ return groupMapCollate(
+ readValueIds,
+ historyReadValueId -> getAddressSpaceInternal(historyReadValueId.getNodeId()),
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new HistoryReadContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.historyRead(ctx, details, timestamps, group);
+ });
+ }
+
+ @Override
+ public List historyUpdate(
+ HistoryUpdateContext context, List updateDetailsList) {
+
+ return groupMapCollate(
+ updateDetailsList,
+ historyUpdateDetails -> {
+ if (historyUpdateDetails instanceof DeleteAtTimeDetails details) {
+ return getAddressSpaceInternal(details.getNodeId());
+ } else if (historyUpdateDetails instanceof DeleteEventDetails details) {
+ return getAddressSpaceInternal(details.getNodeId());
+ } else if (historyUpdateDetails instanceof DeleteRawModifiedDetails details) {
+ return getAddressSpaceInternal(details.getNodeId());
+ } else if (historyUpdateDetails instanceof UpdateDataDetails details) {
+ return getAddressSpaceInternal(details.getNodeId());
+ } else if (historyUpdateDetails instanceof UpdateEventDetails details) {
+ return getAddressSpaceInternal(details.getNodeId());
+ } else if (historyUpdateDetails instanceof UpdateStructureDataDetails details) {
+ return getAddressSpaceInternal(details.getNodeId());
+ } else {
+ throw new IllegalArgumentException(
+ "unexpected HistoryUpdateDetails: " + historyUpdateDetails);
+ }
+ },
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new HistoryUpdateContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.historyUpdate(ctx, group);
+ });
+ }
+
+ // endregion
+
+ // region MethodServices
+
+ @Override
+ public List call(CallContext context, List requests) {
+ return groupMapCollate(
+ requests,
+ callMethodRequest -> getAddressSpaceInternal(callMethodRequest.getObjectId()),
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new CallContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.call(ctx, group);
+ });
+ }
+
+ // endregion
+
+ // region MonitoredItemServices
+
+ @Override
+ public RevisedDataItemParameters onCreateDataItem(
+ ReadValueId itemToMonitor, Double requestedSamplingInterval, UInteger requestedQueueSize) {
+
+ AddressSpace addressSpace = getAddressSpaceInternal(itemToMonitor.getNodeId());
+
+ return addressSpace.onCreateDataItem(
+ itemToMonitor, requestedSamplingInterval, requestedQueueSize);
+ }
+
+ @Override
+ public RevisedDataItemParameters onModifyDataItem(
+ ReadValueId itemToModify, Double requestedSamplingInterval, UInteger requestedQueueSize) {
+
+ AddressSpace addressSpace = getAddressSpaceInternal(itemToModify.getNodeId());
+
+ return addressSpace.onModifyDataItem(
+ itemToModify, requestedSamplingInterval, requestedQueueSize);
+ }
+
+ @Override
+ public RevisedEventItemParameters onCreateEventItem(
+ ReadValueId itemToMonitor, UInteger requestedQueueSize) {
+
+ AddressSpace addressSpace = getAddressSpaceInternal(itemToMonitor.getNodeId());
+
+ return addressSpace.onCreateEventItem(itemToMonitor, requestedQueueSize);
+ }
+
+ @Override
+ public RevisedEventItemParameters onModifyEventItem(
+ ReadValueId itemToModify, UInteger requestedQueueSize) {
+
+ AddressSpace addressSpace = getAddressSpaceInternal(itemToModify.getNodeId());
+
+ return addressSpace.onModifyEventItem(itemToModify, requestedQueueSize);
+ }
+
+ @Override
+ public void onDataItemsCreated(List dataItems) {
+ Map> byAddressSpace =
+ dataItems.stream()
+ .collect(
+ groupingBy(item -> getAddressSpaceInternal(item.getReadValueId().getNodeId())));
+
+ byAddressSpace.forEach(AddressSpace::onDataItemsCreated);
+ }
+
+ @Override
+ public void onDataItemsModified(List dataItems) {
+ Map> byAddressSpace =
+ dataItems.stream()
+ .collect(
+ groupingBy(item -> getAddressSpaceInternal(item.getReadValueId().getNodeId())));
+
+ byAddressSpace.forEach(AddressSpace::onDataItemsModified);
+ }
+
+ @Override
+ public void onDataItemsDeleted(List dataItems) {
+ Map> byAddressSpace =
+ dataItems.stream()
+ .collect(
+ groupingBy(item -> getAddressSpaceInternal(item.getReadValueId().getNodeId())));
+
+ byAddressSpace.forEach(AddressSpace::onDataItemsDeleted);
+ }
+
+ @Override
+ public void onEventItemsCreated(List eventItems) {
+ Map> byAddressSpace =
+ eventItems.stream()
+ .collect(
+ groupingBy(item -> getAddressSpaceInternal(item.getReadValueId().getNodeId())));
+
+ byAddressSpace.forEach(AddressSpace::onEventItemsCreated);
+ }
+
+ @Override
+ public void onEventItemsModified(List eventItems) {
+ Map> byAddressSpace =
+ eventItems.stream()
+ .collect(
+ groupingBy(item -> getAddressSpaceInternal(item.getReadValueId().getNodeId())));
+
+ byAddressSpace.forEach(AddressSpace::onEventItemsModified);
+ }
+
+ @Override
+ public void onEventItemsDeleted(List eventItems) {
+ Map> byAddressSpace =
+ eventItems.stream()
+ .collect(
+ groupingBy(item -> getAddressSpaceInternal(item.getReadValueId().getNodeId())));
+
+ byAddressSpace.forEach(AddressSpace::onEventItemsDeleted);
+ }
+
+ @Override
+ public void onMonitoringModeChanged(List monitoredItems) {
+ Map> byAddressSpace =
+ monitoredItems.stream()
+ .collect(
+ groupingBy(item -> getAddressSpaceInternal(item.getReadValueId().getNodeId())));
+
+ byAddressSpace.forEach(AddressSpace::onMonitoringModeChanged);
+ }
+
+ // endregion
+
+ // region NodeManagementServices
+
+ @Override
+ public List addNodes(AddNodesContext context, List nodesToAdd) {
+ return groupMapCollate(
+ nodesToAdd,
+ addNodesItem -> {
+ NamespaceTable namespaceTable = server.getNamespaceTable();
+
+ ExpandedNodeId requestedNewNodeId = addNodesItem.getRequestedNewNodeId();
+
+ if (requestedNewNodeId.isNotNull()) {
+ return requestedNewNodeId
+ .toNodeId(namespaceTable)
+ .map(this::getAddressSpaceInternal)
+ .orElse(new EmptyAddressSpaceFragment(server));
+ } else {
+ return addNodesItem
+ .getParentNodeId()
+ .toNodeId(namespaceTable)
+ .map(this::getAddressSpaceInternal)
+ .orElse(new EmptyAddressSpaceFragment(server));
+ }
+ },
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new AddNodesContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.addNodes(ctx, group);
+ });
+ }
+
+ @Override
+ public List deleteNodes(
+ DeleteNodesContext context, List nodesToDelete) {
+ return groupMapCollate(
+ nodesToDelete,
+ deleteNodesItem -> getAddressSpaceInternal(deleteNodesItem.getNodeId()),
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new DeleteNodesContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.deleteNodes(ctx, group);
+ });
+ }
+
+ @Override
+ public List addReferences(
+ AddReferencesContext context, List referencesToAdd) {
+ return groupMapCollate(
+ referencesToAdd,
+ addReferencesItem -> getAddressSpaceInternal(addReferencesItem.getSourceNodeId()),
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new AddReferencesContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.addReferences(ctx, group);
+ });
+ }
+
+ @Override
+ public List deleteReferences(
+ DeleteReferencesContext context, List referencesToDelete) {
+ return groupMapCollate(
+ referencesToDelete,
+ deleteReferencesItem -> getAddressSpaceInternal(deleteReferencesItem.getSourceNodeId()),
+ (AddressSpace asx) ->
+ group -> {
+ var ctx =
+ new DeleteReferencesContext(
+ server,
+ context.getSession().orElse(null),
+ context.getDiagnosticsContext(),
+ context.getAuditEntryId(),
+ context.getTimeoutHint(),
+ context.getAdditionalHeader());
+
+ return asx.deleteReferences(ctx, group);
+ });
+ }
+
+ // endregion
+
+ /** EmptyAddressSpaceFragment is used ephemerally and should never be registered. */
+ private static class EmptyAddressSpaceFragment extends ManagedAddressSpace
+ implements AddressSpaceFragment {
+
+ private EmptyAddressSpaceFragment(OpcUaServer server) {
+ super(server);
+ }
+
+ @Override
+ public AddressSpaceFilter getFilter() {
+ return new SimpleAddressSpaceFilter() {
+ @Override
+ protected boolean filterNode(NodeId nodeId) {
+ return true;
+ }
+
+ @Override
+ protected boolean filterMonitoredItem(NodeId nodeId) {
+ return true;
+ }
+ };
+ }
+
+ @Override
+ public void onDataItemsCreated(List dataItems) {}
+
+ @Override
+ public void onDataItemsModified(List dataItems) {}
+
+ @Override
+ public void onDataItemsDeleted(List dataItems) {}
+
+ @Override
+ public void onMonitoringModeChanged(List monitoredItems) {}
+ }
+}