org.eclipse.milo.opcua.sdk.server.nodes

Class UaNode

java.lang.Object

org.eclipse.milo.opcua.sdk.server.nodes.UaNode

All Implemented Interfaces:

Node, ServerNode

Direct Known Subclasses:

UaDataTypeNode, UaMethodNode, UaObjectNode, UaObjectTypeNode, UaReferenceTypeNode, UaVariableNode, UaVariableTypeNode, UaViewNode

public abstract class UaNode
extends Object
implements ServerNode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UaNode(ServerNodeMap nodeMap, NodeId nodeId, NodeClass nodeClass, QualifiedName browseName, LocalizedText displayName)
protected	UaNode(ServerNodeMap nodeMap, NodeId nodeId, NodeClass nodeClass, QualifiedName browseName, LocalizedText displayName, LocalizedText description, UInteger writeMask, UInteger userWriteMask)

Method Summary

Modifier and Type	Method and Description
void	addAttributeObserver(AttributeObserver observer)
void	addProperty(UaVariableNode node)
void	addReference(Reference reference) Add a Reference to this node.
void	addReferences(Collection<Reference> c) Add References to this node.
protected void	deallocate()
protected void	fireAttributeChanged(AttributeId attributeId, Object attributeValue)
DataValue	getAttribute(AttributeContext context, AttributeId attributeId) Get an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.
QualifiedName	getBrowseName() See OPC-UA Part 3, section 5.2.4.
LocalizedText	getDescription() See OPC-UA Part 3, section 5.2.6.
LocalizedText	getDisplayName() See OPC-UA Part 3, section 5.2.5.
protected Optional<ServerNode>	getNode(ExpandedNodeId nodeId)
protected Optional<ServerNode>	getNode(NodeId nodeId)
NodeClass	getNodeClass() See OPC-UA Part 3, section 5.2.3.
NodeId	getNodeId() See OPC-UA Part 3, section 5.2.2.
ServerNodeMap	getNodeMap()
protected Optional<ObjectNode>	getObjectComponent(QualifiedName browseName)
protected Optional<ObjectNode>	getObjectComponent(String browseName)
protected Optional<ObjectNode>	getObjectComponent(String namespaceUri, String name)
<T> Optional<T>	getProperty(Property<T> property)
<T> Optional<T>	getProperty(QualifiedName browseName)
<T> Optional<T>	getProperty(QualifiedProperty<T> property)
<T> Optional<T>	getProperty(String browseName)
Optional<VariableNode>	getPropertyNode(Property<?> property)
Optional<VariableNode>	getPropertyNode(QualifiedName browseName)
Optional<VariableNode>	getPropertyNode(QualifiedProperty<?> property)
Optional<VariableNode>	getPropertyNode(String browseName)
com.google.common.collect.ImmutableList<Reference>	getReferences()
UInteger	getUserWriteMask() See OPC-UA Part 3, section 5.2.8.
protected Optional<VariableNode>	getVariableComponent(QualifiedName browseName)
protected Optional<VariableNode>	getVariableComponent(String browseName)
protected Optional<VariableNode>	getVariableComponent(String namespaceUri, String name)
UInteger	getWriteMask() See OPC-UA Part 3, section 5.2.7.
void	removeAttributeObserver(AttributeObserver observer)
void	removeProperty(UaVariableNode node)
void	removeReference(Reference reference) Remove a Reference from this node.
void	removeReferences(Collection<Reference> c) Remove References from this node.
void	setAttribute(AttributeContext context, AttributeId attributeId, DataValue value) Set an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.
void	setAttributeDelegate(AttributeDelegate attributeDelegate) Set the AttributeDelegate for this node.
void	setBrowseName(QualifiedName browseName) Set the BrowseName attribute of this Node.
void	setDescription(LocalizedText description) Set the Description attribute of this Node.
void	setDisplayName(LocalizedText displayName) Set the DisplayName attribute of this Node.
void	setNodeClass(NodeClass nodeClass) Set the NodeClass attribute of this Node.
void	setNodeId(NodeId nodeId) Set the NodeId attribute of this Node.
<T> void	setProperty(Property<T> property, T value)
<T> void	setProperty(QualifiedProperty<T> property, T value)
void	setUserWriteMask(UInteger userWriteMask) Set the UserWriteMask attribute of this Node.
void	setWriteMask(UInteger writeMask) Set the WriteMask attribute of this Node.

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

