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

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

Class TransparentRedundancyTypeNode

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.ServerRedundancyTypeNode

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

All Implemented Interfaces:

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

public class TransparentRedundancyTypeNode
extends ServerRedundancyTypeNode
implements TransparentRedundancyType

Field Summary

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

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.ServerRedundancyType

REDUNDANCY_SUPPORT, REDUNDANT_SERVER_ARRAY

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.TransparentRedundancyType

CURRENT_SERVER_ID, REDUNDANT_SERVER_ARRAY

Constructor Summary

Constructors

Constructor

Description

TransparentRedundancyTypeNode(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	getCurrentServerId()	Get the local value of the CurrentServerId Node.
PropertyTypeNode	getCurrentServerIdNode()	Get the CurrentServerId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getCurrentServerIdNodeAsync()	Asynchronous implementation of TransparentRedundancyType.getCurrentServerIdNode().
org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]	getRedundantServerArray()	Get the local value of the RedundantServerArray Node.
PropertyTypeNode	getRedundantServerArrayNode()	Get the RedundantServerArray PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getRedundantServerArrayNodeAsync()	Asynchronous implementation of ServerRedundancyType.getRedundantServerArrayNode().
String	readCurrentServerId()	Read the value of the CurrentServerId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readCurrentServerIdAsync()	An asynchronous implementation of TransparentRedundancyType.readCurrentServerId().
org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]	readRedundantServerArray()	Read the value of the RedundantServerArray Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]>	readRedundantServerArrayAsync()	An asynchronous implementation of ServerRedundancyType.readRedundantServerArray().
void	setCurrentServerId(String value)	Set the local value of the CurrentServerId Node.
void	setRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value)	Set the local value of the RedundantServerArray Node.
void	writeCurrentServerId(String value)	Write a new value for the CurrentServerId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCurrentServerIdAsync(String currentServerId)	An asynchronous implementation of TransparentRedundancyType.writeCurrentServerId(java.lang.String).
void	writeRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value)	Write a new value for the RedundantServerArray Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRedundantServerArrayAsync(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] redundantServerArray)	An asynchronous implementation of ServerRedundancyType.writeRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]).

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

getRedundancySupport, getRedundancySupportNode, getRedundancySupportNodeAsync, readRedundancySupport, readRedundancySupportAsync, setRedundancySupport, writeRedundancySupport, writeRedundancySupportAsync

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.ServerRedundancyType

getRedundancySupport, getRedundancySupportNode, getRedundancySupportNodeAsync, readRedundancySupport, readRedundancySupportAsync, setRedundancySupport, writeRedundancySupport, writeRedundancySupportAsync

Constructor Details

TransparentRedundancyTypeNode

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

getRedundantServerArray

public org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] getRedundantServerArray()
                                                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerRedundancyType

Get the local value of the RedundantServerArray Node.

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

Specified by:

getRedundantServerArray in interface ServerRedundancyType

Specified by:

getRedundantServerArray in interface TransparentRedundancyType

Overrides:

getRedundantServerArray in class ServerRedundancyTypeNode

Returns:

the local value of the RedundantServerArray Node.

Throws:

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

setRedundantServerArray

public void setRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerRedundancyType

Set the local value of the RedundantServerArray Node.

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

Specified by:

setRedundantServerArray in interface ServerRedundancyType

Specified by:

setRedundantServerArray in interface TransparentRedundancyType

Overrides:

setRedundantServerArray in class ServerRedundancyTypeNode

Parameters:

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

Throws:

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

readRedundantServerArray

public org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] readRedundantServerArray()
                                                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerRedundancyType

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

Specified by:

readRedundantServerArray in interface ServerRedundancyType

Specified by:

readRedundantServerArray in interface TransparentRedundancyType

Overrides:

readRedundantServerArray in class ServerRedundancyTypeNode

Returns:

the RedundantServerDataType value read from the server.

Throws:

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

writeRedundantServerArray

public void writeRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value)
                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerRedundancyType

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

Specified by:

writeRedundantServerArray in interface ServerRedundancyType

Specified by:

writeRedundantServerArray in interface TransparentRedundancyType

Overrides:

writeRedundantServerArray in class ServerRedundancyTypeNode

