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

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

Class NonTransparentBackupRedundancyTypeNode

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

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

All Implemented Interfaces:

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

public class NonTransparentBackupRedundancyTypeNode
extends NonTransparentRedundancyTypeNode
implements NonTransparentBackupRedundancyType

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

MODE, REDUNDANT_SERVER_ARRAY

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

SERVER_URI_ARRAY

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

REDUNDANCY_SUPPORT, REDUNDANT_SERVER_ARRAY

Constructor Summary

Constructors

Constructor

Description

NonTransparentBackupRedundancyTypeNode(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
org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode	getMode()	Get the local value of the Mode Node.
PropertyTypeNode	getModeNode()	Get the Mode PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getModeNodeAsync()	Asynchronous implementation of NonTransparentBackupRedundancyType.getModeNode().
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().
org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode	readMode()	Read the value of the Mode Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode>	readModeAsync()	An asynchronous implementation of NonTransparentBackupRedundancyType.readMode().
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	setMode(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode value)	Set the local value of the Mode Node.
void	setRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value)	Set the local value of the RedundantServerArray Node.
void	writeMode(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode value)	Write a new value for the Mode Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode mode)	An asynchronous implementation of NonTransparentBackupRedundancyType.writeMode(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode).
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.NonTransparentRedundancyTypeNode

getServerUriArray, getServerUriArrayNode, getServerUriArrayNodeAsync, readServerUriArray, readServerUriArrayAsync, setServerUriArray, writeServerUriArray, writeServerUriArrayAsync

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

getServerUriArray, getServerUriArrayNode, getServerUriArrayNodeAsync, readServerUriArray, readServerUriArrayAsync, setServerUriArray, writeServerUriArray, writeServerUriArrayAsync

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

NonTransparentBackupRedundancyTypeNode

public NonTransparentBackupRedundancyTypeNode(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 NonTransparentBackupRedundancyType

Specified by:

getRedundantServerArray in interface ServerRedundancyType

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 NonTransparentBackupRedundancyType

Specified by:

setRedundantServerArray in interface ServerRedundancyType

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 NonTransparentBackupRedundancyType

Specified by:

readRedundantServerArray in interface ServerRedundancyType

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 NonTransparentBackupRedundancyType

Specified by:

writeRedundantServerArray in interface ServerRedundancyType

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 NonTransparentBackupRedundancyType

Specified by:

readRedundantServerArrayAsync in interface ServerRedundancyType

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 NonTransparentBackupRedundancyType

Specified by:

writeRedundantServerArrayAsync in interface ServerRedundancyType

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 NonTransparentBackupRedundancyType

Specified by:

getRedundantServerArrayNode in interface ServerRedundancyType

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 NonTransparentBackupRedundancyType

Specified by:

getRedundantServerArrayNodeAsync in interface ServerRedundancyType

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.

getMode

public org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode getMode()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NonTransparentBackupRedundancyType

Get the local value of the Mode Node.

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

Specified by:

getMode in interface NonTransparentBackupRedundancyType

Returns:

the local value of the Mode Node.

Throws:

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

setMode

public void setMode(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode value)
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NonTransparentBackupRedundancyType

Set the local value of the Mode Node.

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

Specified by:

setMode in interface NonTransparentBackupRedundancyType

Parameters:

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

Throws:

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

readMode

public org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode readMode()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NonTransparentBackupRedundancyType

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

Specified by:

readMode in interface NonTransparentBackupRedundancyType

Returns:

the RedundantServerMode value read from the server.

Throws:

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

writeMode

public void writeMode(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode value)
               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NonTransparentBackupRedundancyType

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

Specified by:

writeMode in interface NonTransparentBackupRedundancyType

Parameters:

value - the RedundantServerMode value to write to the server.

Throws:

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

readModeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode> readModeAsync()

Description copied from interface: NonTransparentBackupRedundancyType

An asynchronous implementation of NonTransparentBackupRedundancyType.readMode().

Specified by:

readModeAsync in interface NonTransparentBackupRedundancyType

Returns:

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

writeModeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode mode)

Description copied from interface: NonTransparentBackupRedundancyType

An asynchronous implementation of NonTransparentBackupRedundancyType.writeMode(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundantServerMode).

Specified by:

writeModeAsync in interface NonTransparentBackupRedundancyType

Returns:

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

getModeNode

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

Description copied from interface: NonTransparentBackupRedundancyType

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

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

Specified by:

getModeNode in interface NonTransparentBackupRedundancyType

Returns:

the Mode 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.

getModeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getModeNodeAsync()

Description copied from interface: NonTransparentBackupRedundancyType

Asynchronous implementation of NonTransparentBackupRedundancyType.getModeNode().

Specified by:

getModeNodeAsync in interface NonTransparentBackupRedundancyType

Returns:

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