Module org.eclipse.milo.opcua.sdk.client

Package org.eclipse.milo.opcua.sdk.client.model.objects

Class NetworkAddressTypeNode

java.lang.Object

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

org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

org.eclipse.milo.opcua.sdk.client.model.objects.BaseObjectTypeNode

org.eclipse.milo.opcua.sdk.client.model.objects.NetworkAddressTypeNode

All Implemented Interfaces:

BaseObjectType, NetworkAddressType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

Direct Known Subclasses:

NetworkAddressUrlTypeNode

public class NetworkAddressTypeNode
extends BaseObjectTypeNode
implements NetworkAddressType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Constructor Summary

Constructors

Constructor

Description

NetworkAddressTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method	Description
String	getNetworkInterface()	Get the local value of the NetworkInterface Node.
SelectionListTypeNode	getNetworkInterfaceNode()	Get the NetworkInterface SelectionListType Node, or null if it does not exist.
CompletableFuture<? extends SelectionListTypeNode>	getNetworkInterfaceNodeAsync()	Asynchronous implementation of NetworkAddressType.getNetworkInterfaceNode().
String	readNetworkInterface()	Read the value of the NetworkInterface Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readNetworkInterfaceAsync()	An asynchronous implementation of NetworkAddressType.readNetworkInterface().
void	setNetworkInterface(String value)	Set the local value of the NetworkInterface Node.
void	writeNetworkInterface(String value)	Write a new value for the NetworkInterface Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNetworkInterfaceAsync(String networkInterface)	An asynchronous implementation of NetworkAddressType.writeNetworkInterface(java.lang.String).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

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.core.nodes.Node

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

getEventNotifier, setEventNotifier

Constructor Details

NetworkAddressTypeNode

public NetworkAddressTypeNode(OpcUaClient client,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
 org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
 org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Details

getNetworkInterface

public String getNetworkInterface()
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NetworkAddressType

Get the local value of the NetworkInterface Node.

The returned value is the last seen; it is not read live from the server.

Specified by:

getNetworkInterface in interface NetworkAddressType

Returns:

the local value of the NetworkInterface Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the NetworkInterface Node.

setNetworkInterface

public void setNetworkInterface(String value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NetworkAddressType

Set the local value of the NetworkInterface Node.

The value is only updated locally; it is not written to the server.

Specified by:

setNetworkInterface in interface NetworkAddressType

Parameters:

value - the local value to set for the NetworkInterface Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the NetworkInterface Node.

readNetworkInterface

public String readNetworkInterface()
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NetworkAddressType

Read the value of the NetworkInterface Node from the server and update the local value if the operation succeeds.

Specified by:

readNetworkInterface in interface NetworkAddressType

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeNetworkInterface

public void writeNetworkInterface(String value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NetworkAddressType

Write a new value for the NetworkInterface Node to the server and update the local value if the operation succeeds.

Specified by:

writeNetworkInterface in interface NetworkAddressType

Parameters:

value - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readNetworkInterfaceAsync

public CompletableFuture<? extends String> readNetworkInterfaceAsync()

Description copied from interface: NetworkAddressType

An asynchronous implementation of NetworkAddressType.readNetworkInterface().

Specified by:

readNetworkInterfaceAsync in interface NetworkAddressType

Returns:

a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

writeNetworkInterfaceAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNetworkInterfaceAsync(String networkInterface)

Description copied from interface: NetworkAddressType

An asynchronous implementation of NetworkAddressType.writeNetworkInterface(java.lang.String).

Specified by:

writeNetworkInterfaceAsync in interface NetworkAddressType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getNetworkInterfaceNode

public SelectionListTypeNode getNetworkInterfaceNode()
                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NetworkAddressType

Get the NetworkInterface SelectionListType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Specified by:

getNetworkInterfaceNode in interface NetworkAddressType

Returns:

the NetworkInterface SelectionListType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getNetworkInterfaceNodeAsync

public CompletableFuture<? extends SelectionListTypeNode> getNetworkInterfaceNodeAsync()

Description copied from interface: NetworkAddressType

Asynchronous implementation of NetworkAddressType.getNetworkInterfaceNode().

Specified by:

getNetworkInterfaceNodeAsync in interface NetworkAddressType

Returns:

a CompletableFuture that completes successfully with the SelectionListType Node or completes exceptionally if an error occurs creating or getting the Node.