com.prosysopc.ua.server

Class NodeManagerTable

java.lang.Object

com.prosysopc.ua.server.NodeManagerTable

All Implemented Interfaces:

UaAddressSpace

public class NodeManagerTable
extends Object
implements UaAddressSpace

A collection of node managers, used in an UA Server. The NodeManagerTable can be used to access all Node Managers, and perform operations on any node, independent of which node manager manages it.

The NodeManagerTable will basically just dispatch different calls to the correct Node Manager, which you can also get from getNodeManager(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId).

Constructor Summary

Constructors

Constructor and Description
NodeManagerTable(UaServer server) Creates new NodeManagerTable for the server.

Method Summary

Modifier and Type	Method and Description
protected NodeId	addNode(ServiceContext serviceContext, AddNodesItem nodeToAdd)
protected NodeId	addNode(ServiceContext serviceContext, NodeId nodeId, NodeId parentNodeId, QualifiedName browseName, NodeClass nodeClass, ExpandedNodeId typeDefinitionId, NodeAttributes attributes, NodeId referenceTypeId)
void	addNode(UaNode node) Add a (@link UaNode) to the address space.
int	addNodeManager(int namespaceIndex, NodeManager nodeManager) Add a node manager to the table.
protected void	addReference(ServiceContext serviceContext, AddReferencesItem addReferencesItem)
protected void	afterCreateMonitoredDataItem(ServiceContext serviceContext, Subscription subscription, MonitoredDataItem item)
protected void	afterCreateMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
protected void	afterDeleteMonitoredItem(ServiceContext serviceContext, Subscription subscription, MonitoredItem item)
protected void	afterModifyMonitoredDataItem(ServiceContext serviceContext, Subscription subscription, MonitoredDataItem item)
protected void	afterModifyMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item)
protected BrowseContinuationPoint	browseNode(ServiceContext serviceContext, List<ReferenceDescription> referenceDescriptions, NodeId nodeId, int maxReferences, BrowseDirection browseDirection, NodeId referenceTypeId, Boolean includeSubTypes, QualifiedName browseName, EnumSet<NodeClass> nodeClassSet, EnumSet<BrowseResultMask> resultSet, ViewDescription view, int startIndex)
protected Variant[]	callMethod(ServiceContext serviceContext, NodeId objectId, NodeId methodId, Variant[] inputArguments, StatusCode[] inputArgumentResults, DiagnosticInfo[] inputArgumentDiagnosticInfos)
protected void	checkNodeManagementEnabled()
void	close() Closes this NodeManagerTable and all NodeManager that have been added to it.
protected ModelParser	createModelParser() Create ModelParser that is used for loadModel(...) methods, overriding this method can be used to return a custom subtype of ModelParser.
protected void	createMonitoredDataItem(ServiceContext serviceContext, Subscription subscription, NodeId nodeId, UnsignedInteger attributeId, NumericRange indexRange, MonitoringParameters params, MonitoringFilter filter, AggregateFilterResult filterResult, MonitoringMode monitoringMode)
protected void	createMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, NodeId nodeId, EventFilter eventFilter, EventFilterResult filterResult)
protected void	createNewNodeManager(ServiceContext serviceContext, String namespaceUri)
protected void	deleteMonitoredItem(ServiceContext serviceContext, Subscription subscription, MonitoredItem monitoredItem)
protected void	deleteNode(ServiceContext serviceContext, ExpandedNodeId expandedNodeId, boolean deleteTargetReferences)
protected void	deleteNode(ServiceContext serviceContext, NodeId nodeId, Boolean deleteTargetReferences)
protected void	deleteReference(ServiceContext serviceContext, NodeId sourceNodeId, ExpandedNodeId targetNodeId, NodeId referenceTypeId, Boolean isForward, Boolean deleteBidirectional)
UaNode	findNode(NodeId nodeId) Find a (@link UaNode) corresponding to the given (@link NodeId).
UaDataType	getDataType(NodeId dataTypeId) Convenience method for getNode(NodeId) and casting the result to UaDataType.
DataTypeConverter	getDataTypeConverter() Returns the DataTypeConverter.
EncoderContext	getEncoderContext() Returns the EncoderContext.
UaNode	getExternalNode(NodeId nodeId)
ExternalNodeManager	getExternalNodeManager()
HistoryManager	getHistoryManager(NodeId nodeId)
InstanceDeclarationHierarchyCache	getInstanceDeclarationHierarchyCache()
IoManager	getIoManager(NodeId nodeId)
NodeManagerTableListener	getListener()
NamespaceTable	getNamespaceTable() Return the (@link NamespaceTable) associated with the (@link UaAddressSpace).
UaNode	getNode(ExpandedNodeId nodeId) Convenience method for UaAddressSpace.getNode(NodeId) that accepts ExpandedNodeId.
<T extends UaNode> T	getNode(ExpandedNodeId nodeId, Class<T> clazz) Convenience method for UaAddressSpace.getNode(ExpandedNodeId) that converts the results to given class.
UaNode	getNode(NodeId nodeId) Find a node from the NodeManagers managed by the NodeManagerTable.
<T extends UaNode> T	getNode(NodeId nodeId, Class<T> clazz) Convinience method for getNode(NodeId) that casts the result to given class
UaNode	getNode(UaNodeId nodeId) Convenience method for UaAddressSpace.getNode(NodeId) that accepts UaNodeId.
<T extends UaNode> T	getNode(UaNodeId nodeId, Class<T> clazz) Convenience method for UaAddressSpace.getNode(UaNodeId) that converts the results to given class.
UaNodeBuilderConfiguration	getNodeBuilderConfiguration() Get UaNodeBuilderConfiguration that NodeManagerUaNode uses if it does not have it's own configuration.
NodeClass	getNodeClass(ExpandedNodeId nodeId, UaNode node) Return the node class of a node.
NodeClass	getNodeClass(NodeId nodeId, UaNode node) Return the node class of a node.
boolean	getNodeManagementEnabled() Are node management operations enabled in the server? That is AddNodes, AddReferences, DeleteNodes and DeleteReferences service calls.
NodeManager	getNodeManager(ExpandedNodeId expandedNodeId) Get a NodeManager that handles the specified node.
NodeManager	getNodeManager(int namespaceIndex) Get a certain NodeManager from the table.
NodeManager	getNodeManager(NodeId nodeId) Get a NodeManager that handles the specified node.
NodeManager	getNodeManager(String namespaceUri) Find the node manager for the defined namespaceUri The method equals to getNodeManager(getNamespaceTable().getIndex(namespaceUri))
NodeManagerRoot	getNodeManagerRoot()
UaNode	getNodeOrExternal(NodeId nodeId) Mostly for internal use.
UaNode	getNodeOrExternalIfExist(NodeId nodeId) Mostly for internal use.
FolderTypeNode	getObjectsFolder() Returns the UaNode for UaObjectIds.ObjectsFolder.
FolderTypeNode	getRoot() Returns the UaNode for UaObjectIds.RootFolder.
UaServer	getServer()
ServerTable	getServerTable()
UaType	getType(NodeId typeId) Find the type node with a specific Id.
boolean	hasNode(NodeId nodeId)
boolean	hasNodeManager(String uri)
protected HistoryResult	historyRead(ServiceContext serviceContext, Object operationContext, TimestampsToReturn timestampsToReturn, NodeId nodeId, NumericRange indexRange, HistoryContinuationPoint continuationPoint, HistoryReadDetails details, int aggregateIndex)
protected void	historyUpdate(ServiceContext serviceContext, Object operationContext, HistoryUpdateDetails details, HistoryUpdateResult historyUpdateResult)
protected void	init()
protected void	initializeMonitoredDataItem(ServiceContext serviceContext, MonitoredDataItem monitoredItem, DataValue dataValue)
void	invalidatePreviousNodeCaches() Calls NodeManager.invalidatePreviousNodeCache() for all NodeManagers.
boolean	isTypeOf(NodeId typeDefinitionId, UaType typeDefinition, NodeId expectedTypeId, UaType expectedType)
void	loadModel(InputStream inputStream) Load an Information Model into the client.
void	loadModel(InputStream inputStream, Collection<ExpandedNodeId> ignoredNodes, boolean failOnFirstError) Load an Information Model into the server.
void	loadModel(UaNodeSet... nodesets) Resolves and adds the given UaNodeSets to the address space using UaNodeSetLoadOptions.defaults() options.
void	loadModel(UaNodeSetLoadOptions options, UaNodeSet... nodesets) Resolves and adds the given UaNodeSets to the address space using the given options.
void	loadModel(URI path) Load an Information Model into the server.
void	loadModel(URI path, Collection<ExpandedNodeId> ignoredNodes, boolean failOnFirstError) Load an Information Model into the server.
protected void	modifyMonitoredDataItem(ServiceContext serviceContext, Subscription subscription, MonitoredDataItem item, MonitoringParameters params, MonitoringFilter filter, AggregateFilterResult filterResult)
protected void	modifyMonitoredEventItem(ServiceContext serviceContext, Subscription subscription, MonitoredEventItem item, EventFilter eventFilter, EventFilterResult filterResult)
protected void	queryFirst(ServiceContext serviceContext, QueryFirstRequest request, QueryFirstResponse response)
protected void	queryNext(ServiceContext serviceContext, QueryNextRequest request, QueryNextResponse response)
protected void	readAttribute(ServiceContext serviceContext, Object operationContext, NodeId nodeId, UnsignedInteger attributeId, NumericRange indexRange, TimestampsToReturn timestampsToReturn, DateTime minTimestamp, DataValue dataValue) Read the value of a single node attribute.
protected NodeId	registerNode(ServiceContext serviceContext, NodeId nodeId)
protected void	releaseHistoryContinuationPoint(ServiceContext serviceContext, NodeId nodeId, ByteString continuationPoint)
NodeManager	removeNodeManager(int namespaceIndex) Removes the NodeManager with the given NamespaceIndex.
NodeManager	removeNodeManager(int namespaceIndex, boolean removeNamespace) Removes the NodeManager with the given NamespaceIndex.
void	setListener(NodeManagerTableListener listener)
void	setNodeBuilderConfiguration(UaNodeBuilderConfiguration configuration) Set new NodeBuilder configuration.
void	setNodeManagementEnabled(boolean nodeManagementEnabled) Enable node management operations in the server.
protected void	start() Start all node managers.
protected BrowsePathTarget[]	translateBrowsePath(ServiceContext serviceContext, NodeId startingNode, RelativePath relativePath)
BrowsePathTarget[]	translateBrowsePathToNodeIds(NodeId startingNode, RelativePath relativePath) Request the NodeIds for the nodes that are references from the startingNode using paths.
protected void	unregisterNode(ServiceContext serviceContext, NodeId nodeId)
protected boolean	writeAttribute(ServiceContext serviceContext, Object operationContext, NodeId nodeId, UnsignedInteger attributeId, NumericRange indexRange, DataValue value) Write the value of a single node attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeManagerTable

