com.digitalpetri.opcua.sdk.server.model

Class UaMethodNode

java.lang.Object

com.digitalpetri.opcua.sdk.server.model.UaNode

com.digitalpetri.opcua.sdk.server.model.UaMethodNode

All Implemented Interfaces:

MethodNode, Node

public class UaMethodNode
extends UaNode
implements MethodNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UaMethodNode.UaMethodNodeBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static Property<com.digitalpetri.opcua.stack.core.types.structured.Argument[]>	InputArguments
static Property<String>	NodeVersion
static Property<com.digitalpetri.opcua.stack.core.types.structured.Argument[]>	OutputArguments

Constructor Summary

Constructors

Constructor and Description

UaMethodNode(UaNamespace namespace, com.digitalpetri.opcua.stack.core.types.builtin.NodeId nodeId, com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName browseName, com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText displayName, Optional<com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText> description, Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> writeMask, Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> userWriteMask, boolean executable, boolean userExecutable)

Method Summary

Modifier and Type	Method and Description
static UaMethodNode.UaMethodNodeBuilder	builder(UaNamespace nodeManager)
List<Node>	getAlwaysGeneratesEventNodes()
com.digitalpetri.opcua.stack.core.types.structured.Argument[]	getInputArguments()
Optional<MethodInvocationHandler>	getInvocationHandler()
Optional<ObjectNode>	getModellingRuleNode()
String	getNodeVersion()
com.digitalpetri.opcua.stack.core.types.structured.Argument[]	getOutputArguments()
List<Node>	getPropertyNodes()
Boolean	isExecutable() The Executable attribute indicates whether the Method is executable, not taking user access rights into account.
Boolean	isUserExecutable() The UserExecutable attribute indicates whether the Method is executable, taking user access rights into account.
void	setExecutable(boolean executable) Set the Executable attribute of this Method.
void	setInputArguments(com.digitalpetri.opcua.stack.core.types.structured.Argument[] inputArguments)
void	setInvocationHandler(MethodInvocationHandler handler)
void	setNodeVersion(String nodeVersion)
void	setOutputArguments(com.digitalpetri.opcua.stack.core.types.structured.Argument[] outputArguments)
void	setUserExecutable(boolean userExecutable) Set the UserExecutable attribute of this Method.

Methods inherited from class com.digitalpetri.opcua.sdk.server.model.UaNode

addAttributeObserver, addProperty, addReference, addReferences, deallocate, fireAttributeChanged, getBrowseName, getDescription, getDisplayName, getNamespace, getNode, getNode, getNodeClass, getNodeId, getObjectComponent, getObjectComponent, getProperty, getProperty, getProperty, getPropertyNode, getPropertyNode, getReferences, getUserWriteMask, getVariableComponent, getVariableComponent, getWriteMask, removeAttributeObserver, removeProperty, removeReference, removeReferences, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.digitalpetri.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, hasAttribute, hasAttribute, readAttribute, readAttribute, readAttribute, readAttribute, readAttribute, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask, writeAttribute, writeAttribute, writeAttribute

Field Detail

InputArguments

public static final Property<com.digitalpetri.opcua.stack.core.types.structured.Argument[]> InputArguments

OutputArguments

public static final Property<com.digitalpetri.opcua.stack.core.types.structured.Argument[]> OutputArguments

NodeVersion

public static final Property<String> NodeVersion

Constructor Detail

UaMethodNode

public UaMethodNode(UaNamespace namespace,
                    com.digitalpetri.opcua.stack.core.types.builtin.NodeId nodeId,
                    com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName browseName,
                    com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText displayName,
                    Optional<com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText> description,
                    Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> writeMask,
                    Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> userWriteMask,
                    boolean executable,
                    boolean userExecutable)

Method Detail

isExecutable

public Boolean isExecutable()

Description copied from interface: MethodNode

The Executable attribute indicates whether the Method is executable, not taking user access rights into account. If the OPC UA Server cannot get the Executable information from the underlying system, it should state that it is executable.

See OPC-UA Part 3, Section 5.7.

Specified by:

isExecutable in interface MethodNode

Returns:

true if this method is executable, not taking user access rights into account.

isUserExecutable

public Boolean isUserExecutable()

Description copied from interface: MethodNode

The UserExecutable attribute indicates whether the Method is executable, taking user access rights into account. If the OPC UA Server cannot get any user rights related information from the underlying system, it should use the same value as used in the Executable attribute.

See OPC-UA Part 3, Section 5.7.

Specified by:

isUserExecutable in interface MethodNode

Returns:

true if this method is executable, taking user access rights into account.

setExecutable

public void setExecutable(boolean executable)

Description copied from interface: MethodNode

Set the Executable attribute of this Method.

Specified by:

setExecutable in interface MethodNode

Parameters:

executable - true if the method is executable.

setUserExecutable

public void setUserExecutable(boolean userExecutable)

Description copied from interface: MethodNode

Set the UserExecutable attribute of this Method.

Specified by:

setUserExecutable in interface MethodNode

Parameters:

userExecutable - true if the method is executable, taking access rights into account.

getPropertyNodes

public List<Node> getPropertyNodes()

getModellingRuleNode

public Optional<ObjectNode> getModellingRuleNode()

getAlwaysGeneratesEventNodes

public List<Node> getAlwaysGeneratesEventNodes()

getInvocationHandler

public Optional<MethodInvocationHandler> getInvocationHandler()

setInvocationHandler

public void setInvocationHandler(MethodInvocationHandler handler)

getNodeVersion

public String getNodeVersion()

getInputArguments

public com.digitalpetri.opcua.stack.core.types.structured.Argument[] getInputArguments()

getOutputArguments

public com.digitalpetri.opcua.stack.core.types.structured.Argument[] getOutputArguments()

setNodeVersion

public void setNodeVersion(String nodeVersion)

setInputArguments

public void setInputArguments(com.digitalpetri.opcua.stack.core.types.structured.Argument[] inputArguments)

setOutputArguments

public void setOutputArguments(com.digitalpetri.opcua.stack.core.types.structured.Argument[] outputArguments)

builder

public static UaMethodNode.UaMethodNodeBuilder builder(UaNamespace nodeManager)

Returns:

a new UaMethodNode.UaMethodNodeBuilder.