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

Class ServerTypeNode

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.nodes.objects.BaseObjectTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.objects.ServerTypeNode

All Implemented Interfaces:

BaseObjectType, ServerType, Node, ObjectNode

public class ServerTypeNode
extends BaseObjectTypeNode
implements ServerType

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.types.objects.ServerType

AUDITING, ESTIMATED_RETURN_TIME, NAMESPACE_ARRAY, SERVER_ARRAY, SERVICE_LEVEL

Constructor Summary

Constructors

Constructor and Description

ServerTypeNode(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.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method and Description
Boolean	getAuditing() Get the local value of the Auditing Node.
PropertyTypeNode	getAuditingNode() Get the Auditing PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getAuditingNodeAsync() Asynchronous implementation of ServerType.getAuditingNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getEstimatedReturnTime() Get the local value of the EstimatedReturnTime Node.
PropertyTypeNode	getEstimatedReturnTimeNode() Get the EstimatedReturnTime PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getEstimatedReturnTimeNodeAsync() Asynchronous implementation of ServerType.getEstimatedReturnTimeNode().
String[]	getNamespaceArray() Get the local value of the NamespaceArray Node.
PropertyTypeNode	getNamespaceArrayNode() Get the NamespaceArray PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getNamespaceArrayNodeAsync() Asynchronous implementation of ServerType.getNamespaceArrayNode().
NamespacesTypeNode	getNamespacesNode() Get the Namespaces NamespacesType Node, or null if it does not exist.
CompletableFuture<? extends NamespacesTypeNode>	getNamespacesNodeAsync() Asynchronous implementation of ServerType.getNamespacesNode().
String[]	getServerArray() Get the local value of the ServerArray Node.
PropertyTypeNode	getServerArrayNode() Get the ServerArray PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getServerArrayNodeAsync() Asynchronous implementation of ServerType.getServerArrayNode().
ServerCapabilitiesTypeNode	getServerCapabilitiesNode() Get the ServerCapabilities ServerCapabilitiesType Node, or null if it does not exist.
CompletableFuture<? extends ServerCapabilitiesTypeNode>	getServerCapabilitiesNodeAsync() Asynchronous implementation of ServerType.getServerCapabilitiesNode().
ServerDiagnosticsTypeNode	getServerDiagnosticsNode() Get the ServerDiagnostics ServerDiagnosticsType Node, or null if it does not exist.
CompletableFuture<? extends ServerDiagnosticsTypeNode>	getServerDiagnosticsNodeAsync() Asynchronous implementation of ServerType.getServerDiagnosticsNode().
ServerRedundancyTypeNode	getServerRedundancyNode() Get the ServerRedundancy ServerRedundancyType Node, or null if it does not exist.
CompletableFuture<? extends ServerRedundancyTypeNode>	getServerRedundancyNodeAsync() Asynchronous implementation of ServerType.getServerRedundancyNode().
org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType	getServerStatus() Get the local value of the ServerStatus Node.
ServerStatusTypeNode	getServerStatusNode() Get the ServerStatus ServerStatusType Node, or null if it does not exist.
CompletableFuture<? extends ServerStatusTypeNode>	getServerStatusNodeAsync() Asynchronous implementation of ServerType.getServerStatusNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	getServiceLevel() Get the local value of the ServiceLevel Node.
PropertyTypeNode	getServiceLevelNode() Get the ServiceLevel PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getServiceLevelNodeAsync() Asynchronous implementation of ServerType.getServiceLevelNode().
VendorServerInfoTypeNode	getVendorServerInfoNode() Get the VendorServerInfo VendorServerInfoType Node, or null if it does not exist.
CompletableFuture<? extends VendorServerInfoTypeNode>	getVendorServerInfoNodeAsync() Asynchronous implementation of ServerType.getVendorServerInfoNode().
Boolean	readAuditing() Read the value of the Auditing Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readAuditingAsync() An asynchronous implementation of ServerType.readAuditing().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readEstimatedReturnTime() Read the value of the EstimatedReturnTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readEstimatedReturnTimeAsync() An asynchronous implementation of ServerType.readEstimatedReturnTime().
String[]	readNamespaceArray() Read the value of the NamespaceArray Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String[]>	readNamespaceArrayAsync() An asynchronous implementation of ServerType.readNamespaceArray().
String[]	readServerArray() Read the value of the ServerArray Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String[]>	readServerArrayAsync() An asynchronous implementation of ServerType.readServerArray().
org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType	readServerStatus() Read the value of the ServerStatus Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType>	readServerStatusAsync() An asynchronous implementation of ServerType.readServerStatus().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	readServiceLevel() Read the value of the ServiceLevel Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte>	readServiceLevelAsync() An asynchronous implementation of ServerType.readServiceLevel().
void	setAuditing(Boolean auditing) Set the local value of the Auditing Node.
void	setEstimatedReturnTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime estimatedReturnTime) Set the local value of the EstimatedReturnTime Node.
void	setNamespaceArray(String[] namespaceArray) Set the local value of the NamespaceArray Node.
void	setServerArray(String[] serverArray) Set the local value of the ServerArray Node.
void	setServerStatus(org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType serverStatus) Set the local value of the ServerStatus Node.
void	setServiceLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte serviceLevel) Set the local value of the ServiceLevel Node.
void	writeAuditing(Boolean auditing) Write a new value for the Auditing Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAuditingAsync(Boolean auditing) An asynchronous implementation of ServerType.writeAuditing(Boolean).
void	writeEstimatedReturnTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime estimatedReturnTime) Write a new value for the EstimatedReturnTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEstimatedReturnTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime estimatedReturnTime) An asynchronous implementation of ServerType.writeEstimatedReturnTime(DateTime).
void	writeNamespaceArray(String[] namespaceArray) Write a new value for the NamespaceArray Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNamespaceArrayAsync(String[] namespaceArray) An asynchronous implementation of ServerType.writeNamespaceArray(String[]).
void	writeServerArray(String[] serverArray) Write a new value for the ServerArray Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeServerArrayAsync(String[] serverArray) An asynchronous implementation of ServerType.writeServerArray(String[]).
void	writeServerStatus(org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType serverStatus) Write a new value for the ServerStatus Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeServerStatusAsync(org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType serverStatus) An asynchronous implementation of ServerType.writeServerStatus(ServerStatusDataType).
void	writeServiceLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte serviceLevel) Write a new value for the ServiceLevel Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeServiceLevelAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte serviceLevel) An asynchronous implementation of ServerType.writeServiceLevel(UByte).

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

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIcon, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersion, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIcon, setNamingRuleAsync, setNodeVersion, writeEventNotifier

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

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getUserWriteMask, getWriteMask, invalidate, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readUserWriteMask, readWriteMask, refresh, refreshAsync, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, 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.ObjectNode

