com.prosysopc.ua.nodes

Interface UaNodeFactory

All Known Implementing Classes:

AbstractUaNodeFactory, UaClientNodeFactory, UaServerNodeFactory

public interface UaNodeFactory

Node Factory is used to create UaNode objects dynamically. You can first register the actual implementation types for different UA NodeClasses and even for specific UA TypeDefinitionIds.

The factory is used through the createNode(com.prosysopc.ua.stack.core.NodeClass, com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.QualifiedName, com.prosysopc.ua.stack.builtintypes.LocalizedText) methods, which construct the objects according to the NodeClass and TypeDefinition, using the previously registered UaNode classes.

Method Summary

Modifier and Type	Method and Description
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, QualifiedName browseName, LocalizedText displayName) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, ExpandedNodeId typeDefinition) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, NodeId typeDefinition) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, String name, Locale locale) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, String name, Locale locale, ExpandedNodeId typeDefinitionId) Create a new Node object based on the nodeClass (or typeDefinition).
UaNode	createNode(NodeClass nodeClass, NodeId nodeId, String name, Locale locale, NodeId typeDefinitionId) Create a new Node object based on the nodeClass (or typeDefinition).
<T extends UaNode> void	registerNodeClass(NodeClass nodeClass, Function<UaNode.Parameters,T> constructor)
<T extends UaNode> void	registerTypeDefinition(UaNodeId typeDefinition, Function<UaNode.Parameters,T> constructor)

Method Detail

createNode

UaNode createNode(NodeClass nodeClass,
                  NodeId nodeId,
                  QualifiedName browseName,
                  LocalizedText displayName)
           throws UaNodeFactoryException

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

browseName - The BrowseName of the new node.

displayName - The DisplayName of the new node.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

UaNode createNode(NodeClass nodeClass,
                  NodeId nodeId,
                  QualifiedName browseName,
                  LocalizedText displayName,
                  ExpandedNodeId typeDefinition)
           throws UaNodeFactoryException

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

browseName - The BrowseName of the new node.

displayName - The DisplayName of the new node.

typeDefinition - Optional type definition to use for the class selection.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

UaNode createNode(NodeClass nodeClass,
                  NodeId nodeId,
                  QualifiedName browseName,
                  LocalizedText displayName,
                  NodeId typeDefinition)
           throws UaNodeFactoryException

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

browseName - The BrowseName of the new node.

displayName - The DisplayName of the new node.

typeDefinition - Optional type definition to use for the class selection.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

UaNode createNode(NodeClass nodeClass,
                  NodeId nodeId,
                  String name,
                  Locale locale)
           throws UaNodeFactoryException

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

name - The name of the new node. The BrowseName and DisplayName are initialized to this.

locale - The locale to use for the DisplayName.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

UaNode createNode(NodeClass nodeClass,
                  NodeId nodeId,
                  String name,
                  Locale locale,
                  ExpandedNodeId typeDefinitionId)
           throws UaNodeFactoryException

Create a new Node object based on the nodeClass (or typeDefinition).

The method creates a new UaNode object. The class of the Node is selected depending on the nodeClass - or if typeDefinition is provided, also on that.

You can register new Node classes per nodeClass or typeDefinition using registerNodeClass(com.prosysopc.ua.stack.core.NodeClass, java.util.function.Function<com.prosysopc.ua.nodes.UaNode.Parameters, T>).

Parameters:

nodeClass - The UA NodeClass

nodeId - The ID of the new node.

name - The name of the new node. The BrowseName and DisplayName are initialized to this.

locale - The locale to use for the DisplayName.

typeDefinitionId - The type definition of the node to create. If there is a specific class registered with the type, a node object of that type is created.

Returns:

a new UaNode of a concrete class type (UaNode is abstract itself).

Throws:

UaNodeFactoryException - if the class cannot be created.

createNode

UaNode createNode(NodeClass nodeClass,
                  NodeId nodeId,
                  String name,
                  Locale locale,
                  NodeId typeDefinitionId)
           throws UaNodeFactoryException

Create a new Node object based on the nodeClass (or typeDefinition).

Throws:

UaNodeFactoryException

See Also:

createNode(NodeClass, NodeId, QualifiedName, LocalizedText, ExpandedNodeId)

registerNodeClass

<T extends UaNode> void registerNodeClass(NodeClass nodeClass,
                                          Function<UaNode.Parameters,T> constructor)
                                   throws UaNodeFactoryException

Throws:

UaNodeFactoryException

registerTypeDefinition

<T extends UaNode> void registerTypeDefinition(UaNodeId typeDefinition,
                                               Function<UaNode.Parameters,T> constructor)
                                        throws UaNodeFactoryException

Throws:

UaNodeFactoryException