BaseNode (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.nodes.AbstractUaNode
- - com.prosysopc.ua.server.nodes.ServerNode
  - - com.prosysopc.ua.server.nodes.BaseNode

All Implemented Interfaces:

UaNode

Direct Known Subclasses:

UaExternalNodeImpl, UaInstanceNode, UaMethodNode, UaTypeNode, UaViewNode
```
public abstract class BaseNode
extends ServerNode
```
Straight forward, server side implementation of UaNode.
It keeps all attributes in memory.
This is an abstract class, as the UA specification does not enable nodes of the generic class. The nodes must be one of the actual types for the specific node classes.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.prosysopc.ua.nodes.UaNode
  UaNode.Parameters

Field Summary

Fields
Modifier and Type	Field and Description
`static QualifiedName`	`NODE_VERSION_PROPERTY_NAME`
`static boolean`	`useQuickPropertyLookup` Deprecated. this flag will be removed in the future; If you use this let support know that this functionality is still needed.

Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode
eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseNode(NodeManagerUaNode nodeManager, NodeId nodeId)`
	`BaseNode(NodeManagerUaNode nodeManager, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)` Create a new node.
	`BaseNode(NodeManagerUaNode nodeManager, NodeId nodeId, String name, Locale locale)`
`protected`	`BaseNode(UaNode.Parameters parameters)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected <T> PlainProperty<T>`	`addPlainProperty(NodeId nodeId, String name)` Creates a new PlainProperty with the given NodeId and Name, which is used to initialize the BrowseName (using the namespaceIndex of the NodeId) and DisplayName (using LocalizedText.NO_LOCALE).
`protected <T> PlainVariable<T>`	`addPlainVariable(NodeId nodeId, String name)` Creates a new PlainVariable with the given NodeId and Name, which is used to initialize the BrowseName (using the namespaceIndex of the NodeId) and DisplayName (using LocalizedText.NO_LOCALE).
`protected void`	`assertTypeSupport(ExpandedNodeId typeDefinition)`
`protected void`	`assertTypeSupport(NodeId typeDefinition)`
`NodeId`	`createNodeId(UaNode parent, String name)` Create a new string type NodeId as ".", where ParentNodeId is the Node Id of the parent converted to string.
`protected NodeId`	`createNodeId(UaNode parent, String name, int namespaceIndex)` Create a new string type NodeId as "_", where ParentNodeId is the Node Id of the parent converted to string.
`protected ReflectiveInstanceProperty`	`createReflectiveInstanceProperty(String name, NodeId instanceDeclarationId)`
`protected ReflectiveInstanceProperty`	`createReflectiveInstanceProperty(String name, NodeId instanceDeclarationId, NodeId nodeId)`
`UaReference`	`deleteReference(ExpandedNodeId targetNodeId, NodeId referenceTypeId, boolean isInverse)` Delete a reference from the node.
`UaReference`	`deleteReference(UaReference reference)` Delete a reference from the node.
`protected boolean`	`doAddProperty(UaProperty property)`
`abstract NodeAttributes`	`getAttributes()` Returns the current attribute values of the node in a NodeAttributes structure.
`protected NodeAttributes`	`getAttributes(NodeAttributes attributes)`
`Map<UnsignedInteger,Object>`	`getAttributesMap()` Returns an unmodifiable `Map` containing the Attributes of the node.
`protected void`	`getAttributesMap(Map<UnsignedInteger,Object> map)`
`QualifiedName`	`getBrowseName()` Nodes have a BrowseName Attribute that is used as a non-localised human-readable name when browsing the AddressSpace to create paths out of BrowseNames.
`UaNode`	`getComponent(QualifiedName componentName)` Get the component, which has the specified name.
`UaNode[]`	`getComponents()` Get a list of components of this node, i.e.
`LocalizedText`	`getDescription()` The optional Description Attribute shall explain the meaning of the Node in a localized text using the same mechanisms for localization as described for the DisplayName.
`LocalizedText`	`getDescription(Locale locale)`
`LocalizedText`	`getDisplayName()` The DisplayName Attribute contains the localised name of the Node.
`LocalizedText`	`getDisplayName(Locale locale)`
`UaMethod`	`getMethod(QualifiedName methodName)` Get the method, which has the specified name.
`NodeClass`	`getNodeClass()` The NodeClass Attribute identifies the NodeClass of a Node.
`String`	`getNodeVersion()`
`UaProperty`	`getNodeVersionNode()` Returns the NodeVersion property.
`UaProperty[]`	`getProperties()` Returns all properties of the node or null if none defined.
`UaProperty`	`getProperty(QualifiedName name)` Get the property with name.
`protected UaReference`	`getPropertyReference(QualifiedName propertyName)` This method should only be called by the SDK itself.
`DataValue`	`getPropertyValue(QualifiedName propertyName)` Get the value of a property.
`protected List<UaReference>`	`getReferencesAsList(Boolean isInverse, NodeId... referenceTypeIds)`
`protected static QualifiedName`	`getStandardBrowseName(String name)`
`protected static LocalizedText`	`getStandardDisplayText(String name)`
`AttributeWriteMask`	`getUserWriteMask()` The optional UserWriteMask Attribute exposes the possibilities of a client to write the Attributes of the Node taking user access rights into account.
`AttributeWriteMask`	`getWriteMask()` The optional WriteMask Attribute exposes the possibilities of a client to write the Attributes of the Node.
`boolean`	`hasProperty(QualifiedName propertyName)`
`protected UaReference`	`hasReference(UaReference reference)`
`boolean`	`hasTypeDefinition()`
`boolean`	`hasUserWriteAccess(UnsignedInteger attributeId)` Checks additional user access rights to the node.
`boolean`	`hasWriteAccess(UnsignedInteger attributeId)` Check the common access rights of a node attribute.
`void`	`incNodeVersion()` Increment NodeVersion property to the next integer value.
`void`	`initNodeVersion()` Initializes NodeVersion property to version number "1".
`protected boolean`	`isChildOfType()`
`DataValue`	`readAttribute(UnsignedInteger attributeId)` Read the current value of an attribute.
`void`	`readAttribute(UnsignedInteger attributeId, DataValue dataValue, Locale locale)`
`protected void`	`readAttributeValue(UnsignedInteger attributeId, DataValue dataValue)` Read the value of an attribute.
`protected CallbackInstanceProperty`	`registerCallbackProperty(String name, NodeId dataTypeId, NodeId typeDefinitionId, UaVariableCallback callback)`
`protected <T> PlainInstanceProperty<T>`	`registerPlainInstanceProperty(String name, NodeId instanceDecalarationId, NodeId dataTypeId)` Register a new property node as a property of this node.
`protected <T> PlainInstanceProperty<T>`	`registerPlainInstanceProperty(String name, NodeId instanceDecalarationId, T initialValue)` Register a new property node as a property of this node.
`protected <T> PlainProperty<T>`	`registerPlainProperty(String name, NodeId dataTypeId)` Register a new property node as a property of this node.
`protected <T> PlainProperty<T>`	`registerPlainProperty(String name, T initialValue)` Register a new property node as a property of this node.
`protected <T> PlainVariable<T>`	`registerPlainVariable(String name, NodeId typeDefinitionId, NodeId dataTypeId)` Create a new variable as a component of this node.
`protected <T> PlainVariable<T>`	`registerPlainVariable(String name, NodeId typeDefinitionId, T initialValue)` Create a new variable as a component of this node.
`protected void`	`registerReflectiveInstanceProperty(String name, NodeId instanceDeclarationId, NodeId dataTypeId)`
`protected ReflectiveInstanceVariable`	`registerReflectiveInstanceVariable(NodeId nodeId, String name, NodeId instanceDecalarationId, NodeId dataTypeId)`
`protected ReflectiveProperty`	`registerReflectiveProperty(NodeId nodeId, String name, NodeId dataTypeId)`
`protected ReflectiveVariable`	`registerReflectiveVariable(NodeId nodeId, String name, NodeId dataTypeId)`
`UaProperty`	`removeProperty(QualifiedName name)` Remove the property with the specified name.
`protected void`	`setAccessLevelRecursively(AccessLevelType accessLevel)`
`static void`	`setAccessLevelRecursively(UaNode node, AccessLevelType accessLevel, NodeId... referenceTypeIds)` Set the access level of the node and all "child nodes", which are referred to it using forward references of the defined types.
`void`	`setAttribute(UnsignedInteger attributeId, DataValue dataValue)` Unconditionally, set the value of the specified attribute.
`void`	`setAttributes(NodeAttributes nodeAttributes)` Sets the attributes of the node.
`void`	`setBrowseName(QualifiedName browseName)` Sets the BrowseName Attribute of the node.
`void`	`setDescription(LocalizedText description)` Sets the Description Attribute of the node.
`void`	`setDisplayName(LocalizedText displayName)` Sets the DisplayName Attribute of the node.
`void`	`setNodeVersion(String nodeVersion)` Set the value of the NodeVersion property.
`void`	`setPropertyValue(QualifiedName propertyName, Object value)` Set the value of a property.
`void`	`setUserWriteMask(AttributeWriteMask userWriteMask)` Sets the UserWriteMask Attribute of the node.
`void`	`setWriteMask(AttributeWriteMask writeMask)` Sets the WriteMask Attribute of the node.
`String`	`toString()`
`boolean`	`writeAttribute(UnsignedInteger attributeId, DataValue dataValue)` Write the attribute value in a node.
`protected void`	`writeAttributeValue(UnsignedInteger attributeId, Object value, StatusCode statusCode, DateTime sourceTime, UnsignedShort sourcePicoseconds)`

Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode
addComponent, addDataChangeListener, addEventListener, addNewReference, addNewReference, addOrganizes, addProperties, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, afterAddReference, afterDeleteReference, beforeAddReference, dataChange, deleteReference, deleteReference, deleteReferences, doDeleteReference, equals, findPlaceholders, fireDataChange, fireEvent, fireEventInParents, getAddressSpace, getDefaultBrowseName, getNodeId, getNodeManager, getNodeSetExtensions, getReference, getReferenceList, getReferences, getSupportedAttributes, getTargetNodes, getUaNodeId, hashCode, initSupportedAttributes, isAddNotifierReferencesToServerObject, isFalseOrNull, isMandatory, isMonitoredForEvents, isTrueOrNull, isType, referenceTypeInherits, removeComponent, removeDataChangeListener, removeEventListener, setAddNotifierReferencesToServerObject, setNodeSetExtensions, setReferences, supportsAttribute, translateBrowsePathToNodeIds, validateHasEventSourceChain, validateHasEventSourceChain

Methods inherited from class com.prosysopc.ua.nodes.AbstractUaNode
getForwardReferences, getInverseReferences, getReferences, getReferences, getUserData, referenceTypeInherits, setUserData

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.prosysopc.ua.nodes.UaNode
addReference, addReference, addReference, getBrowsePaths, getOrganizedNode, getOrganizedNodes, getUaBrowsePaths

- Field Detail
  - NODE_VERSION_PROPERTY_NAME
```
public static final QualifiedName NODE_VERSION_PROPERTY_NAME
```
  - useQuickPropertyLookup
```
@Deprecated
public static boolean useQuickPropertyLookup
```
    Deprecated. this flag will be removed in the future; If you use this let support know that this functionality is still needed.
    
    By default true, but can be set to false to cause getProperty(QualifiedName) to check all references for the purposes of the Property, not an internal look-up-map.
- Constructor Detail
  - BaseNode
```
public BaseNode(NodeManagerUaNode nodeManager,
                NodeId nodeId,
                QualifiedName browseName,
                LocalizedText displayName)
```
    Create a new node.
    
    Parameters:
    
    nodeId -
    
    browseName -
    
    displayName -
  - BaseNode
```
public BaseNode(NodeManagerUaNode nodeManager,
                NodeId nodeId,
                String name,
                Locale locale)
```
  - BaseNode
```
protected BaseNode(NodeManagerUaNode nodeManager,
                   NodeId nodeId)
```
    Parameters:
    
    nodeManager -
  - BaseNode
```
protected BaseNode(UaNode.Parameters parameters)
```
- Method Detail
  - setAccessLevelRecursively
```
public static void setAccessLevelRecursively(UaNode node,
                                             AccessLevelType accessLevel,
                                             NodeId... referenceTypeIds)
```
    Set the access level of the node and all "child nodes", which are referred to it using forward references of the defined types.
    
    Parameters:
    
    node - the node from which to start the recursive setting, if null this method does nothing
    
    accessLevel - the access level to set to all nodes
    
    referenceTypeIds - the reference types to look for child nodes. Default is Aggregates
  - getStandardBrowseName
```
protected static QualifiedName getStandardBrowseName(String name)
```
  - getStandardDisplayText
```
protected static LocalizedText getStandardDisplayText(String name)
```
  - createNodeId
```
public NodeId createNodeId(UaNode parent,
                           String name)
```
    Create a new string type NodeId as ".", where ParentNodeId is the Node Id of the parent converted to string. The NamespaceIndex will be the same as the parent's.
    
    Parameters:
    
    parent - the parent node - must not be null
    
    name - the name of the property, used for both BrowseName and DisplayName
    
    Returns:
  - deleteReference
```
public UaReference deleteReference(ExpandedNodeId targetNodeId,
                                   NodeId referenceTypeId,
                                   boolean isInverse)
```
    Description copied from interface: UaNode
    
    Delete a reference from the node.
    
    Specified by:
    
    deleteReference in interface UaNode
    
    Overrides:
    
    deleteReference in class ServerNode
    
    Parameters:
    
    targetNodeId - The target node of the reference.
    
    referenceTypeId - The exact type of reference.
    
    isInverse - Whether to remove a forward reference. If false, deletes an inverse reference only.
    
    Returns:
    
    the reference that was deleted or null if it did not exist
  - deleteReference
```
public UaReference deleteReference(UaReference reference)
```
    Description copied from interface: UaNode
    
    Delete a reference from the node.
    
    Specified by:
    
    deleteReference in interface UaNode
    
    Overrides:
    
    deleteReference in class ServerNode
    
    Parameters:
    
    reference -
  - getAttributes
```
public abstract NodeAttributes getAttributes()
```
    Description copied from interface: UaNode
    
    Returns the current attribute values of the node in a NodeAttributes structure.
    
    Returns:
  - getAttributesMap
```
public Map<UnsignedInteger,Object> getAttributesMap()
```
    Description copied from interface: UaNode
    
    Returns an unmodifiable Map containing the Attributes of the node. The key is the AttributeId (listed in Attributes) and the value is the Attribute value. NOTE! For mutable Attribute value types (e.g. Value, ArrayDimensions) the value is a clone of the original.
  - getBrowseName
```
public QualifiedName getBrowseName()
```
    Description copied from interface: UaNode
    
    Nodes have a BrowseName Attribute that is used as a non-localised human-readable name when browsing the AddressSpace to create paths out of BrowseNames. The TranslateBrowsePathsToNodeIds Service can be used to follow a path constructed of BrowseNames.
    A BrowseName should never be used to display the name of a Node. The DisplayName should be used instead for this purpose.
    Unlike NodeIds, the BrowseName cannot be used to unambiguously identify a Node. Different Nodes may have the same BrowseName.
    
    Returns:
    
    the Browse Name of the node.
  - getComponent
```
public UaNode getComponent(QualifiedName componentName)
```
    Description copied from interface: UaNode
    
    Get the component, which has the specified name. The method goes through all references of type HasComponent and returns the node with the matching BrowseName.
    
    Parameters:
    
    componentName - the BrowseName of the component to get
    
    Returns:
    
    the component node or null, if no matching component is found.
  - getComponents
```
public UaNode[] getComponents()
```
    Description copied from interface: UaNode
    
    Get a list of components of this node, i.e. target nodes of all forward HasComponent references.
    
    Returns:
    
    the component nodes.
  - getDescription
```
public LocalizedText getDescription()
```
    Description copied from interface: UaNode
    
    The optional Description Attribute shall explain the meaning of the Node in a localized text using the same mechanisms for localization as described for the DisplayName.
    
    Returns:
    
    the Description of the node in the default locale. This may be null.
  - getDescription
```
public LocalizedText getDescription(Locale locale)
```
  - getDisplayName
```
public LocalizedText getDisplayName()
```
    Description copied from interface: UaNode
    
    The DisplayName Attribute contains the localised name of the Node. Clients should use this Attribute if they want to display the name of the Node to the user. They should not use the BrowseName for this purpose. The server may maintain one or more localised representations for each DisplayName. Clients negotiate the locale to be returned when they open a session with the OPC Unified Architecture server. Refer to Part 4 of the specification for a description of session establishment and locales.
    The string part of the DisplayName is restricted to 512 characters.
    
    Returns:
    
    the DisplayName in the default locale
  - getDisplayName
```
public LocalizedText getDisplayName(Locale locale)
```
    Parameters:
    
    locale - The desired locale
    
    Returns:
    
    DisplayName with the specified locale - or default locale, if there is no specific name in the desired locale.
  - getMethod
```
public UaMethod getMethod(QualifiedName methodName)
```
    Description copied from interface: UaNode
    
    Get the method, which has the specified name. Calls getComponent, and converts the node to UaMethod.
    
    Parameters:
    
    methodName -
    
    Returns:
  - getNodeClass
```
public NodeClass getNodeClass()
```
    Description copied from interface: UaNode
    
    The NodeClass Attribute identifies the NodeClass of a Node.
    
    Returns:
    
    the Node Class of the node. This is hard-coded and cannot be changed.
  - getNodeVersion
```
public String getNodeVersion()
```
  - getNodeVersionNode
```
public UaProperty getNodeVersionNode()
```
    Description copied from interface: UaNode
    
    Returns the NodeVersion property. This is an optional property, so it may be null, if the property is not defined.
  - getProperties
```
public UaProperty[] getProperties()
```
    Description copied from interface: UaNode
    
    Returns all properties of the node or null if none defined.
    
    Returns:
    
    all properties of the node or null
  - getProperty
```
public UaProperty getProperty(QualifiedName name)
```
    Get the property with name.
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the property or null, if there is no such property
  - getPropertyValue
```
public DataValue getPropertyValue(QualifiedName propertyName)
                           throws StatusException,
                                  IllegalArgumentException
```
    Get the value of a property.
    
    Parameters:
    
    propertyName -
    
    Returns:
    
    the property value
    
    Throws:
    
    StatusException - If the property value cannot be set
    
    IllegalArgumentException - If the property does not exist
  - getUserWriteMask
```
public AttributeWriteMask getUserWriteMask()
```
    Description copied from interface: UaNode
    
    The optional UserWriteMask Attribute exposes the possibilities of a client to write the Attributes of the Node taking user access rights into account.
    The UserWriteMask Attribute can only further restrict the WriteMask Attribute, when it is set to not writable in the general case that applies for every user.
    
    Returns:
    
    the current WriteUserMask
  - getWriteMask
```
public AttributeWriteMask getWriteMask()
```
    Description copied from interface: UaNode
    
    The optional WriteMask Attribute exposes the possibilities of a client to write the Attributes of the Node. The WriteMask Attribute does not take any user access rights into account, i.e. although an Attribute is writable this may be restricted to a certain user / user group. If the OPC UA server does not have the ability to get the WriteMask information for a specific Attribute from the underlying system, it should state that it is writable. If a write operation is called on the Attribute, the server should transfer this request and return the corresponding StatusCode if such a request is rejected.
    
    Returns:
    
    the current set of attributes, which are writeable.
  - hasProperty
```
public boolean hasProperty(QualifiedName propertyName)
```
  - hasTypeDefinition
```
public boolean hasTypeDefinition()
```
    Returns:
  - hasUserWriteAccess
```
public boolean hasUserWriteAccess(UnsignedInteger attributeId)
```
    Description copied from interface: UaNode
    
    Checks additional user access rights to the node. Always check the common rights first with hasWriteAccess.
    The access rights are checked by default in writeAttribute.
    
    Parameters:
    
    attributeId - the attribute to check
    
    Returns:
    
    true if the attribute may be written to
  - hasWriteAccess
```
public boolean hasWriteAccess(UnsignedInteger attributeId)
```
    Description copied from interface: UaNode
    
    Check the common access rights of a node attribute. Note: Value is not included in WriteMask - should be checked from AccessLevel
    The access rights are checked by default in writeAttribute.
    
    Parameters:
    
    attributeId - the attribute to check
    
    Returns:
    
    true if the attribute may be written to
  - incNodeVersion
```
public void incNodeVersion()
                    throws NumberFormatException
```
    Increment NodeVersion property to the next integer value.
    The NodeVersion property must be initialized with initNodeVersion() before it can be incremented (otherwise it will do nothing). The NodeManagerRoot will actually call incNodeversion automatically for nodes that are part of a ModelChange that is ended with NodeManagerRoot.endModelChange().
    
    Throws:
    
    NumberFormatException - if the current nodeVersion string does not contain a parsable integer
  - initNodeVersion
```
public void initNodeVersion()
```
    Initializes NodeVersion property to version number "1".
    Node's that have the optional NodeVersion Property can participate in a GeneralModelChangeEvent. See NodeManagerRoot.beginModelChange() for how to trigger these events.
  - readAttribute
```
public DataValue readAttribute(UnsignedInteger attributeId)
```
    Read the current value of an attribute.
    
    Parameters:
    
    attributeId -
    
    Returns:
    
    the current data value
    
    See Also:
    
    UaNode.supportsAttribute(UnsignedInteger)
  - readAttribute
```
public final void readAttribute(UnsignedInteger attributeId,
                                DataValue dataValue,
                                Locale locale)
```
  - removeProperty
```
public UaProperty removeProperty(QualifiedName name)
```
    Description copied from interface: UaNode
    
    Remove the property with the specified name.
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the property that was removed or null, if there was no such property
  - setAttribute
```
public void setAttribute(UnsignedInteger attributeId,
                         DataValue dataValue)
                  throws StatusException
```
    Unconditionally, set the value of the specified attribute. To check the access rights and that the attribute is supported by the node, use writeAttribute. The method calls the internal, overridable, writeAttributeValue.
    
    Parameters:
    
    attributeId -
    
    dataValue -
    
    Throws:
    
    StatusException
  - setAttributes
```
public void setAttributes(NodeAttributes nodeAttributes)
```
    Description copied from interface: UaNode
    
    Sets the attributes of the node.
  - setBrowseName
```
public void setBrowseName(QualifiedName browseName)
```
    Description copied from interface: UaNode
    
    Sets the BrowseName Attribute of the node.
  - setDescription
```
public void setDescription(LocalizedText description)
```
    Description copied from interface: UaNode
    
    Sets the Description Attribute of the node.
  - setDisplayName
```
public void setDisplayName(LocalizedText displayName)
```
    Description copied from interface: UaNode
    
    Sets the DisplayName Attribute of the node.
  - setNodeVersion
```
public void setNodeVersion(String nodeVersion)
```
    Set the value of the NodeVersion property.
    
    Parameters:
    
    nodeVersion - a new string value for the version. Internally we try to use this as an Integer, which is incremented, using incNodeVersion()
  - setPropertyValue
```
public void setPropertyValue(QualifiedName propertyName,
                             Object value)
                      throws StatusException,
                             IllegalArgumentException
```
    Set the value of a property.
    
    Parameters:
    
    propertyName -
    
    value -
    
    Throws:
    
    StatusException - If the property value cannot be set
    
    IllegalArgumentException - If the property does not exist
  - setUserWriteMask
```
public void setUserWriteMask(AttributeWriteMask userWriteMask)
```
    Description copied from interface: UaNode
    
    Sets the UserWriteMask Attribute of the node.
  - setWriteMask
```
public void setWriteMask(AttributeWriteMask writeMask)
```
    Description copied from interface: UaNode
    
    Sets the WriteMask Attribute of the node.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class ServerNode
  - writeAttribute
```
public final boolean writeAttribute(UnsignedInteger attributeId,
                                    DataValue dataValue)
                             throws StatusException
```
    Write the attribute value in a node. The methods checks the access rights and that the node type supports the specified attribute before writing the value to the node.
    
    Parameters:
    
    attributeId - the attribute
    
    dataValue - the new value, if this is null, the status of the attribute is set to StatusCode.BAD, otherwise the status and value are used from it
    
    Returns:
    
    true if the write was completed, false if it will complete later, asynchronously
    
    Throws:
    
    StatusException - if the write is not accepted (for above mentioned reasons)
    
    See Also:
    
    UaNode.supportsAttribute(UnsignedInteger)
  - addPlainProperty
```
protected <T> PlainProperty<T> addPlainProperty(NodeId nodeId,
                                                String name)
```
    Creates a new PlainProperty with the given NodeId and Name, which is used to initialize the BrowseName (using the namespaceIndex of the NodeId) and DisplayName (using LocalizedText.NO_LOCALE).
    It also calls addProperty to add the variable to the current node.
    
    Parameters:
    
    nodeId - the Node ID used for the new property
    
    name - The name used initialize the property
    
    Returns:
    
    the new variable
  - addPlainVariable
```
protected <T> PlainVariable<T> addPlainVariable(NodeId nodeId,
                                                String name)
```
    Creates a new PlainVariable with the given NodeId and Name, which is used to initialize the BrowseName (using the namespaceIndex of the NodeId) and DisplayName (using LocalizedText.NO_LOCALE).
    It also calls addComponent to add the variable to the current node.
    
    Parameters:
    
    nodeId - the Node ID used for the new variable
    
    name - The name used initialize the variable.
    
    Returns:
    
    the new variable
  - assertTypeSupport
```
protected void assertTypeSupport(ExpandedNodeId typeDefinition)
```
  - assertTypeSupport
```
protected void assertTypeSupport(NodeId typeDefinition)
```
  - createNodeId
```
protected NodeId createNodeId(UaNode parent,
                              String name,
                              int namespaceIndex)
```
    Create a new string type NodeId as "_", where ParentNodeId is the Node Id of the parent converted to string. The NamespaceIndex will be the same as the parent's.
    
    Parameters:
    
    parent - the parent node - must not be null
    
    name - the name of the property, used for both BrowseName and DisplayName
    
    namespaceIndex - the namespacIndex to use for the NodeId. If you omit it, the namespaceIndex of parent is used.
    
    Returns:
  - createReflectiveInstanceProperty
```
protected ReflectiveInstanceProperty createReflectiveInstanceProperty(String name,
                                                                      NodeId instanceDeclarationId)
                                                               throws SecurityException,
                                                                      NoSuchMethodException,
                                                                      StatusException
```
    Parameters:
    
    name -
    
    instanceDeclarationId -
    
    Returns:
    
    Throws:
    
    StatusException
    
    NoSuchMethodException
    
    SecurityException
  - createReflectiveInstanceProperty
```
protected ReflectiveInstanceProperty createReflectiveInstanceProperty(String name,
                                                                      NodeId instanceDeclarationId,
                                                                      NodeId nodeId)
                                                               throws SecurityException,
                                                                      NoSuchMethodException,
                                                                      StatusException
```
    Parameters:
    
    name -
    
    instanceDeclarationId -
    
    Returns:
    
    Throws:
    
    SecurityException
    
    NoSuchMethodException
    
    StatusException
  - doAddProperty
```
protected boolean doAddProperty(UaProperty property)
```
    Overrides:
    
    doAddProperty in class ServerNode
    
    Parameters:
    
    property -
    
    Returns:
  - getAttributes
```
protected NodeAttributes getAttributes(NodeAttributes attributes)
```
  - getAttributesMap
```
protected void getAttributesMap(Map<UnsignedInteger,Object> map)
```
  - getPropertyReference
```
protected UaReference getPropertyReference(QualifiedName propertyName)
```
    This method should only be called by the SDK itself.
  - getReferencesAsList
```
protected List<UaReference> getReferencesAsList(Boolean isInverse,
                                                NodeId... referenceTypeIds)
```
    Overrides:
    
    getReferencesAsList in class AbstractUaNode
  - hasReference
```
protected UaReference hasReference(UaReference reference)
```
    Overrides:
    
    hasReference in class ServerNode
  - isChildOfType
```
protected boolean isChildOfType()
```
  - readAttributeValue
```
protected void readAttributeValue(UnsignedInteger attributeId,
                                  DataValue dataValue)
                           throws StatusException
```
    Read the value of an attribute.
    
    Parameters:
    
    attributeId - the ID of the attribute to read.
    
    dataValue - the DataValue structure in which the value is set.
    
    Throws:
    
    StatusException - if the attributeId is not valid for this (base) node implementation.
  - registerCallbackProperty
```
protected CallbackInstanceProperty registerCallbackProperty(String name,
                                                            NodeId dataTypeId,
                                                            NodeId typeDefinitionId,
                                                            UaVariableCallback callback)
                                                     throws StatusException
```
    Parameters:
    
    name -
    
    dataTypeId -
    
    typeDefinitionId -
    
    callback -
    
    Throws:
    
    StatusException - if instanceDecalarationId cannot be converted to a variable node
  - registerPlainInstanceProperty
```
protected <T> PlainInstanceProperty<T> registerPlainInstanceProperty(String name,
                                                                     NodeId instanceDecalarationId,
                                                                     NodeId dataTypeId)
                                                              throws StatusException
```
    Register a new property node as a property of this node.
    
    Parameters:
    
    name - the name of the property
    
    dataTypeId - The data type of the property
    
    Returns:
    
    the new property
    
    Throws:
    
    StatusException - if instanceDecalarationId cannot be converted to a variable
  - registerPlainInstanceProperty
```
protected <T> PlainInstanceProperty<T> registerPlainInstanceProperty(String name,
                                                                     NodeId instanceDecalarationId,
                                                                     T initialValue)
                                                              throws StatusException
```
    Register a new property node as a property of this node.
    
    Parameters:
    
    name - the name of the property
    
    initialValue - initial value of the property. This may not be null. If you do not have a valid initialValue, use the overload method, which takes the dataTypeId as parameter. The value is used to determine the type.
    
    Returns:
    
    the new property
    
    Throws:
    
    StatusException - if instanceDecalarationId cannot be converted to a variable
  - registerPlainProperty
```
protected <T> PlainProperty<T> registerPlainProperty(String name,
                                                     NodeId dataTypeId)
```
    Register a new property node as a property of this node.
    
    Parameters:
    
    name - the name of the property
    
    dataTypeId - The data type of the property
    
    Returns:
    
    the new property
  - registerPlainProperty
```
protected <T> PlainProperty<T> registerPlainProperty(String name,
                                                     T initialValue)
```
    Register a new property node as a property of this node.
    
    Parameters:
    
    name - the name of the property
    
    initialValue - initial value of the property. This may not be null. If you do not have a valid initialValue, use the overload method, which takes the dataTypeId as parameter. The value is used to determine the type.
    
    Returns:
    
    the new property
  - registerPlainVariable
```
protected <T> PlainVariable<T> registerPlainVariable(String name,
                                                     NodeId typeDefinitionId,
                                                     NodeId dataTypeId)
```
    Create a new variable as a component of this node.
    
    Parameters:
    
    name - the name of the variable
    
    typeDefinitionId - The type definition of the variable
    
    dataTypeId - The data type of the variable
    
    Returns:
    
    the new variable
  - registerPlainVariable
```
protected <T> PlainVariable<T> registerPlainVariable(String name,
                                                     NodeId typeDefinitionId,
                                                     T initialValue)
```
    Create a new variable as a component of this node.
    
    Parameters:
    
    name - the name of the variable
    
    typeDefinitionId - The type definition of the variable
    
    initialValue - initial value of the property. This may not be null. If you do not have a valid initialValue, use the overload method, which takes the dataTypeId as parameter. The value is used to determine the type.
    
    Returns:
    
    the new variable
  - registerReflectiveInstanceProperty
```
protected void registerReflectiveInstanceProperty(String name,
                                                  NodeId instanceDeclarationId,
                                                  NodeId dataTypeId)
                                           throws IllegalArgumentException
```
    Parameters:
    
    name -
    
    instanceDeclarationId -
    
    dataTypeId -
    
    Throws:
    
    SecurityException
    
    NoSuchMethodException
    
    StatusException - if instanceDecalarationId cannot be converted to a variable node
    
    IllegalArgumentException
  - registerReflectiveInstanceVariable
```
protected ReflectiveInstanceVariable registerReflectiveInstanceVariable(NodeId nodeId,
                                                                        String name,
                                                                        NodeId instanceDecalarationId,
                                                                        NodeId dataTypeId)
                                                                 throws SecurityException,
                                                                        NoSuchMethodException,
                                                                        StatusException
```
    Parameters:
    
    nodeId -
    
    name -
    
    dataTypeId -
    
    instanceDecalarationId -
    
    Returns:
    
    Throws:
    
    NoSuchMethodException
    
    SecurityException
    
    StatusException - if instanceDecalarationId cannot be converted to a variable node
  - registerReflectiveProperty
```
protected ReflectiveProperty registerReflectiveProperty(NodeId nodeId,
                                                        String name,
                                                        NodeId dataTypeId)
                                                 throws SecurityException,
                                                        NoSuchMethodException
```
    Parameters:
    
    nodeId -
    
    name -
    
    dataTypeId -
    
    Returns:
    
    Throws:
    
    NoSuchMethodException
    
    SecurityException
  - registerReflectiveVariable
```
protected ReflectiveVariable registerReflectiveVariable(NodeId nodeId,
                                                        String name,
                                                        NodeId dataTypeId)
                                                 throws SecurityException,
                                                        NoSuchMethodException
```
    Parameters:
    
    nodeId -
    
    name -
    
    dataTypeId -
    
    Returns:
    
    Throws:
    
    NoSuchMethodException
    
    SecurityException
  - setAccessLevelRecursively
```
protected void setAccessLevelRecursively(AccessLevelType accessLevel)
```
    Parameters:
    
    accessLevel -
  - writeAttributeValue
```
protected void writeAttributeValue(UnsignedInteger attributeId,
                                   Object value,
                                   StatusCode statusCode,
                                   DateTime sourceTime,
                                   UnsignedShort sourcePicoseconds)
                            throws StatusException
```
    Overrides:
    
    writeAttributeValue in class ServerNode
    
    Throws:
    
    StatusException

Class BaseNode

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.nodes.UaNode

Field Summary

Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode

Constructor Summary

Method Summary

Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode

Methods inherited from class com.prosysopc.ua.nodes.AbstractUaNode

Methods inherited from class java.lang.Object

Methods inherited from interface com.prosysopc.ua.nodes.UaNode

Field Detail

NODE_VERSION_PROPERTY_NAME

useQuickPropertyLookup

Constructor Detail

BaseNode

BaseNode

BaseNode

BaseNode

Method Detail

setAccessLevelRecursively

getStandardBrowseName

getStandardDisplayText

createNodeId

deleteReference

deleteReference

getAttributes

getAttributesMap

getBrowseName

getComponent

getComponents

getDescription

getDescription

getDisplayName

getDisplayName

getMethod

getNodeClass

getNodeVersion

getNodeVersionNode

getProperties

getProperty

getPropertyValue

getUserWriteMask

getWriteMask

hasProperty

hasTypeDefinition

hasUserWriteAccess

hasWriteAccess

incNodeVersion

initNodeVersion

readAttribute

readAttribute

removeProperty

setAttribute

setAttributes

setBrowseName

setDescription

setDisplayName

setNodeVersion

setPropertyValue

setUserWriteMask

setWriteMask

toString

writeAttribute

addPlainProperty

addPlainVariable

assertTypeSupport

assertTypeSupport

createNodeId

createReflectiveInstanceProperty

createReflectiveInstanceProperty

doAddProperty

getAttributes

getAttributesMap

getPropertyReference

getReferencesAsList

hasReference

isChildOfType

readAttributeValue

registerCallbackProperty