public NodeManagerTable(UaServer server)

Creates new NodeManagerTable for the server.

Method Detail

addNode

public void addNode(UaNode node)

Add a (@link UaNode) to the address space. Note! this method should mostly be called by the SDK internally, it is better to add the node via the NodeManagerUaNode.addNode(UaNode) of the correct manager.

Specified by:

addNode in interface UaAddressSpace

Parameters:

node - that is added

Throws:

IllegalStateException - if the node cannot be added.

addNodeManager

public int addNodeManager(int namespaceIndex,
                          NodeManager nodeManager)

Add a node manager to the table.

Parameters:

namespaceIndex - the desired namespaceIndex or -1 to use the next available. Indexes 0 and 1 are reserved for the standard OPCUA namespaces

nodeManager - The node manager to add to the table

Returns:

the namespaceIndex that was assigned for the node manager

close

public void close()

Closes this NodeManagerTable and all NodeManager that have been added to it.

findNode

public UaNode findNode(NodeId nodeId)

Find a (@link UaNode) corresponding to the given (@link NodeId).

Specified by:

findNode in interface UaAddressSpace

Parameters:

nodeId - of the (@link UaNode) that is searched for

Returns:

the found (@link UaNode) or null if not found

getDataType

public UaDataType getDataType(NodeId dataTypeId)
                       throws StatusException