getEventNotifier, setEventNotifier

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

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Constructor Detail

ServerTypeNode

public ServerTypeNode(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.builtin.unsigned.UByte eventNotifier)

Method Detail

getServerArray

public String[] getServerArray()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the local value of the ServerArray Node.

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

Specified by:

getServerArray in interface ServerType

Returns:

the local value of the ServerArray Node.

Throws:

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

setServerArray

public void setServerArray(String[] serverArray)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Set the local value of the ServerArray Node.

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

Specified by:

setServerArray in interface ServerType

Parameters:

serverArray - the local value to set for the ServerArray Node.

Throws:

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

readServerArray

public String[] readServerArray()
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

readServerArray in interface ServerType

Returns:

the String[] value read from the server.

Throws:

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

writeServerArray

public void writeServerArray(String[] serverArray)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

writeServerArray in interface ServerType

Parameters:

serverArray - the String[] value to write to the server.

Throws:

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

readServerArrayAsync

public CompletableFuture<? extends String[]> readServerArrayAsync()

Description copied from interface: ServerType

An asynchronous implementation of ServerType.readServerArray().

Specified by:

readServerArrayAsync in interface ServerType

Returns:

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

writeServerArrayAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeServerArrayAsync(String[] serverArray)

Description copied from interface: ServerType

