org.eclipse.milo.opcua.sdk.server.api

Interface ServerNodeMap

All Superinterfaces:

ConcurrentMap<NodeId,ServerNode>, Map<NodeId,ServerNode>

All Known Implementing Classes:

AbstractServerNodeMap

public interface ServerNodeMap
extends ConcurrentMap<NodeId,ServerNode>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
default void	addNode(ServerNode node) Add a UaNode to this ServerNodeMap.
default boolean	addReference(Reference reference) Add a Reference to the UaNode indicated by Reference.getSourceNodeId().
default boolean	containsNode(ServerNode node) Check if a UaNode exists in this ServerNodeMap.
default boolean	containsNodeId(NodeId nodeId) Check if a ServerNode identified by NodeId exists in this ServerNodeMap.
NamespaceTable	getNamespaceTable() Get the server's NamespaceTable.
default Optional<ServerNode>	getNode(ExpandedNodeId nodeId) Get the ServerNode identified by the provided ExpandedNodeId, if it exists.
default Optional<ServerNode>	getNode(NodeId nodeId) Get the ServerNode identified by the provided NodeId, if it exists.
default Optional<ServerNode>	removeNode(NodeId nodeId) Remove the ServerNode identified by the provided NodeId, if it exists.

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

addNode

default void addNode(ServerNode node)

Add a UaNode to this ServerNodeMap.

This method is shorthand for:

      nodeMap.put(node.getNodeId(), node);
 

Parameters:

node - the UaNode to add.

addReference

default boolean addReference(Reference reference)

Add a Reference to the UaNode indicated by Reference.getSourceNodeId().

Parameters:

reference - the Reference to add.

Returns:

true if the UaNode exists and the reference was added.

containsNode

default boolean containsNode(ServerNode node)

Check if a UaNode exists in this ServerNodeMap.

Parameters:

node - the UaNode in question.

Returns:

true if this ServerNodeMap contains the ServerNode.

containsNodeId

default boolean containsNodeId(NodeId nodeId)

Check if a ServerNode identified by NodeId exists in this ServerNodeMap.

Parameters:

nodeId - the NodeId of the UaNode in question.

Returns:

true if this ServerNodeMap contains the ServerNode identified by nodeId.

getNode

default Optional<ServerNode> getNode(NodeId nodeId)

Get the ServerNode identified by the provided NodeId, if it exists.

Parameters:

nodeId - the NodeId of the UaNode.

Returns:

an Optional containing the UaNode, if present.

getNode

default Optional<ServerNode> getNode(ExpandedNodeId nodeId)

Get the ServerNode identified by the provided ExpandedNodeId, if it exists.

Parameters:

nodeId - the ExpandedNodeId of the UaNode.

Returns:

an Optional containing the UaNode, if present.

removeNode

default Optional<ServerNode> removeNode(NodeId nodeId)

Remove the ServerNode identified by the provided NodeId, if it exists.

Parameters:

nodeId - the NodeId of the UaNode.

Returns:

an Optional containing the UaNode, if removed.

getNamespaceTable

NamespaceTable getNamespaceTable()

Get the server's NamespaceTable.

// TODO this has no business here, but ServerNodeMap is currently the only thing passed into UaNode.

Returns:

the server's NamespaceTable.