Convenience method for getNode(NodeId) and casting the result to UaDataType.

Throws:

StatusException

getDataTypeConverter

public DataTypeConverter getDataTypeConverter()

Description copied from interface: UaAddressSpace

Returns the DataTypeConverter.

Specified by:

getDataTypeConverter in interface UaAddressSpace

getEncoderContext

public EncoderContext getEncoderContext()

Description copied from interface: UaAddressSpace

Returns the EncoderContext.

Specified by:

getEncoderContext in interface UaAddressSpace

getExternalNode

public UaNode getExternalNode(NodeId nodeId)
                       throws StatusException

Throws:

StatusException

getExternalNodeManager

public ExternalNodeManager getExternalNodeManager()

getHistoryManager

public HistoryManager getHistoryManager(NodeId nodeId)
                                 throws StatusException

Parameters:

nodeId -

Returns:

Throws:

StatusException

getInstanceDeclarationHierarchyCache

public InstanceDeclarationHierarchyCache getInstanceDeclarationHierarchyCache()

getIoManager

public IoManager getIoManager(NodeId nodeId)
                       throws StatusException

Parameters:

nodeId -

Returns:

Throws:

StatusException

getListener

public NodeManagerTableListener getListener()

getNamespaceTable

public NamespaceTable getNamespaceTable()

Description copied from interface: UaAddressSpace

Return the (@link NamespaceTable) associated with the (@link UaAddressSpace).

Specified by:

getNamespaceTable in interface UaAddressSpace

Returns:

the (@link NamespaceTable) associated with the (@link UaAddressSpace).

getNode

public UaNode getNode(ExpandedNodeId nodeId)
               throws StatusException

Description copied from interface: UaAddressSpace

Convenience method for UaAddressSpace.getNode(NodeId) that accepts ExpandedNodeId.

Specified by:

getNode in interface UaAddressSpace

Throws:

StatusException

getNode

public <T extends UaNode> T getNode(ExpandedNodeId nodeId,
                                    Class<T> clazz)
                             throws StatusException

Description copied from interface: UaAddressSpace

Convenience method for UaAddressSpace.getNode(ExpandedNodeId) that converts the results to given class.

Specified by:

getNode in interface UaAddressSpace

Throws:

StatusException

getNode

public UaNode getNode(NodeId nodeId)
               throws StatusException

Find a node from the NodeManagers managed by the NodeManagerTable. It dispatches the request to the NodeManager that is registered to handle the nameSpace in which the NodeId resides.

If the node is not found or there is no UaNode initialized for it, the method throws StatusException: Bad_NodeIdUnknown.

