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

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

Class ServerRedundancyTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NonTransparentRedundancyTypeNode, TransparentRedundancyTypeNode

public class ServerRedundancyTypeNode
extends BaseObjectTypeNode
implements ServerRedundancyType

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

Constructor Summary

Constructors

Constructor

Description

ServerRedundancyTypeNode(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.RedundancySupport	getRedundancySupport()	Get the local value of the RedundancySupport Node.
PropertyTypeNode	getRedundancySupportNode()	Get the RedundancySupport PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getRedundancySupportNodeAsync()	Asynchronous implementation of ServerRedundancyType.getRedundancySupportNode().
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.RedundancySupport	readRedundancySupport()	Read the value of the RedundancySupport Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport>	readRedundancySupportAsync()	An asynchronous implementation of ServerRedundancyType.readRedundancySupport().
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	setRedundancySupport(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport value)	Set the local value of the RedundancySupport Node.
void	setRedundantServerArray(org.eclipse.milo.opcua.stack.core.types.structured.RedundantServerDataType[] value)	Set the local value of the RedundantServerArray Node.
void	writeRedundancySupport(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport value)	Write a new value for the RedundancySupport Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRedundancySupportAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport redundancySupport)	An asynchronous implementation of ServerRedundancyType.writeRedundancySupport(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport).
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.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

ServerRedundancyTypeNode

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

getRedundancySupport

public org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport getRedundancySupport()
                                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerRedundancyType

Get the local value of the RedundancySupport Node.

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

Specified by:

getRedundancySupport in interface ServerRedundancyType

Returns:

the local value of the RedundancySupport Node.

Throws:

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

setRedundancySupport

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

Description copied from interface: ServerRedundancyType

Set the local value of the RedundancySupport Node.

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

Specified by:

setRedundancySupport in interface ServerRedundancyType

Parameters:

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

Throws:

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

readRedundancySupport

public org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport readRedundancySupport()
                                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerRedundancyType

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

Specified by:

readRedundancySupport in interface ServerRedundancyType

Returns:

the RedundancySupport value read from the server.

Throws:

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

writeRedundancySupport

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

Description copied from interface: ServerRedundancyType

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

Specified by:

writeRedundancySupport in interface ServerRedundancyType

Parameters:

value - the RedundancySupport value to write to the server.

Throws:

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

readRedundancySupportAsync

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

Description copied from interface: ServerRedundancyType

An asynchronous implementation of ServerRedundancyType.readRedundancySupport().

Specified by:

readRedundancySupportAsync in interface ServerRedundancyType

Returns:

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

writeRedundancySupportAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRedundancySupportAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport redundancySupport)

Description copied from interface: ServerRedundancyType

An asynchronous implementation of ServerRedundancyType.writeRedundancySupport(org.eclipse.milo.opcua.stack.core.types.enumerated.RedundancySupport).

Specified by:

writeRedundancySupportAsync in interface ServerRedundancyType

Returns:

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

getRedundancySupportNode

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

Description copied from interface: ServerRedundancyType

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

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

Specified by:

getRedundancySupportNode in interface ServerRedundancyType

Returns:

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

getRedundancySupportNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getRedundancySupportNodeAsync()

Description copied from interface: ServerRedundancyType

Asynchronous implementation of ServerRedundancyType.getRedundancySupportNode().

Specified by:

getRedundancySupportNodeAsync in interface ServerRedundancyType

Returns:

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

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

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

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

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

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

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

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

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

Returns:

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