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

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

Class NetworkAddressUrlTypeNode

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

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

All Implemented Interfaces:

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

public class NetworkAddressUrlTypeNode
extends NetworkAddressTypeNode
implements NetworkAddressUrlType

Field Summary

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

client

Constructor Summary

Constructors

Constructor

Description

NetworkAddressUrlTypeNode(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	getUrl()	Get the local value of the Url Node.
BaseDataVariableTypeNode	getUrlNode()	Get the Url BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getUrlNodeAsync()	Asynchronous implementation of NetworkAddressUrlType.getUrlNode().
String	readUrl()	Read the value of the Url Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readUrlAsync()	An asynchronous implementation of NetworkAddressUrlType.readUrl().
void	setUrl(String value)	Set the local value of the Url Node.
void	writeUrl(String value)	Write a new value for the Url Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeUrlAsync(String url)	An asynchronous implementation of NetworkAddressUrlType.writeUrl(java.lang.String).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.NetworkAddressTypeNode

getNetworkInterface, getNetworkInterfaceNode, getNetworkInterfaceNodeAsync, readNetworkInterface, readNetworkInterfaceAsync, setNetworkInterface, writeNetworkInterface, writeNetworkInterfaceAsync

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.client.model.objects.NetworkAddressType

getNetworkInterface, getNetworkInterfaceNode, getNetworkInterfaceNodeAsync, readNetworkInterface, readNetworkInterfaceAsync, setNetworkInterface, writeNetworkInterface, writeNetworkInterfaceAsync

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

NetworkAddressUrlTypeNode

public NetworkAddressUrlTypeNode(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

getUrl

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

Description copied from interface: NetworkAddressUrlType

Get the local value of the Url Node.

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

Specified by:

getUrl in interface NetworkAddressUrlType

Returns:

the local value of the Url Node.

Throws:

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

setUrl

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

Description copied from interface: NetworkAddressUrlType

Set the local value of the Url Node.

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

Specified by:

setUrl in interface NetworkAddressUrlType

Parameters:

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

Throws:

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

readUrl

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

Description copied from interface: NetworkAddressUrlType

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

Specified by:

readUrl in interface NetworkAddressUrlType

Returns:

the String value read from the server.

Throws:

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

writeUrl

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

Description copied from interface: NetworkAddressUrlType

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

Specified by:

writeUrl in interface NetworkAddressUrlType

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.

readUrlAsync

public CompletableFuture<? extends String> readUrlAsync()

Description copied from interface: NetworkAddressUrlType

An asynchronous implementation of NetworkAddressUrlType.readUrl().

Specified by:

readUrlAsync in interface NetworkAddressUrlType

Returns:

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

writeUrlAsync

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

Description copied from interface: NetworkAddressUrlType

An asynchronous implementation of NetworkAddressUrlType.writeUrl(java.lang.String).

Specified by:

writeUrlAsync in interface NetworkAddressUrlType

Returns:

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

getUrlNode

public BaseDataVariableTypeNode getUrlNode()
                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NetworkAddressUrlType

Get the Url BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getUrlNode in interface NetworkAddressUrlType

Returns:

the Url BaseDataVariableType 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.

getUrlNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getUrlNodeAsync()

Description copied from interface: NetworkAddressUrlType

Asynchronous implementation of NetworkAddressUrlType.getUrlNode().

Specified by:

getUrlNodeAsync in interface NetworkAddressUrlType

Returns:

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