In case the NodeManager does contain the node with the specified NodeId, but does not use UaNode objects, the method may return null.

In case the node is handled by a node manager without any UaNode, you should rather use findNode, which simply returns null, if there is no node object available and hasNode to just check if the NodeId is handled by a node manager. Alternatively, you can find the correct NodeManager yourself and request more detailed information directly from it.

Specified by:

getNode in interface UaAddressSpace

Parameters:

nodeId - the Node to look for

Returns:

the UaNode object with the NodeId. May be null, if the NodeManager does not ServiceManagerBase.requireUaNode() but the NodeId is valid.

Throws:

StatusException - if the node is not found

getNode

public <T extends UaNode> T getNode(NodeId nodeId,
                                    Class<T> clazz)
                             throws StatusException

Convinience method for getNode(NodeId) that casts the result to given class

Specified by:

getNode in interface UaAddressSpace

Parameters:

nodeId -

clazz -

Returns:

Throws:

StatusException - if the node is not found

ClassCastException - if cast fails

getNode

public UaNode getNode(UaNodeId nodeId)
               throws StatusException

Description copied from interface: UaAddressSpace

Convenience method for UaAddressSpace.getNode(NodeId) that accepts UaNodeId.

Specified by:

getNode in interface UaAddressSpace

Throws:

StatusException

getNode

public <T extends UaNode> T getNode(UaNodeId nodeId,
                                    Class<T> clazz)
                             throws StatusException

Description copied from interface: UaAddressSpace

Convenience method for UaAddressSpace.getNode(UaNodeId) that converts the results to given class.

Specified by:

getNode in interface UaAddressSpace

Throws:

StatusException

getNodeBuilderConfiguration

public UaNodeBuilderConfiguration getNodeBuilderConfiguration()

Get UaNodeBuilderConfiguration that NodeManagerUaNode uses if it does not have it's own configuration.

Returns:

a configuration for NodeBuilder

getNodeClass

public NodeClass getNodeClass(ExpandedNodeId nodeId,
                              UaNode node)

Return the node class of a node.

Parameters:

nodeId - The ID of the node.

node - The UaNode object, if the node manager supports them, or null

Returns:

the NodeClass of the node

getNodeClass

public NodeClass getNodeClass(NodeId nodeId,
                              UaNode node)

Return the node class of a node.

Parameters:

nodeId - The ID of the node.

node - The UaNode object, if the node manager supports them, or null

Returns:

the NodeClass of the node

getNodeManagementEnabled

public boolean getNodeManagementEnabled()

Are node management operations enabled in the server? That is AddNodes, AddReferences, DeleteNodes and DeleteReferences service calls.

Returns:

true if node management operations are enabled in general

See Also:

setNodeManagementEnabled(boolean)

getNodeManager

public NodeManager getNodeManager(ExpandedNodeId expandedNodeId)
                           throws StatusException

Get a NodeManager that handles the specified node.

Parameters:

expandedNodeId - the node id that defines the namespace

Returns:

the nodeManager that handles the namespace defined by the NodeId

Throws:

StatusException - if the re is no node manager for the namespace

getNodeManager

public NodeManager getNodeManager(int namespaceIndex)
                           throws StatusException

Get a certain NodeManager from the table.

Parameters:

namespaceIndex - the namespaceIndex of the nodemanager to look for

Returns:

the nodemanager for the index

Throws:

StatusException - with StatusCodes.Bad_NodeIdUnknown if the nodeManager is not found

getNodeManager

public NodeManager getNodeManager(NodeId nodeId)
                           throws StatusException

Get a NodeManager that handles the specified node.

Parameters:

nodeId - the node id that defines the namespace

Returns:

the nodeManager that handles the namespace defined by the NodeId

Throws:

StatusException - if there is no node manager for the namespace

getNodeManager

public NodeManager getNodeManager(String namespaceUri)
                           throws StatusException

Find the node manager for the defined namespaceUri

The method equals to getNodeManager(getNamespaceTable().getIndex(namespaceUri))

Parameters:

namespaceUri - the URI of teh namespace to look for

Returns:

Throws:

StatusException - if the nodeManager is not available

getNodeManagerRoot

public NodeManagerRoot getNodeManagerRoot()

getNodeOrExternal

public UaNode getNodeOrExternal(NodeId nodeId)
                         throws StatusException

Mostly for internal use. Returns node if one exists for the given NodeId, or returns a (potentially cached) fake UaNode.

Throws:

StatusException

getNodeOrExternalIfExist

public UaNode getNodeOrExternalIfExist(NodeId nodeId)
                                throws StatusException

Mostly for internal use. Returns node if one exists for the given NodeId. Otherwise returns a fake cached UaNode if one has been made previously, but if not then null is returned.

Throws:

StatusException

getObjectsFolder

public FolderTypeNode getObjectsFolder()

Description copied from interface: UaAddressSpace

Returns the UaNode for UaObjectIds.ObjectsFolder.

Specified by:

getObjectsFolder in interface UaAddressSpace

getRoot

public FolderTypeNode getRoot()