readAttribute, readAttribute, readAttribute, writeAttribute, writeAttribute

Constructor Detail

UaNode

protected UaNode(ServerNodeMap nodeMap,
                 NodeId nodeId,
                 NodeClass nodeClass,
                 QualifiedName browseName,
                 LocalizedText displayName)

UaNode

protected UaNode(ServerNodeMap nodeMap,
                 NodeId nodeId,
                 NodeClass nodeClass,
                 QualifiedName browseName,
                 LocalizedText displayName,
                 LocalizedText description,
                 UInteger writeMask,
                 UInteger userWriteMask)

Method Detail

getNodeId

public NodeId getNodeId()

Description copied from interface: Node

See OPC-UA Part 3, section 5.2.2.

Specified by:

getNodeId in interface Node

Returns:

the NodeId (NodeId) of this node.

getNodeClass

public NodeClass getNodeClass()

Description copied from interface: Node

See OPC-UA Part 3, section 5.2.3.

Specified by:

getNodeClass in interface Node

Returns:

the NodeClass (NodeClass) of this node.

getBrowseName

public QualifiedName getBrowseName()

Description copied from interface: Node

See OPC-UA Part 3, section 5.2.4.

Specified by:

getBrowseName in interface Node

Returns:

the BrowseName (QualifiedName) of this node.

getDisplayName

public LocalizedText getDisplayName()

Description copied from interface: Node

See OPC-UA Part 3, section 5.2.5.

Specified by:

getDisplayName in interface Node

Returns:

the DisplayName (QualifiedName) of this node.

getDescription

public LocalizedText getDescription()

Description copied from interface: Node

See OPC-UA Part 3, section 5.2.6.

Specified by:

getDescription in interface Node

Returns:

if this attribute is present, the Description (LocalizedText).

getWriteMask

public UInteger getWriteMask()

Description copied from interface: Node

See OPC-UA Part 3, section 5.2.7.

Specified by:

getWriteMask in interface Node

Returns:

if this attribute is present, the WriteMask (UInteger).

getUserWriteMask

public UInteger getUserWriteMask()

Description copied from interface: Node

See OPC-UA Part 3, section 5.2.8.

Specified by:

getUserWriteMask in interface Node

Returns:

if this attribute is present, the UserWriteMask (UInteger).

setNodeId

public void setNodeId(NodeId nodeId)

Description copied from interface: Node

Set the NodeId attribute of this Node.

Specified by:

setNodeId in interface Node

Parameters:

nodeId - the NodeId to set.

setNodeClass

public void setNodeClass(NodeClass nodeClass)

Description copied from interface: Node

Set the NodeClass attribute of this Node.

Specified by:

setNodeClass in interface Node

Parameters:

nodeClass - the NodeClass to set.

setBrowseName

public void setBrowseName(QualifiedName browseName)

Description copied from interface: Node

Set the BrowseName attribute of this Node.

Specified by:

setBrowseName in interface Node

Parameters:

browseName - the BrowseName to set.

setDisplayName

public void setDisplayName(LocalizedText displayName)

Description copied from interface: Node

Set the DisplayName attribute of this Node.

Specified by:

setDisplayName in interface Node

Parameters:

displayName - the DisplayName to set.

setDescription

public void setDescription(LocalizedText description)

Description copied from interface: Node

Set the Description attribute of this Node.

Specified by:

setDescription in interface Node

Parameters:

description - the Description to set.

setWriteMask

public void setWriteMask(UInteger writeMask)

Description copied from interface: Node

Set the WriteMask attribute of this Node.

Specified by:

setWriteMask in interface Node

Parameters:

writeMask - the WriteMask to set.

setUserWriteMask

public void setUserWriteMask(UInteger userWriteMask)

Description copied from interface: Node

Set the UserWriteMask attribute of this Node.

Specified by:

setUserWriteMask in interface Node

Parameters:

userWriteMask - the UserWriteMask to set.

getNodeMap

