com.prosysopc.ua.server.nodes

Class UaMethodNode

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.server.nodes.ServerNode

com.prosysopc.ua.server.nodes.BaseNode

com.prosysopc.ua.server.nodes.UaMethodNode

All Implemented Interfaces:

UaMethod, UaNode

Direct Known Subclasses:

PlainMethod

public class UaMethodNode
extends BaseNode
implements UaMethod

Straight forward implementation of UaMethod.

It keeps all attributes in memory. Additionally, it manages the

Nested Class Summary

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

UaNode.Parameters

Field Summary

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

NODE_VERSION_PROPERTY_NAME, useQuickPropertyLookup

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

eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap

Fields inherited from interface com.prosysopc.ua.nodes.UaMethod

INPUT_ARGUMENTS, OUTPUT_ARGUMENTS

Constructor Summary

Constructors

Modifier	Constructor and Description
	UaMethodNode(NodeManagerUaNode nodeManager, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
	UaMethodNode(NodeManagerUaNode nodeManager, NodeId nodeId, String name, Locale locale)
protected	UaMethodNode(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
NodeAttributes	getAttributes() Returns the current attribute values of the node in a NodeAttributes structure.
protected NodeAttributes	getAttributes(MethodAttributes attributes)
protected void	getAttributesMap(Map<UnsignedInteger,Object> map)
Boolean	getExecutable() The Executable Attribute indicates if the Method is currently executable ('False' means not executable, 'True' means executable).
Argument[]	getInputArguments() The InputArguments Property is used to specify the arguments that shall be used by a client when calling the Method.
NodeClass	getNodeClass() The NodeClass Attribute identifies the NodeClass of a Node.
Argument[]	getOutputArguments() The OutputArguments Property specifies the result returned from the Method call.
Boolean	getUserExecutable() The UserExecutable Attribute indicates if the Method is currently executable taking user access rights into account ('False' means not executable, 'True' means executable).
protected void	initSupportedAttributes(List<UnsignedInteger> l)
protected void	readAttributeValue(UnsignedInteger attributeId, DataValue dataValue) Read the value of an attribute.
void	setAttributes(NodeAttributes methodAttributes) Sets the attributes of the node.
void	setExecutable(Boolean executable)
void	setUserExecutable(Boolean userExecutable)
String	toString()
protected void	writeAttributeValue(UnsignedInteger attributeId, Object value, StatusCode statusCode, DateTime sourceTime, UnsignedShort sourcePicoseconds)

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

addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getAttributesMap, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeVersion, getNodeVersionNode, getProperties, getProperty, getPropertyReference, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, hasTypeDefinition, hasUserWriteAccess, hasWriteAccess, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, setBrowseName, setDescription, setDisplayName, setNodeVersion, setPropertyValue, setUserWriteMask, setWriteMask, writeAttribute

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

addComponent, addOrganizes, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributesMap, getBrowseName, getBrowsePaths, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeId, getNodeVersionNode, getOrganizedNode, getOrganizedNodes, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUaBrowsePaths, getUaNodeId, getUserData, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setBrowseName, setDescription, setDisplayName, setReferences, setUserData, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Constructor Detail

UaMethodNode

public UaMethodNode(NodeManagerUaNode nodeManager,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName)

UaMethodNode

public UaMethodNode(NodeManagerUaNode nodeManager,
                    NodeId nodeId,
                    String name,
                    Locale locale)

Parameters:

nodeId -

name -

locale -

UaMethodNode

protected UaMethodNode(UaNode.Parameters parameters)

Method Detail

getAttributes

public NodeAttributes getAttributes()

Description copied from interface: UaNode

Returns the current attribute values of the node in a NodeAttributes structure.

Specified by:

getAttributes in interface UaNode

Specified by:

getAttributes in class BaseNode

getExecutable

public Boolean getExecutable()

Description copied from interface: UaMethod

The Executable Attribute indicates if the Method is currently executable ('False' means not executable, 'True' means executable). The Executable Attribute does not take any user access rights into account, i.e. although the Method is executable this may be restricted to a certain user / user group.

Specified by:

getExecutable in interface UaMethod

Returns:

the current value of executable.

getInputArguments

public Argument[] getInputArguments()
                             throws MethodArgumentException

Description copied from interface: UaMethod

The InputArguments Property is used to specify the arguments that shall be used by a client when calling the Method.

Specified by:

getInputArguments in interface UaMethod

Returns:

the InputArguments of the method. Should provide an empty list, if no arguments are defined.

Throws:

MethodArgumentException - if the property does not contain valid argument values

getNodeClass

public final NodeClass getNodeClass()

Description copied from interface: UaNode

The NodeClass Attribute identifies the NodeClass of a Node.

Specified by:

getNodeClass in interface UaNode

Overrides:

getNodeClass in class BaseNode

Returns:

the Node Class of the node. This is hard-coded and cannot be changed.

getOutputArguments

public Argument[] getOutputArguments()
                              throws MethodArgumentException

Description copied from interface: UaMethod

The OutputArguments Property specifies the result returned from the Method call.

Specified by:

getOutputArguments in interface UaMethod

Returns:

the OutputArguments of the method. Should provide an empty list, if no arguments are defined.

Throws:

MethodArgumentException - if the property does not contain valid argument values

getUserExecutable

public Boolean getUserExecutable()

Description copied from interface: UaMethod

The UserExecutable Attribute indicates if the Method is currently executable taking user access rights into account ('False' means not executable, 'True' means executable).

Specified by:

getUserExecutable in interface UaMethod

Returns:

the current value of user executable.

setAttributes

public void setAttributes(NodeAttributes methodAttributes)

Description copied from interface: UaNode

Sets the attributes of the node.

Specified by:

setAttributes in interface UaNode

Overrides:

setAttributes in class BaseNode

setExecutable

public void setExecutable(Boolean executable)

Specified by:

setExecutable in interface UaMethod

Parameters:

executable - value to set for executable

See Also:

UaMethod.getExecutable()

setUserExecutable

public void setUserExecutable(Boolean userExecutable)

Specified by:

setUserExecutable in interface UaMethod

Parameters:

userExecutable - value to set for user executable

See Also:

UaMethod.getUserExecutable()

toString

public String toString()

Overrides:

toString in class BaseNode

getAttributes

protected NodeAttributes getAttributes(MethodAttributes attributes)

getAttributesMap

protected void getAttributesMap(Map<UnsignedInteger,Object> map)

Overrides:

getAttributesMap in class BaseNode

initSupportedAttributes

protected void initSupportedAttributes(List<UnsignedInteger> l)

Overrides:

initSupportedAttributes in class ServerNode

readAttributeValue

protected void readAttributeValue(UnsignedInteger attributeId,
                                  DataValue dataValue)
                           throws StatusException

Description copied from class: BaseNode

Read the value of an attribute.

Overrides:

readAttributeValue in class BaseNode

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.

writeAttributeValue

protected void writeAttributeValue(UnsignedInteger attributeId,
                                   Object value,
                                   StatusCode statusCode,
                                   DateTime sourceTime,
                                   UnsignedShort sourcePicoseconds)
                            throws StatusException

Overrides:

writeAttributeValue in class BaseNode

Throws:

StatusException