Description copied from interface: UaAddressSpace

Returns the UaNode for UaObjectIds.RootFolder.

Specified by:

getRoot in interface UaAddressSpace

getServer

public UaServer getServer()

getServerTable

public ServerTable getServerTable()

Returns:

getType

public UaType getType(NodeId typeId)
               throws StatusException

Find the type node with a specific Id.

Parameters:

typeId - the NodeId of the type

Returns:

the type node

Throws:

StatusException - if the node is not found

hasNode

public boolean hasNode(NodeId nodeId)

hasNodeManager

public boolean hasNodeManager(String uri)

Parameters:

uri -

Returns:

invalidatePreviousNodeCaches

public void invalidatePreviousNodeCaches()

Calls NodeManager.invalidatePreviousNodeCache() for all NodeManagers. Normally there is no need to call this manually, but if you delete an UaNode outside of methods like NodeManagerUaNode.deleteNode(NodeId, boolean, boolean), calling this will clean-up internal caches, which might still hold references to the (deleted) nodes.

isTypeOf

public boolean isTypeOf(NodeId typeDefinitionId,
                        UaType typeDefinition,
                        NodeId expectedTypeId,
                        UaType expectedType)
                 throws StatusException

Parameters:

typeDefinitionId -

typeDefinition -

expectedTypeId -

expectedType -

Returns:

Throws:

StatusException

loadModel

public void loadModel(InputStream inputStream)
               throws SAXException,
                      IOException,
                      ModelException

Load an Information Model into the client. Load nodes and references from an UA NodeSet file. The file must conform to the UANodeSet schema, http://opcfoundation.org/UA/2011/03/UANodeSet.xsd

Specified by:

loadModel in interface UaAddressSpace

Parameters:

inputStream - The stream that contains the XML node set.

Throws:

ModelException - if there is a problem with the model and it cannot be fully created. The exception is thrown with and errorList of all errors found in the stream.

SAXException - if the required XMLReaded cannot be created.

IOException - if the model file cannot be read.

loadModel

public void loadModel(InputStream inputStream,
                      Collection<ExpandedNodeId> ignoredNodes,
                      boolean failOnFirstError)
               throws SAXException,
                      ModelException,
                      IOException

Load an Information Model into the server.

Load nodes and references from an UA NodeSet file. The file must conform to the UANodeSet schema, http://opcfoundation.org/UA/2011/03/UANodeSet.xsd

Parameters:

inputStream - The stream that contains the XML node set.

Throws:

ModelException - if there is a problem with the model and it cannot be fully created. The exception is thrown with and errorList of all errors found in the stream.

SAXException - if the required XMLReaded cannot be created.

IOException - if the model stream cannot be read

loadModel

public void loadModel(UaNodeSet... nodesets)
               throws UaException

Resolves and adds the given UaNodeSets to the address space using UaNodeSetLoadOptions.defaults() options. Throws if any of the given model(s) contained errors (in UaNodeSet.getLog()).

Throws:

UaException

loadModel

public void loadModel(UaNodeSetLoadOptions options,
                      UaNodeSet... nodesets)
               throws UaException

Resolves and adds the given UaNodeSets to the address space using the given options. Throws depending on the given options

Throws:

UaException

loadModel

public void loadModel(URI path)
               throws SAXException,
                      IOException,
                      ModelException

Load an Information Model into the server.

Load nodes and references from an UA NodeSet file. The file must conform to the UANodeSet schema, http://opcfoundation.org/UA/2011/03/UANodeSet.xsd

Specified by:

loadModel in interface UaAddressSpace

Parameters:

path - The path to the XML file. You can create an URI from a File name with java.io.File#toUri()

Throws:

ModelException - if there is a problem with the model and it cannot be fully created. The exception is thrown with and errorList of all errors found in the file.

SAXException - if the required XMLReaded cannot be created.

IOException - if the model file cannot be read.

loadModel

public void loadModel(URI path,
                      Collection<ExpandedNodeId> ignoredNodes,
                      boolean failOnFirstError)
               throws SAXException,
                      IOException,
                      ModelException

Load an Information Model into the server.

Load nodes and references from an UA NodeSet file. The file must conform to the UANodeSet schema, http://opcfoundation.org/UA/2011/03/UANodeSet.xsd

Parameters:

path - The path to the XML file. You can create an URI from a File name with java.io.File#toUri()

ignoredNodes - Nodes to leave out of import. Use this if you are creating the nodes explicitly in the server and do not want them to be imported from the XML. The related references will be imported though.

failOnFirstError - make the model creation fail for the first error encountered. If false, the model is parsed fully and possible errors are raised only at the end.

Throws:

ModelException - if there is a problem with the model and it cannot be fully created. The exception is thrown for individual nodes only if #isFailOnFirstError() is true. Otherwise, it will be filled with and errorList.

SAXException - if the required XMLReaded cannot be created.

IOException - if the model file cannot be read.

removeNodeManager

public NodeManager removeNodeManager(int namespaceIndex)

