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

Class AbstractNodeManager<T extends Node>

java.lang.Object

org.eclipse.milo.opcua.sdk.server.api.AbstractNodeManager<T>

All Implemented Interfaces:

NodeManager<T>

Direct Known Subclasses:

UaNodeManager

public class AbstractNodeManager<T extends Node>
extends Object
implements NodeManager<T>

Constructor Summary

Constructors

Constructor and Description
AbstractNodeManager()

Method Summary

Modifier and Type	Method and Description
Optional<T>	addNode(T node) Add node to this NodeManager, replacing a previous Node identified by the same NodeId if it exists.
void	addReference(Reference reference) Add reference to this NodeManager.
void	addReferences(Reference reference, NamespaceTable namespaceTable) Add reference and its inverse to this NodeManager.
boolean	containsNode(ExpandedNodeId nodeId, NamespaceTable namespaceTable) Return true if this NodeManager contains nodeId.
boolean	containsNode(NodeId nodeId) Return true if this NodeManager contains the Node identified by nodeId.
Optional<T>	getNode(ExpandedNodeId nodeId, NamespaceTable namespaceTable) Get the Node identified by nodeId from this NodeManager, or null if it does not exist.
Optional<T>	getNode(NodeId nodeId) Get the Node identified by nodeId from this NodeManager, if it exists.
List<NodeId>	getNodeIds() Get a copied List of the NodeIds being managed.
protected ConcurrentMap<NodeId,T>	getNodeMap() Get the backing ConcurrentMap holding this NodeManager's Nodes.
List<T>	getNodes() Get a copied List of the Nodes being managed.
ConcurrentMap<NodeId,com.google.common.collect.LinkedHashMultiset<Reference>>	getReferenceMap() Get the backing ConcurrentMap holding this NodeManager's References.
List<Reference>	getReferences(NodeId nodeId) Get all References that have nodeId as their source NodeId.
List<Reference>	getReferences(NodeId nodeId, Predicate<Reference> filter) Get all References that have nodeId as their source NodeId, filtered by filter.
protected ConcurrentMap<NodeId,T>	makeNodeMap(com.google.common.collect.MapMaker mapMaker) Optionally customize the backing ConcurrentMap with the provided MapMaker.
Optional<T>	removeNode(ExpandedNodeId nodeId, NamespaceTable namespaceTable) Get the Node identified by nodeId from this NodeManager, if it exists.
Optional<T>	removeNode(NodeId nodeId) Remove the Node identified by nodeId from this NodeManager, if it exists.
void	removeReference(Reference reference) Remove reference from this NodeManager.
void	removeReferences(Reference reference, NamespaceTable namespaceTable) Remove reference and its inverse from this NodeManager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.NodeManager

containsNode, get, get, removeNode

Constructor Detail

AbstractNodeManager

public AbstractNodeManager()

Method Detail

makeNodeMap

protected ConcurrentMap<NodeId,T> makeNodeMap(com.google.common.collect.MapMaker mapMaker)

Optionally customize the backing ConcurrentMap with the provided MapMaker.

Parameters:

mapMaker - the MapMaker that make the backing map with.

Returns:

a ConcurrentMap.

getNodeMap

protected ConcurrentMap<NodeId,T> getNodeMap()

Get the backing ConcurrentMap holding this NodeManager's Nodes.

Returns:

the backing ConcurrentMap holding this NodeManager's Nodes.

getReferenceMap

public ConcurrentMap<NodeId,com.google.common.collect.LinkedHashMultiset<Reference>> getReferenceMap()

Get the backing ConcurrentMap holding this NodeManager's References.

Returns:

the backing ConcurrentMap holding this NodeManager's References.

getNodes

public List<T> getNodes()

Get a copied List of the Nodes being managed.

Returns:

a copied List of the Nodes being managed.

getNodeIds

public List<NodeId> getNodeIds()

Get a copied List of the NodeIds being managed.

Returns:

a copied List of the NodeIds being managed.

containsNode

public boolean containsNode(NodeId nodeId)

Description copied from interface: NodeManager

Return true if this NodeManager contains the Node identified by nodeId.

Specified by:

containsNode in interface NodeManager<T extends Node>

Parameters:

nodeId - the NodeId.

Returns:

true if this NodeManager contains the Node identified by nodeId.

containsNode

public boolean containsNode(ExpandedNodeId nodeId,
                            NamespaceTable namespaceTable)