Parameters:

value - the RedundantServerDataType value to write to the server.

Throws:

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

readRedundantServerArrayAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]> readRedundantServerArrayAsync()

Description copied from interface: ServerRedundancyType

An asynchronous implementation of ServerRedundancyType.readRedundantServerArray().

Specified by:

readRedundantServerArrayAsync in interface ServerRedundancyType

Specified by:

readRedundantServerArrayAsync in interface TransparentRedundancyType

Overrides:

readRedundantServerArrayAsync in class ServerRedundancyTypeNode

Returns:

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

writeRedundantServerArrayAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRedundantServerArrayAsync(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] redundantServerArray)

Description copied from interface: ServerRedundancyType

An asynchronous implementation of ServerRedundancyType.writeRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[]).

Specified by:

writeRedundantServerArrayAsync in interface ServerRedundancyType

Specified by:

writeRedundantServerArrayAsync in interface TransparentRedundancyType

Overrides:

writeRedundantServerArrayAsync in class ServerRedundancyTypeNode

Returns:

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

getRedundantServerArrayNode

public PropertyTypeNode getRedundantServerArrayNode()
                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerRedundancyType

Get the RedundantServerArray PropertyType Node, or null if it does not exist.

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

Specified by:

getRedundantServerArrayNode in interface ServerRedundancyType

Specified by:

getRedundantServerArrayNode in interface TransparentRedundancyType

Overrides:

getRedundantServerArrayNode in class ServerRedundancyTypeNode

Returns:

the RedundantServerArray PropertyType 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.

getRedundantServerArrayNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getRedundantServerArrayNodeAsync()

Description copied from interface: ServerRedundancyType

Asynchronous implementation of ServerRedundancyType.getRedundantServerArrayNode().

Specified by:

getRedundantServerArrayNodeAsync in interface ServerRedundancyType

Specified by:

getRedundantServerArrayNodeAsync in interface TransparentRedundancyType

Overrides:

getRedundantServerArrayNodeAsync in class ServerRedundancyTypeNode

Returns:

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

getCurrentServerId

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

Description copied from interface: TransparentRedundancyType

Get the local value of the CurrentServerId Node.

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

Specified by:

getCurrentServerId in interface TransparentRedundancyType

Returns:

the local value of the CurrentServerId Node.

Throws:

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

setCurrentServerId

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

Description copied from interface: TransparentRedundancyType

Set the local value of the CurrentServerId Node.

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

Specified by:

setCurrentServerId in interface TransparentRedundancyType

Parameters:

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

Throws:

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

readCurrentServerId

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

Description copied from interface: TransparentRedundancyType

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

Specified by:

readCurrentServerId in interface TransparentRedundancyType

Returns:

the String value read from the server.

Throws:

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

writeCurrentServerId

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

Description copied from interface: TransparentRedundancyType

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

Specified by:

writeCurrentServerId in interface TransparentRedundancyType

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.

readCurrentServerIdAsync

public CompletableFuture<? extends String> readCurrentServerIdAsync()

Description copied from interface: TransparentRedundancyType

An asynchronous implementation of TransparentRedundancyType.readCurrentServerId().

Specified by:

readCurrentServerIdAsync in interface TransparentRedundancyType

Returns:

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

writeCurrentServerIdAsync

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

Description copied from interface: TransparentRedundancyType

An asynchronous implementation of TransparentRedundancyType.writeCurrentServerId(java.lang.String).

Specified by:

writeCurrentServerIdAsync in interface TransparentRedundancyType

Returns:

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

getCurrentServerIdNode

public PropertyTypeNode getCurrentServerIdNode()
                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TransparentRedundancyType

Get the CurrentServerId PropertyType Node, or null if it does not exist.

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

Specified by:

getCurrentServerIdNode in interface TransparentRedundancyType

Returns:

the CurrentServerId PropertyType 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.

getCurrentServerIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getCurrentServerIdNodeAsync()

Description copied from interface: TransparentRedundancyType

Asynchronous implementation of TransparentRedundancyType.getCurrentServerIdNode().

Specified by:

getCurrentServerIdNodeAsync in interface TransparentRedundancyType

Returns:

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