Removes the NodeManager with the given NamespaceIndex. The Namespace corresponding to the NamespaceIndex is also removed from the NamespaceTable.

Parameters:

namespaceIndex - the NamespaceIndex of the NodeManager to remove

Returns:

the removed NodeManager or null if there was no NodeManager for the given NamespaceIndex

removeNodeManager

public NodeManager removeNodeManager(int namespaceIndex,
                                     boolean removeNamespace)

Removes the NodeManager with the given NamespaceIndex. The Namespace corresponding to the NamespaceIndex is also removed from the NamespaceTable when removeNamespace is true, otherwise the Namespace is not removed.

Parameters:

namespaceIndex - the NamespaceIndex of the NodeManager to remove

removeNamespace - true when the Namespace corresponding to the NamespaceIndex should be removed from the NamespaceTable, false otherwise

Returns:

the removed NodeManager or null if there was no NodeManager for the given NamespaceIndex

setListener

public void setListener(NodeManagerTableListener listener)

setNodeBuilderConfiguration

public void setNodeBuilderConfiguration(UaNodeBuilderConfiguration configuration)

Set new NodeBuilder configuration.

Parameters:

configuration - the new configuration

See Also:

getNodeBuilderConfiguration()

setNodeManagementEnabled

public void setNodeManagementEnabled(boolean nodeManagementEnabled)

Enable node management operations in the server. That is AddNodes, AddReferences, DeleteNodes and DeleteReferences service calls.

If you wish to enable these operations depending on user identity, then you will need to define user specific access to these in every node manager, using the NodeManagerListener of each.

It will also enable new node managers to be created on the fly as necessary, if clients addNodes for a new namespace. You may modify this behaviour using the UaServerListener of the server.

Default value: false

Parameters:

nodeManagementEnabled - the allowNewNodeManagers to set

See Also:

UaServer.setListener(UaServerListener)

translateBrowsePathToNodeIds

public BrowsePathTarget[] translateBrowsePathToNodeIds(NodeId startingNode,
                                                       RelativePath relativePath)
                                                throws StatusException,
                                                       ServiceException

Request the NodeIds for the nodes that are references from the startingNode using paths.

Each browse path is constructed of a starting Node and a RelativePath. The specified starting Node identifies the Node from which the RelativePath is based. The RelativePath contains a sequence of ReferenceTypes and BrowseNames.

Specified by:

translateBrowsePathToNodeIds in interface UaAddressSpace

Parameters:

browsePaths - the browse paths, i.e. combinations of StartingNode & RelativePath

Returns:

a list of targets for the relativePath from the startingNode. The result is a list, since it is possible that there are several nodes that have the same path. Normally, there should be only one result, though. Read the TargetId of the result(s) to find the NodeId requested.

Server may also encounter a Reference to a Node in another Server which it can not follow while it is processing the RelativePath. If this happens the NodeId of the external Node as TargetId is returned, and the remainingPathIndex parameter indicates which RelativePath elements still need to be processed. If all elements are processed, i.e. there is no reference to an external server, remainingPathIndex will be set to UnsignedInteger.MAX_VALUE.

Throws:

ServiceException - if call failed

StatusException - if call failed

addNode

protected NodeId addNode(ServiceContext serviceContext,
                         AddNodesItem nodeToAdd)
                  throws StatusException

Throws:

StatusException

addNode

protected NodeId addNode(ServiceContext serviceContext,
                         NodeId nodeId,
                         NodeId parentNodeId,
                         QualifiedName browseName,
                         NodeClass nodeClass,
                         ExpandedNodeId typeDefinitionId,
                         NodeAttributes attributes,
                         NodeId referenceTypeId)
                  throws StatusException

Parameters:

serviceContext -

nodeId -

parentNodeId -

browseName -

nodeClass -

typeDefinitionId -

attributes -

referenceTypeId -

Returns:

Throws:

StatusException

addReference

protected void addReference(ServiceContext serviceContext,
                            AddReferencesItem addReferencesItem)
                     throws StatusException

Throws:

StatusException

afterCreateMonitoredDataItem

protected void afterCreateMonitoredDataItem(ServiceContext serviceContext,
                                            Subscription subscription,
                                            MonitoredDataItem item)
                                     throws StatusException

Parameters:

serviceContext -

subscription -

item -

Throws:

StatusException

afterCreateMonitoredEventItem

protected void afterCreateMonitoredEventItem(ServiceContext serviceContext,
                                             Subscription subscription,
                                             MonitoredEventItem item)
                                      throws StatusException

Parameters:

serviceContext -

subscription -

item -

Throws:

StatusException

afterDeleteMonitoredItem

protected void afterDeleteMonitoredItem(ServiceContext serviceContext,
                                        Subscription subscription,
                                        MonitoredItem item)
                                 throws StatusException

Parameters:

serviceContext -

subscription -

item -

Throws:

StatusException

afterModifyMonitoredDataItem

protected void afterModifyMonitoredDataItem(ServiceContext serviceContext,
                                            Subscription subscription,
                                            MonitoredDataItem item)
                                     throws StatusException