Description copied from interface: NodeManager

Return true if this NodeManager contains nodeId.

Returns false if nodeId is non-local.

Specified by:

containsNode in interface NodeManager<T extends Node>

Parameters:

nodeId - the ExpandedNodeId to check.

namespaceTable - the NamespaceTable.

Returns:

true if this NodeManager contains nodeId.

addNode

public Optional<T> addNode(T node)

Description copied from interface: NodeManager

Add node to this NodeManager, replacing a previous Node identified by the same NodeId if it exists.

Specified by:

addNode in interface NodeManager<T extends Node>

Parameters:

node - the Node to add.

Returns:

the previous Node identified by the NodeId of node, if it exists.

getNode

public Optional<T> getNode(NodeId nodeId)

Description copied from interface: NodeManager

Get the Node identified by nodeId from this NodeManager, if it exists.

Specified by:

getNode in interface NodeManager<T extends Node>

Parameters:

nodeId - the NodeId identifying the Node to get.

Returns:

the Node identified by nodeId from this NodeManager, if it exists.

getNode

public Optional<T> getNode(ExpandedNodeId nodeId,
                           NamespaceTable namespaceTable)

Description copied from interface: NodeManager

Get the Node identified by nodeId from this NodeManager, or null if it does not exist.

Returns false if nodeId is non-local.

Specified by:

getNode in interface NodeManager<T extends Node>

Parameters:

nodeId - the ExpandedNodeId identifying the Node to get.

namespaceTable - the NamespaceTable.

Returns:

the Node identified by nodeId from this NodeManager or null if it does not exist.

removeNode

public Optional<T> removeNode(NodeId nodeId)

Description copied from interface: NodeManager

Remove the Node identified by nodeId from this NodeManager, if it exists.

Specified by:

removeNode in interface NodeManager<T extends Node>

Parameters:

nodeId - the NodeId identifying the Node to remove.

Returns:

the Node removed from this NodeManager, if it exists.

removeNode

public Optional<T> removeNode(ExpandedNodeId nodeId,
                              NamespaceTable namespaceTable)

Description copied from interface: NodeManager

Get the Node identified by nodeId from this NodeManager, if it exists.

Returns Optional.empty() if nodeId is non-local.

Specified by:

removeNode in interface NodeManager<T extends Node>

Parameters:

nodeId - the ExpandedNodeId identifying the Node to get.

namespaceTable - the NamespaceTable.

Returns:

the Node identified by nodeId from this NodeManager, if it exists.

addReference

public void addReference(Reference reference)

Description copied from interface: NodeManager

Add reference to this NodeManager.

Specified by:

addReference in interface NodeManager<T extends Node>

Parameters:

reference - the Reference to add.

addReferences

public void addReferences(Reference reference,
                          NamespaceTable namespaceTable)

Description copied from interface: NodeManager

Add reference and its inverse to this NodeManager.

Specified by:

addReferences in interface NodeManager<T extends Node>

Parameters:

reference - the Reference to add.

namespaceTable - the NamespaceTable.

removeReference

public void removeReference(Reference reference)

Description copied from interface: NodeManager

Remove reference from this NodeManager.

Specified by:

removeReference in interface NodeManager<T extends Node>

Parameters:

reference - the Reference to remove.

removeReferences

public void removeReferences(Reference reference,
                             NamespaceTable namespaceTable)

Description copied from interface: NodeManager

Remove reference and its inverse from this NodeManager.

Specified by:

removeReferences in interface NodeManager<T extends Node>

Parameters:

reference - the Reference to remove.

namespaceTable - the NamespaceTable.

getReferences

public List<Reference> getReferences(NodeId nodeId)

Description copied from interface: NodeManager

Get all References that have nodeId as their source NodeId.

Specified by:

getReferences in interface NodeManager<T extends Node>

Parameters:

nodeId - the source NodeId.

Returns:

all References that have nodeId as their source NodeId.

getReferences

public List<Reference> getReferences(NodeId nodeId,
                                     Predicate<Reference> filter)

Description copied from interface: NodeManager

Get all References that have nodeId as their source NodeId, filtered by filter.

Specified by:

getReferences in interface NodeManager<T extends Node>

Parameters:

nodeId - the source NodeId.

filter - a Predicate to filter References.

Returns:

all References that have nodeId as their source NodeId, filtered by filter.