public ServerNodeMap getNodeMap()

getNode

protected Optional<ServerNode> getNode(NodeId nodeId)

getNode

protected Optional<ServerNode> getNode(ExpandedNodeId nodeId)

getReferences

public com.google.common.collect.ImmutableList<Reference> getReferences()

Specified by:

getReferences in interface ServerNode

Returns:

this node's References.

addReference

public void addReference(Reference reference)

Description copied from interface: ServerNode

Add a Reference to this node.

Specified by:

addReference in interface ServerNode

Parameters:

reference - the Reference to add.

addReferences

public void addReferences(Collection<Reference> c)

Description copied from interface: ServerNode

Add References to this node.

Specified by:

addReferences in interface ServerNode

Parameters:

c - the References to add.

removeReference

public void removeReference(Reference reference)

Description copied from interface: ServerNode

Remove a Reference from this node.

Specified by:

removeReference in interface ServerNode

Parameters:

reference - to remove.

removeReferences

public void removeReferences(Collection<Reference> c)

Description copied from interface: ServerNode

Remove References from this node.

Specified by:

removeReferences in interface ServerNode

Parameters:

c - the References to remove.

deallocate

protected void deallocate()

getProperty

public <T> Optional<T> getProperty(Property<T> property)

getProperty

public <T> Optional<T> getProperty(QualifiedProperty<T> property)

getProperty

public <T> Optional<T> getProperty(String browseName)

getProperty

public <T> Optional<T> getProperty(QualifiedName browseName)

setProperty

public <T> void setProperty(Property<T> property,
                            T value)

setProperty

public <T> void setProperty(QualifiedProperty<T> property,
                            T value)

getPropertyNode

public Optional<VariableNode> getPropertyNode(Property<?> property)

getPropertyNode

public Optional<VariableNode> getPropertyNode(QualifiedProperty<?> property)

getPropertyNode

public Optional<VariableNode> getPropertyNode(String browseName)

getPropertyNode

public Optional<VariableNode> getPropertyNode(QualifiedName browseName)

addProperty

public void addProperty(UaVariableNode node)

removeProperty

public void removeProperty(UaVariableNode node)

getObjectComponent

protected Optional<ObjectNode> getObjectComponent(String namespaceUri,
                                                  String name)

getObjectComponent

protected Optional<ObjectNode> getObjectComponent(String browseName)

getObjectComponent

protected Optional<ObjectNode> getObjectComponent(QualifiedName browseName)

getVariableComponent

protected Optional<VariableNode> getVariableComponent(String namespaceUri,
                                                      String name)

getVariableComponent

protected Optional<VariableNode> getVariableComponent(String browseName)

getVariableComponent

protected Optional<VariableNode> getVariableComponent(QualifiedName browseName)

addAttributeObserver

public void addAttributeObserver(AttributeObserver observer)

removeAttributeObserver

public void removeAttributeObserver(AttributeObserver observer)

fireAttributeChanged

protected void fireAttributeChanged(AttributeId attributeId,
                                    Object attributeValue)

setAttributeDelegate

public void setAttributeDelegate(@Nonnull
                                 AttributeDelegate attributeDelegate)

Set the AttributeDelegate for this node.

Shall be non-null. To revert from a custom delegate to default behavior set AttributeDelegate.DEFAULT.

Parameters:

attributeDelegate - the AttributeDelegate.

getAttribute

public DataValue getAttribute(AttributeContext context,
                              AttributeId attributeId)

Description copied from interface: ServerNode

Get an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.

Specified by:

getAttribute in interface ServerNode

Parameters:

context - the AttributeContext to get the attribute in.

attributeId - the AttributeId to get.

Returns:

a DataValue containing the attribute value or a StatusCode describing any failure.

setAttribute

public void setAttribute(AttributeContext context,
                         AttributeId attributeId,
                         DataValue value)
                  throws UaException

Description copied from interface: ServerNode

Set an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.

Specified by:

setAttribute in interface ServerNode

Parameters:

context - the AttributeContext to set the attribute in.

attributeId - the AttributeId to set.

value - the new DataValue to set for the attribute.

Throws:

UaException - if setting the attribute failed for any reason.