Parameters:

serviceContext -

subscription -

item -

Throws:

StatusException

afterModifyMonitoredEventItem

protected void afterModifyMonitoredEventItem(ServiceContext serviceContext,
                                             Subscription subscription,
                                             MonitoredEventItem item)
                                      throws StatusException

Parameters:

serviceContext -

subscription -

item -

Throws:

StatusException

browseNode

protected BrowseContinuationPoint browseNode(ServiceContext serviceContext,
                                             List<ReferenceDescription> referenceDescriptions,
                                             NodeId nodeId,
                                             int maxReferences,
                                             BrowseDirection browseDirection,
                                             NodeId referenceTypeId,
                                             Boolean includeSubTypes,
                                             QualifiedName browseName,
                                             EnumSet<NodeClass> nodeClassSet,
                                             EnumSet<BrowseResultMask> resultSet,
                                             ViewDescription view,
                                             int startIndex)
                                      throws ServiceException,
                                             StatusException

Throws:

ServiceException

StatusException

callMethod

protected Variant[] callMethod(ServiceContext serviceContext,
                               NodeId objectId,
                               NodeId methodId,
                               Variant[] inputArguments,
                               StatusCode[] inputArgumentResults,
                               DiagnosticInfo[] inputArgumentDiagnosticInfos)
                        throws StatusException

Parameters:

serviceContext -

objectId -

methodId -

inputArguments -

inputArgumentResults -

inputArgumentDiagnosticInfos -

Returns:

Throws:

StatusException

checkNodeManagementEnabled

protected void checkNodeManagementEnabled()
                                   throws ServiceException

Throws:

ServiceException

createModelParser

protected ModelParser createModelParser()

Create ModelParser that is used for loadModel(...) methods, overriding this method can be used to return a custom subtype of ModelParser.

createMonitoredDataItem

protected void createMonitoredDataItem(ServiceContext serviceContext,
                                       Subscription subscription,
                                       NodeId nodeId,
                                       UnsignedInteger attributeId,
                                       NumericRange indexRange,
                                       MonitoringParameters params,
                                       MonitoringFilter filter,
                                       AggregateFilterResult filterResult,
                                       MonitoringMode monitoringMode)
                                throws StatusException

Parameters:

serviceContext -

subscription -

nodeId -

attributeId -

indexRange -

params -

filterResult -

filter -

filterResult -

monitoringMode -

Throws:

StatusException - if the mointoredItem is not accepted

createMonitoredEventItem

protected void createMonitoredEventItem(ServiceContext serviceContext,
                                        Subscription subscription,
                                        NodeId nodeId,
                                        EventFilter eventFilter,
                                        EventFilterResult filterResult)
                                 throws StatusException

Parameters:

serviceContext -

nodeId -

eventFilter -

filterResult -

Throws:

StatusException - if the node is not valid

createNewNodeManager

protected void createNewNodeManager(ServiceContext serviceContext,
                                    String namespaceUri)
                             throws StatusException

Parameters:

serviceContext -

namespaceUri -

Throws:

StatusException

deleteMonitoredItem

protected void deleteMonitoredItem(ServiceContext serviceContext,
                                   Subscription subscription,
                                   MonitoredItem monitoredItem)
                            throws StatusException

Parameters:

serviceContext -

subscription -

monitoredItem -

Throws:

StatusException

deleteNode

protected void deleteNode(ServiceContext serviceContext,
                          ExpandedNodeId expandedNodeId,
                          boolean deleteTargetReferences)
                   throws StatusException

Parameters:

serviceContext -

expandedNodeId -

deleteTargetReferences -

Throws:

StatusException

deleteNode

protected void deleteNode(ServiceContext serviceContext,
                          NodeId nodeId,
                          Boolean deleteTargetReferences)
                   throws StatusException

Parameters:

serviceContext -

nodeId -

deleteTargetReferences -

Throws:

StatusException

deleteReference

protected void deleteReference(ServiceContext serviceContext,
                               NodeId sourceNodeId,
                               ExpandedNodeId targetNodeId,
                               NodeId referenceTypeId,
                               Boolean isForward,
                               Boolean deleteBidirectional)
                        throws StatusException

Parameters:

serviceContext -

sourceNodeId -

targetNodeId -

referenceTypeId -

isForward -

deleteBidirectional -

Throws:

StatusException

historyRead

protected HistoryResult historyRead(ServiceContext serviceContext,
                                    Object operationContext,
                                    TimestampsToReturn timestampsToReturn,
                                    NodeId nodeId,
                                    NumericRange indexRange,
                                    HistoryContinuationPoint continuationPoint,
                                    HistoryReadDetails details,
                                    int aggregateIndex)
                             throws StatusException

Parameters:

serviceContext -

timestampsToReturn -

nodeId -

indexRange -

continuationPoint -

details -

aggregateIndex -

operationContext -

Returns:

Throws:

StatusException

historyUpdate

protected void historyUpdate(ServiceContext serviceContext,
                             Object operationContext,
                             HistoryUpdateDetails details,
                             HistoryUpdateResult historyUpdateResult)
                      throws StatusException