An asynchronous implementation of ServerType.writeServerArray(String[]).

Specified by:

writeServerArrayAsync in interface ServerType

Returns:

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

getServerArrayNode

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

Description copied from interface: ServerType

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

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

Specified by:

getServerArrayNode in interface ServerType

Returns:

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

getServerArrayNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getServerArrayNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getServerArrayNode().

Specified by:

getServerArrayNodeAsync in interface ServerType

Returns:

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

getNamespaceArray

public String[] getNamespaceArray()
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the local value of the NamespaceArray Node.

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

Specified by:

getNamespaceArray in interface ServerType

Returns:

the local value of the NamespaceArray Node.

Throws:

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

setNamespaceArray

public void setNamespaceArray(String[] namespaceArray)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Set the local value of the NamespaceArray Node.

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

Specified by:

setNamespaceArray in interface ServerType

Parameters:

namespaceArray - the local value to set for the NamespaceArray Node.

Throws:

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

readNamespaceArray

public String[] readNamespaceArray()
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

readNamespaceArray in interface ServerType

Returns:

the String[] value read from the server.

Throws:

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

writeNamespaceArray

public void writeNamespaceArray(String[] namespaceArray)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

writeNamespaceArray in interface ServerType

Parameters:

namespaceArray - the String[] value to write to the server.

Throws:

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

readNamespaceArrayAsync

public CompletableFuture<? extends String[]> readNamespaceArrayAsync()

Description copied from interface: ServerType

An asynchronous implementation of ServerType.readNamespaceArray().

Specified by:

readNamespaceArrayAsync in interface ServerType

Returns:

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

writeNamespaceArrayAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNamespaceArrayAsync(String[] namespaceArray)

Description copied from interface: ServerType

An asynchronous implementation of ServerType.writeNamespaceArray(String[]).

Specified by:

writeNamespaceArrayAsync in interface ServerType

Returns:

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

getNamespaceArrayNode

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

Description copied from interface: ServerType

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

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

Specified by:

getNamespaceArrayNode in interface ServerType

Returns:

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

getNamespaceArrayNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getNamespaceArrayNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getNamespaceArrayNode().

Specified by:

getNamespaceArrayNodeAsync in interface ServerType

Returns:

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

getServiceLevel

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getServiceLevel()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the local value of the ServiceLevel Node.

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

Specified by:

getServiceLevel in interface ServerType

Returns:

the local value of the ServiceLevel Node.

Throws:

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

setServiceLevel

public void setServiceLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte serviceLevel)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Set the local value of the ServiceLevel Node.

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

Specified by:

setServiceLevel in interface ServerType

Parameters:

serviceLevel - the local value to set for the ServiceLevel Node.

Throws:

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

readServiceLevel

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readServiceLevel()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

readServiceLevel in interface ServerType

Returns:

the UByte value read from the server.

Throws:

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

writeServiceLevel

public void writeServiceLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte serviceLevel)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

writeServiceLevel in interface ServerType

Parameters:

serviceLevel - the UByte value to write to the server.

Throws:

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

readServiceLevelAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte> readServiceLevelAsync()

Description copied from interface: ServerType

An asynchronous implementation of ServerType.readServiceLevel().

Specified by:

readServiceLevelAsync in interface ServerType

Returns:

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

writeServiceLevelAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeServiceLevelAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte serviceLevel)

Description copied from interface: ServerType

An asynchronous implementation of ServerType.writeServiceLevel(UByte).

Specified by:

writeServiceLevelAsync in interface ServerType

Returns:

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

getServiceLevelNode

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

Description copied from interface: ServerType

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

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

Specified by:

getServiceLevelNode in interface ServerType

Returns:

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

getServiceLevelNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getServiceLevelNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getServiceLevelNode().

Specified by:

getServiceLevelNodeAsync in interface ServerType

Returns:

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

getAuditing

public Boolean getAuditing()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the local value of the Auditing Node.

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

Specified by:

getAuditing in interface ServerType

Returns:

the local value of the Auditing Node.

Throws:

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

