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

Class UaNode

java.lang.Object

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

All Implemented Interfaces:

Node, UaServerNode

Direct Known Subclasses:

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

public abstract class UaNode
extends Object
implements UaServerNode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UaNode(UaNodeContext context, NodeId nodeId, NodeClass nodeClass, QualifiedName browseName, LocalizedText displayName)
protected	UaNode(UaNodeContext context, 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	addReference(Reference reference) Add reference and its inverse.
void	delete() Delete this Node, its References, and all its child Nodes and their References, recursively.
Optional<UaNode>	findNode(QualifiedName browseName) Find a UaNode with the specified browseName referenced by this node.
Optional<UaNode>	findNode(QualifiedName browseName, Predicate<Reference> references) Find a UaNode with the specified browseName referenced by this node.
Optional<UaNode>	findNode(QualifiedName browseName, Predicate<UaNode> nodePredicate, Predicate<Reference> referencePredicate) Find a UaNode with the specified browseName referenced by this node.
Optional<UaNode>	findNode(String namespaceUri, String browseName, Predicate<UaNode> nodePredicate, Predicate<Reference> referencePredicate) Find a UaNode with a Browse Name of browseName, in namespaceUri, referenced by this node.
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.
Object	getAttribute(AttributeId attributeId) Direct read access to the field for attributeId, bypassing the AttributeFilterChain.
@Nullable AttributeDelegate	getAttributeDelegate() Get the current AttributeDelegate for this node.
QualifiedName	getBrowseName()
LocalizedText	getDescription()
LocalizedText	getDisplayName()
AttributeFilterChain	getFilterChain() Get the AttributeFilterChain for this Node.
protected Optional<UaNode>	getManagedNode(ExpandedNodeId nodeId)
protected Optional<UaNode>	getManagedNode(NodeId nodeId)
NodeClass	getNodeClass()
UaNodeContext	getNodeContext()
NodeId	getNodeId()
NodeManager<UaNode>	getNodeManager()
protected Optional<ObjectNode>	getObjectComponent(QualifiedName browseName)
protected Optional<ObjectNode>	getObjectComponent(String browseName)
protected Optional<ObjectNode>	getObjectComponent(String namespaceUri, String name)
Optional<Object>	getProperty(QualifiedName browseName)
<T> Optional<T>	getProperty(QualifiedProperty<T> 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()
protected Optional<VariableNode>	getVariableComponent(QualifiedName browseName)
protected Optional<VariableNode>	getVariableComponent(String browseName)
protected Optional<VariableNode>	getVariableComponent(String namespaceUri, String name)
UInteger	getWriteMask()
void	removeAttributeObserver(AttributeObserver observer)
void	removeReference(Reference reference) Remove reference and its inverse.
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	setAttribute(AttributeId attributeId, Object value) Direct write access to the field for attributeId, bypassing the AttributeFilterChain.
void	setAttributeDelegate(AttributeDelegate attributeDelegate) Set the AttributeDelegate for this node.
void	setBrowseName(QualifiedName browseName)
void	setDescription(LocalizedText description)
void	setDisplayName(LocalizedText displayName)
void	setNodeClass(NodeClass nodeClass)
void	setNodeId(NodeId nodeId)
<T> void	setProperty(QualifiedProperty<T> property, T value)
void	setUserWriteMask(UInteger userWriteMask)
void	setWriteMask(UInteger writeMask)

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

readAttribute, readAttribute, readAttribute, writeAttribute, writeAttribute

Constructor Detail

UaNode

protected UaNode(UaNodeContext context,
                 NodeId nodeId,
                 NodeClass nodeClass,
                 QualifiedName browseName,
                 LocalizedText displayName)

UaNode

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

Method Detail

getNodeId

public NodeId getNodeId()

Specified by:

getNodeId in interface Node

getNodeClass

public NodeClass getNodeClass()

Specified by:

getNodeClass in interface Node

getBrowseName

public QualifiedName getBrowseName()

Specified by:

getBrowseName in interface Node

getDisplayName

public LocalizedText getDisplayName()

Specified by:

getDisplayName in interface Node

getDescription

public LocalizedText getDescription()

Specified by:

getDescription in interface Node

getWriteMask

public UInteger getWriteMask()

Specified by:

getWriteMask in interface Node

getUserWriteMask

public UInteger getUserWriteMask()

Specified by:

getUserWriteMask in interface Node

setNodeId

public void setNodeId(NodeId nodeId)

Specified by:

setNodeId in interface Node

setNodeClass

public void setNodeClass(NodeClass nodeClass)

Specified by:

setNodeClass in interface Node

setBrowseName

public void setBrowseName(QualifiedName browseName)

Specified by:

setBrowseName in interface Node

setDisplayName

public void setDisplayName(LocalizedText displayName)

Specified by:

setDisplayName in interface Node

setDescription

public void setDescription(LocalizedText description)

Specified by:

setDescription in interface Node

setWriteMask

public void setWriteMask(UInteger writeMask)

Specified by:

setWriteMask in interface Node

setUserWriteMask

public void setUserWriteMask(UInteger userWriteMask)

Specified by:

setUserWriteMask in interface Node

getAttribute

public Object getAttribute(AttributeId attributeId)

Direct read access to the field for attributeId, bypassing the AttributeFilterChain.

Parameters:

attributeId - the AttributeId to get the value for.

Returns:

the value for attributeId.

setAttribute

public void setAttribute(AttributeId attributeId,
                         Object value)

Direct write access to the field for attributeId, bypassing the AttributeFilterChain.

Setting an attribute value invokes fireAttributeChanged(AttributeId, Object), notifying any registered AttributeObservers of the change.

Parameters:

attributeId - the AttributeId to set the value for.

value - the value to set.

delete

public final void delete()

Delete this Node, its References, and all its child Nodes and their References, recursively.

getNodeContext

public final UaNodeContext getNodeContext()

Specified by:

getNodeContext in interface UaServerNode

Returns:

the UaNodeContext for this UaServerNode.

getNodeManager

public final NodeManager<UaNode> getNodeManager()

getManagedNode

protected Optional<UaNode> getManagedNode(NodeId nodeId)

getManagedNode

protected Optional<UaNode> getManagedNode(ExpandedNodeId nodeId)

getReferences

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

Specified by:

getReferences in interface UaServerNode

Returns:

this node's References.

addReference

public void addReference(Reference reference)

Add reference and its inverse.

Specified by:

addReference in interface UaServerNode

Parameters:

reference - the Reference to add.

removeReference

public void removeReference(Reference reference)

Remove reference and its inverse.

Specified by:

removeReference in interface UaServerNode

Parameters:

reference - the Reference to remove.

getProperty

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

getProperty

public Optional<Object> getProperty(QualifiedName browseName)

setProperty

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

getPropertyNode

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

getPropertyNode

public Optional<VariableNode> getPropertyNode(String browseName)

getPropertyNode

public Optional<VariableNode> getPropertyNode(QualifiedName browseName)

findNode

public Optional<UaNode> findNode(QualifiedName browseName)

Find a UaNode with the specified browseName referenced by this node.

Parameters:

browseName - the Browse Name of the target node.

Returns:

the target node, if one was found.

findNode

public Optional<UaNode> findNode(QualifiedName browseName,
                                 Predicate<Reference> references)

Find a UaNode with the specified browseName referenced by this node.

Parameters:

browseName - the Browse Name of the target node.

references - a Predicate used to include/exclude references to follow.

Returns:

the target node, if one was found.

findNode

public Optional<UaNode> findNode(QualifiedName browseName,
                                 Predicate<UaNode> nodePredicate,
                                 Predicate<Reference> referencePredicate)

Find a UaNode with the specified browseName referenced by this node.

Parameters:

browseName - the Browse Name of the target node.

nodePredicate - a Predicate used to include/exclude target Nodes.

referencePredicate - a Predicate used to include/exclude references to follow.

Returns:

the target node, if one was found.

findNode

public Optional<UaNode> findNode(String namespaceUri,
                                 String browseName,
                                 Predicate<UaNode> nodePredicate,
                                 Predicate<Reference> referencePredicate)

Find a UaNode with a Browse Name of browseName, in namespaceUri, referenced by this node.

Parameters:

namespaceUri - the namespace URI of browseName.

browseName - the Browse Name of the target node.

nodePredicate - a Predicate used to include/exclude target Nodes.

referencePredicate - a Predicate used to include/exclude references to follow.

Returns:

the target node, if one was found.

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

public void fireAttributeChanged(AttributeId attributeId,
                                 Object attributeValue)

getFilterChain

public AttributeFilterChain getFilterChain()

Get the AttributeFilterChain for this Node.

Returns:

the AttributeFilterChain for this Node.

setAttributeDelegate

public void setAttributeDelegate(AttributeDelegate attributeDelegate)

Set the AttributeDelegate for this node.

Parameters:

attributeDelegate - the AttributeDelegate.

getAttributeDelegate

@Nullable
public @Nullable AttributeDelegate getAttributeDelegate()

Get the current AttributeDelegate for this node.

Returns:

the current AttributeDelegate for this node.

getAttribute

public DataValue getAttribute(AttributeContext context,
                              AttributeId attributeId)

Description copied from interface: UaServerNode

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

Specified by:

getAttribute in interface UaServerNode

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: UaServerNode

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

Specified by:

setAttribute in interface UaServerNode

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.