Parameters:

serviceContext -

operationContext -

details -

historyUpdateResult -

Throws:

StatusException

init

protected void init()
             throws StatusException,
                    UaNodeFactoryException

Throws:

UaNodeFactoryException

StatusException

initializeMonitoredDataItem

protected void initializeMonitoredDataItem(ServiceContext serviceContext,
                                           MonitoredDataItem monitoredItem,
                                           DataValue dataValue)
                                    throws StatusException

Throws:

StatusException

modifyMonitoredDataItem

protected void modifyMonitoredDataItem(ServiceContext serviceContext,
                                       Subscription subscription,
                                       MonitoredDataItem item,
                                       MonitoringParameters params,
                                       MonitoringFilter filter,
                                       AggregateFilterResult filterResult)
                                throws StatusException

Parameters:

serviceContext -

subscription -

item -

params -

filter -

filterResult -

Throws:

StatusException

modifyMonitoredEventItem

protected void modifyMonitoredEventItem(ServiceContext serviceContext,
                                        Subscription subscription,
                                        MonitoredEventItem item,
                                        EventFilter eventFilter,
                                        EventFilterResult filterResult)
                                 throws StatusException

Parameters:

serviceContext -

subscription -

item -

eventFilter -

filterResult -

Throws:

StatusException

queryFirst

protected void queryFirst(ServiceContext serviceContext,
                          QueryFirstRequest request,
                          QueryFirstResponse response)
                   throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

StatusException

ServiceException

queryNext

protected void queryNext(ServiceContext serviceContext,
                         QueryNextRequest request,
                         QueryNextResponse response)
                  throws ServiceException

Parameters:

serviceContext -

request -

response -

Throws:

StatusException

ServiceException

readAttribute

protected void readAttribute(ServiceContext serviceContext,
                             Object operationContext,
                             NodeId nodeId,
                             UnsignedInteger attributeId,
                             NumericRange indexRange,
                             TimestampsToReturn timestampsToReturn,
                             DateTime minTimestamp,
                             DataValue dataValue)
                      throws StatusException

Read the value of a single node attribute.

Parameters:

serviceContext - The serviceContext of the client connection used to call this service.

operationContext - the possible operationContext prepared in #beginRead

nodeId - The node to read.

attributeId - The attribute to read.

indexRange - The requested index range for an array value. May be null.

timestampsToReturn - Which timestamps were requested by the client.

minTimestamp - Minimum value of the ServerTimestamp of the value to be read. If there is no value available that is new enough already available (in the server cache), the server should attempt to read a new value from the actual data source, instead of using the cached value. If a new value cannot be read, the best value available is returned. If minTimestamp == DateTime.MAX_VALUE a new value should be read from the source.

dataValue - The data value to return. Set Value, and for Value attribute also StatusCode and the Timestamps.

Throws:

StatusException - If the read fails. Expected result codes: Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_DataEncodingInvalid, Bad_DataEncodingUnsupported, Bad_NotReadable, Bad_UserAccessDenied

registerNode

protected NodeId registerNode(ServiceContext serviceContext,
                              NodeId nodeId)
                       throws StatusException

Parameters:

serviceContext -

nodeId -

Returns:

Throws:

StatusException

releaseHistoryContinuationPoint

protected void releaseHistoryContinuationPoint(ServiceContext serviceContext,
                                               NodeId nodeId,
                                               ByteString continuationPoint)
                                        throws StatusException

Parameters:

serviceContext -

nodeId -

continuationPoint -

Throws:

StatusException

start

protected void start()
              throws StatusException,
                     UaNodeFactoryException

Start all node managers.

Throws:

StatusException

UaNodeFactoryException

translateBrowsePath

protected BrowsePathTarget[] translateBrowsePath(ServiceContext serviceContext,
                                                 NodeId startingNode,
                                                 RelativePath relativePath)
                                          throws StatusException,
                                                 ServiceException

Throws:

StatusException

ServiceException

unregisterNode

protected void unregisterNode(ServiceContext serviceContext,
                              NodeId nodeId)
                       throws StatusException

Parameters:

serviceContext -

nodeId -

Throws:

StatusException

writeAttribute

protected boolean writeAttribute(ServiceContext serviceContext,
                                 Object operationContext,
                                 NodeId nodeId,
                                 UnsignedInteger attributeId,
                                 NumericRange indexRange,
                                 DataValue value)
                          throws StatusException

Write the value of a single node attribute.

Parameters:

serviceContext - The serviceContext of the client connection used to call this service.

operationContext - The possible operationContext prepared in #beginWrite.

nodeId - The node to write.

attributeId - The attribute to write.

indexRange - The index range to set for an array value. May be null.

value - The data value to write.

Returns:

true when writing was handled synchronously, false when asynchronously.

Throws:

StatusException - If the write fails. Expected result codes: Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_DataEncodingInvalid, Bad_DataEncodingUnsupported, Bad_NotWriteable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch, Bad_WriteNotSupported