setAuditing

public void setAuditing(Boolean auditing)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Set the local value of the Auditing Node.

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

Specified by:

setAuditing in interface ServerType

Parameters:

auditing - the local value to set for the Auditing Node.

Throws:

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

readAuditing

public Boolean readAuditing()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

readAuditing in interface ServerType

Returns:

the Boolean value read from the server.

Throws:

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

writeAuditing

public void writeAuditing(Boolean auditing)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

writeAuditing in interface ServerType

Parameters:

auditing - the Boolean value to write to the server.

Throws:

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

readAuditingAsync

public CompletableFuture<? extends Boolean> readAuditingAsync()

Description copied from interface: ServerType

An asynchronous implementation of ServerType.readAuditing().

Specified by:

readAuditingAsync in interface ServerType

Returns:

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

writeAuditingAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAuditingAsync(Boolean auditing)

Description copied from interface: ServerType

An asynchronous implementation of ServerType.writeAuditing(Boolean).

Specified by:

writeAuditingAsync in interface ServerType

Returns:

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

getAuditingNode

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

Description copied from interface: ServerType

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

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

Specified by:

getAuditingNode in interface ServerType

Returns:

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

getAuditingNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getAuditingNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getAuditingNode().

Specified by:

getAuditingNodeAsync in interface ServerType

Returns:

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

getEstimatedReturnTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getEstimatedReturnTime()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the local value of the EstimatedReturnTime Node.

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

Specified by:

getEstimatedReturnTime in interface ServerType

Returns:

the local value of the EstimatedReturnTime Node.

Throws:

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

setEstimatedReturnTime

public void setEstimatedReturnTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime estimatedReturnTime)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Set the local value of the EstimatedReturnTime Node.

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

Specified by:

setEstimatedReturnTime in interface ServerType

Parameters:

estimatedReturnTime - the local value to set for the EstimatedReturnTime Node.

Throws:

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

readEstimatedReturnTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readEstimatedReturnTime()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

readEstimatedReturnTime in interface ServerType

Returns:

the DateTime value read from the server.

Throws:

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

writeEstimatedReturnTime

public void writeEstimatedReturnTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime estimatedReturnTime)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

writeEstimatedReturnTime in interface ServerType

Parameters:

estimatedReturnTime - the DateTime value to write to the server.

Throws:

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

readEstimatedReturnTimeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readEstimatedReturnTimeAsync()

Description copied from interface: ServerType

An asynchronous implementation of ServerType.readEstimatedReturnTime().

Specified by:

readEstimatedReturnTimeAsync in interface ServerType

Returns:

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

writeEstimatedReturnTimeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEstimatedReturnTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime estimatedReturnTime)

Description copied from interface: ServerType

An asynchronous implementation of ServerType.writeEstimatedReturnTime(DateTime).

Specified by:

writeEstimatedReturnTimeAsync in interface ServerType

Returns:

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

getEstimatedReturnTimeNode

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

Description copied from interface: ServerType

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

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

Specified by:

getEstimatedReturnTimeNode in interface ServerType

Returns:

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

getEstimatedReturnTimeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getEstimatedReturnTimeNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getEstimatedReturnTimeNode().

Specified by:

getEstimatedReturnTimeNodeAsync in interface ServerType

Returns:

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

getServerStatus

public org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType getServerStatus()
                                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the local value of the ServerStatus Node.

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

Specified by:

getServerStatus in interface ServerType

Returns:

the local value of the ServerStatus Node.

Throws:

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

setServerStatus

public void setServerStatus(org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType serverStatus)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Set the local value of the ServerStatus Node.

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

Specified by:

setServerStatus in interface ServerType

Parameters:

serverStatus - the local value to set for the ServerStatus Node.

Throws:

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

readServerStatus

public org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType readServerStatus()
                                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

readServerStatus in interface ServerType

Returns:

the ServerStatusDataType value read from the server.

Throws:

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

writeServerStatus

public void writeServerStatus(org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType serverStatus)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

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

Specified by:

writeServerStatus in interface ServerType

Parameters:

