com.prosysopc.ua

Interface UaAddressSpace

All Known Implementing Classes:

AddressSpace, NodeManagerTable

public interface UaAddressSpace

A common interface for UA address space.

The main use-case for this interface is to offer somewhat common interface for accessing UaNodes on both the client and the server side.

NOTE! This interface tries to offer methods that AddressSpace (client side) and NodeManagerTable (server side) have. Note that there is some differences on returning null values and throwing exceptions, therefore it is better to use the concrete implementation classes returned by UaClient or UaServer getAddressSpace method, if possible.

NOTE! This interface is not designed to be implemented by SDK users, e.g. methods can be added to it.

Method Summary

Modifier and Type	Method and Description
void	addNode(UaNode node) Add a (@link UaNode) to the address space.
UaNode	findNode(NodeId id) Find a (@link UaNode) corresponding to the given NodeId.
DataTypeConverter	getDataTypeConverter() Returns the DataTypeConverter.
EncoderContext	getEncoderContext() Returns the EncoderContext.
NamespaceTable	getNamespaceTable() Return the (@link NamespaceTable) associated with the (@link UaAddressSpace).
UaNode	getNode(ExpandedNodeId nodeId) Convenience method for getNode(NodeId) that accepts ExpandedNodeId.
<T extends UaNode> T	getNode(ExpandedNodeId nodeId, Class<T> clazz) Convenience method for getNode(ExpandedNodeId) that converts the results to given class.
UaNode	getNode(NodeId nodeId) Find the UaNode object, corresponding to the NodeId.
<T extends UaNode> T	getNode(NodeId nodeId, Class<T> clazz) Convenience method for getNode(NodeId) that converts the results to given class.
UaNode	getNode(UaNodeId nodeId) Convenience method for getNode(NodeId) that accepts UaNodeId.
<T extends UaNode> T	getNode(UaNodeId nodeId, Class<T> clazz) Convenience method for getNode(UaNodeId) that converts the results to given class.
FolderType	getObjectsFolder() Returns the UaNode for UaObjectIds.ObjectsFolder.
FolderType	getRoot() Returns the UaNode for UaObjectIds.RootFolder.
void	loadModel(InputStream inputStream) Load an Information Model into the application's address space.
void	loadModel(URI path) Load an Information Model into the application's address space.
BrowsePathTarget[]	translateBrowsePathToNodeIds(NodeId startingNode, RelativePath relativePath) Request the NodeIds for the nodes that are references from the startingNode using the given path.

Method Detail

getDataTypeConverter

DataTypeConverter getDataTypeConverter()

Returns the DataTypeConverter.

getEncoderContext

EncoderContext getEncoderContext()

Returns the EncoderContext.

getNode

UaNode getNode(ExpandedNodeId nodeId)
        throws UaException

Convenience method for getNode(NodeId) that accepts ExpandedNodeId.

Throws:

UaException

getNode

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

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

Throws:

UaException

getNode

UaNode getNode(NodeId nodeId)
        throws UaException

Find the UaNode object, corresponding to the NodeId. How this is done is upto implementations.

NOTE! It is implementation specific what happens if there is no UaNode instance for given NodeId or given NodeId is null or NodeId.NULL

Parameters:

nodeId - the NodeId

Returns:

the UaNode for the given NodeId

Throws:

UaException - possible error

getNode

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

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

Throws:

UaException

getNode

UaNode getNode(UaNodeId nodeId)
        throws UaException

Convenience method for getNode(NodeId) that accepts UaNodeId.

Throws:

UaException

getNode

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

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

Throws:

UaException

getObjectsFolder

FolderType getObjectsFolder()
                     throws UaException

Returns the UaNode for UaObjectIds.ObjectsFolder.

Throws:

UaException

getRoot

FolderType getRoot()
            throws UaException

Returns the UaNode for UaObjectIds.RootFolder.

Throws:

UaException

loadModel

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

Load an Information Model into the application's address space. NOTE, this method works properly only when used in the server-side implementation, the client side implementation is deprecated.

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 file.

SAXException - if the required XMLReaded cannot be created.

IOException - if the model file cannot be read.

ServiceException - if the AddNodes service call to the server fails

loadModel

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

Load an Information Model into the application's address space. NOTE, this method works properly only when used in the server-side implementation, the client side implementation is deprecated.

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 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.

ServiceException - if the AddNodes service call to the server fails

translateBrowsePathToNodeIds

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

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

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.

Parameters:

startingNode - the node from where to start.

relativePath - the path from the node to follow.

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

void addNode(UaNode node)

Add a (@link UaNode) to the address space.

Parameters:

node - that is added

findNode

UaNode findNode(NodeId id)

Find a (@link UaNode) corresponding to the given NodeId. Effectively this is the same as getNode(NodeId), but returns null if it would have thrown.

getNamespaceTable

NamespaceTable getNamespaceTable()

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

Returns:

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