serverStatus - the ServerStatusDataType value to write to the server.

Throws:

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

readServerStatusAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType> readServerStatusAsync()

Description copied from interface: ServerType

An asynchronous implementation of ServerType.readServerStatus().

Specified by:

readServerStatusAsync in interface ServerType

Returns:

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

writeServerStatusAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeServerStatusAsync(org.eclipse.milo.opcua.stack.core.types.structured.ServerStatusDataType serverStatus)

Description copied from interface: ServerType

An asynchronous implementation of ServerType.writeServerStatus(ServerStatusDataType).

Specified by:

writeServerStatusAsync in interface ServerType

Returns:

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

getServerStatusNode

public ServerStatusTypeNode getServerStatusNode()
                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the ServerStatus ServerStatusType Node, or null if it does not exist.

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

Specified by:

getServerStatusNode in interface ServerType

Returns:

the ServerStatus ServerStatusType 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.

getServerStatusNodeAsync

public CompletableFuture<? extends ServerStatusTypeNode> getServerStatusNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getServerStatusNode().

Specified by:

getServerStatusNodeAsync in interface ServerType

Returns:

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

getServerCapabilitiesNode

public ServerCapabilitiesTypeNode getServerCapabilitiesNode()
                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the ServerCapabilities ServerCapabilitiesType Node, or null if it does not exist.

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

Specified by:

getServerCapabilitiesNode in interface ServerType

Returns:

the ServerCapabilities ServerCapabilitiesType 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.

getServerCapabilitiesNodeAsync

public CompletableFuture<? extends ServerCapabilitiesTypeNode> getServerCapabilitiesNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getServerCapabilitiesNode().

Specified by:

getServerCapabilitiesNodeAsync in interface ServerType

Returns:

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

getServerDiagnosticsNode

public ServerDiagnosticsTypeNode getServerDiagnosticsNode()
                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the ServerDiagnostics ServerDiagnosticsType Node, or null if it does not exist.

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

Specified by:

getServerDiagnosticsNode in interface ServerType

Returns:

the ServerDiagnostics ServerDiagnosticsType 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.

getServerDiagnosticsNodeAsync

public CompletableFuture<? extends ServerDiagnosticsTypeNode> getServerDiagnosticsNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getServerDiagnosticsNode().

Specified by:

getServerDiagnosticsNodeAsync in interface ServerType

Returns:

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

getVendorServerInfoNode

public VendorServerInfoTypeNode getVendorServerInfoNode()
                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the VendorServerInfo VendorServerInfoType Node, or null if it does not exist.

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

Specified by:

getVendorServerInfoNode in interface ServerType

Returns:

the VendorServerInfo VendorServerInfoType 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.

getVendorServerInfoNodeAsync

public CompletableFuture<? extends VendorServerInfoTypeNode> getVendorServerInfoNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getVendorServerInfoNode().

Specified by:

getVendorServerInfoNodeAsync in interface ServerType

Returns:

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

getServerRedundancyNode

public ServerRedundancyTypeNode getServerRedundancyNode()
                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the ServerRedundancy ServerRedundancyType Node, or null if it does not exist.

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

Specified by:

getServerRedundancyNode in interface ServerType

Returns:

the ServerRedundancy ServerRedundancyType 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.

getServerRedundancyNodeAsync

public CompletableFuture<? extends ServerRedundancyTypeNode> getServerRedundancyNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getServerRedundancyNode().

Specified by:

getServerRedundancyNodeAsync in interface ServerType

Returns:

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

getNamespacesNode

public NamespacesTypeNode getNamespacesNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerType

Get the Namespaces NamespacesType Node, or null if it does not exist.

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

Specified by:

getNamespacesNode in interface ServerType

Returns:

the Namespaces NamespacesType 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.

getNamespacesNodeAsync

public CompletableFuture<? extends NamespacesTypeNode> getNamespacesNodeAsync()

Description copied from interface: ServerType

Asynchronous implementation of ServerType.getNamespacesNode().

Specified by:

getNamespacesNodeAsync in interface ServerType

Returns:

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