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

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

Class PubSubGroupTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ReaderGroupTypeNode, WriterGroupTypeNode

public class PubSubGroupTypeNode
extends BaseObjectTypeNode
implements PubSubGroupType

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

GROUP_PROPERTIES, MAX_NETWORK_MESSAGE_SIZE, SECURITY_GROUP_ID, SECURITY_KEY_SERVICES, SECURITY_MODE

Constructor Summary

Constructors

Constructor

Description

PubSubGroupTypeNode(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.structured.KeyValuePair[]	getGroupProperties()	Get the local value of the GroupProperties Node.
PropertyTypeNode	getGroupPropertiesNode()	Get the GroupProperties PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getGroupPropertiesNodeAsync()	Asynchronous implementation of PubSubGroupType.getGroupPropertiesNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxNetworkMessageSize()	Get the local value of the MaxNetworkMessageSize Node.
PropertyTypeNode	getMaxNetworkMessageSizeNode()	Get the MaxNetworkMessageSize PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getMaxNetworkMessageSizeNodeAsync()	Asynchronous implementation of PubSubGroupType.getMaxNetworkMessageSizeNode().
String	getSecurityGroupId()	Get the local value of the SecurityGroupId Node.
PropertyTypeNode	getSecurityGroupIdNode()	Get the SecurityGroupId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSecurityGroupIdNodeAsync()	Asynchronous implementation of PubSubGroupType.getSecurityGroupIdNode().
org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]	getSecurityKeyServices()	Get the local value of the SecurityKeyServices Node.
PropertyTypeNode	getSecurityKeyServicesNode()	Get the SecurityKeyServices PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSecurityKeyServicesNodeAsync()	Asynchronous implementation of PubSubGroupType.getSecurityKeyServicesNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode	getSecurityMode()	Get the local value of the SecurityMode Node.
PropertyTypeNode	getSecurityModeNode()	Get the SecurityMode PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSecurityModeNodeAsync()	Asynchronous implementation of PubSubGroupType.getSecurityModeNode().
PubSubStatusTypeNode	getStatusNode()	Get the Status PubSubStatusType Node, or null if it does not exist.
CompletableFuture<? extends PubSubStatusTypeNode>	getStatusNodeAsync()	Asynchronous implementation of PubSubGroupType.getStatusNode().
org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]	readGroupProperties()	Read the value of the GroupProperties Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]>	readGroupPropertiesAsync()	An asynchronous implementation of PubSubGroupType.readGroupProperties().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readMaxNetworkMessageSize()	Read the value of the MaxNetworkMessageSize Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readMaxNetworkMessageSizeAsync()	An asynchronous implementation of PubSubGroupType.readMaxNetworkMessageSize().
String	readSecurityGroupId()	Read the value of the SecurityGroupId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readSecurityGroupIdAsync()	An asynchronous implementation of PubSubGroupType.readSecurityGroupId().
org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]	readSecurityKeyServices()	Read the value of the SecurityKeyServices Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]>	readSecurityKeyServicesAsync()	An asynchronous implementation of PubSubGroupType.readSecurityKeyServices().
org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode	readSecurityMode()	Read the value of the SecurityMode Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode>	readSecurityModeAsync()	An asynchronous implementation of PubSubGroupType.readSecurityMode().
void	setGroupProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)	Set the local value of the GroupProperties Node.
void	setMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the MaxNetworkMessageSize Node.
void	setSecurityGroupId(String value)	Set the local value of the SecurityGroupId Node.
void	setSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value)	Set the local value of the SecurityKeyServices Node.
void	setSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value)	Set the local value of the SecurityMode Node.
void	writeGroupProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)	Write a new value for the GroupProperties Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeGroupPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] groupProperties)	An asynchronous implementation of PubSubGroupType.writeGroupProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).
void	writeMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the MaxNetworkMessageSize Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxNetworkMessageSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNetworkMessageSize)	An asynchronous implementation of PubSubGroupType.writeMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
void	writeSecurityGroupId(String value)	Write a new value for the SecurityGroupId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecurityGroupIdAsync(String securityGroupId)	An asynchronous implementation of PubSubGroupType.writeSecurityGroupId(java.lang.String).
void	writeSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value)	Write a new value for the SecurityKeyServices Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecurityKeyServicesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] securityKeyServices)	An asynchronous implementation of PubSubGroupType.writeSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]).
void	writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value)	Write a new value for the SecurityMode Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecurityModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode)	An asynchronous implementation of PubSubGroupType.writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode).

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

PubSubGroupTypeNode

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

getSecurityMode

public org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode getSecurityMode()
                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubGroupType

Get the local value of the SecurityMode Node.

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

Specified by:

getSecurityMode in interface PubSubGroupType

Returns:

the local value of the SecurityMode Node.

Throws:

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

setSecurityMode

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

Description copied from interface: PubSubGroupType

Set the local value of the SecurityMode Node.

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

Specified by:

setSecurityMode in interface PubSubGroupType

Parameters:

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

Throws:

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

readSecurityMode

public org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode readSecurityMode()
                                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubGroupType

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

Specified by:

readSecurityMode in interface PubSubGroupType

Returns:

the MessageSecurityMode value read from the server.

Throws:

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

writeSecurityMode

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

Description copied from interface: PubSubGroupType

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

Specified by:

writeSecurityMode in interface PubSubGroupType

Parameters:

value - the MessageSecurityMode value to write to the server.

Throws:

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

readSecurityModeAsync

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

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.readSecurityMode().

Specified by:

readSecurityModeAsync in interface PubSubGroupType

Returns:

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

writeSecurityModeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecurityModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode)

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode).

Specified by:

writeSecurityModeAsync in interface PubSubGroupType

Returns:

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

getSecurityModeNode

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

Description copied from interface: PubSubGroupType

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

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

Specified by:

getSecurityModeNode in interface PubSubGroupType

Returns:

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

getSecurityModeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSecurityModeNodeAsync()

Description copied from interface: PubSubGroupType

Asynchronous implementation of PubSubGroupType.getSecurityModeNode().

Specified by:

getSecurityModeNodeAsync in interface PubSubGroupType

Returns:

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

getSecurityGroupId

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

Description copied from interface: PubSubGroupType

Get the local value of the SecurityGroupId Node.

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

Specified by:

getSecurityGroupId in interface PubSubGroupType

Returns:

the local value of the SecurityGroupId Node.

Throws:

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

setSecurityGroupId

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

Description copied from interface: PubSubGroupType

Set the local value of the SecurityGroupId Node.

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

Specified by:

setSecurityGroupId in interface PubSubGroupType

Parameters:

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

Throws:

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

readSecurityGroupId

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

Description copied from interface: PubSubGroupType

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

Specified by:

readSecurityGroupId in interface PubSubGroupType

Returns:

the String value read from the server.

Throws:

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

writeSecurityGroupId

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

Description copied from interface: PubSubGroupType

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

Specified by:

writeSecurityGroupId in interface PubSubGroupType

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.

readSecurityGroupIdAsync

public CompletableFuture<? extends String> readSecurityGroupIdAsync()

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.readSecurityGroupId().

Specified by:

readSecurityGroupIdAsync in interface PubSubGroupType

Returns:

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

writeSecurityGroupIdAsync

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

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.writeSecurityGroupId(java.lang.String).

Specified by:

writeSecurityGroupIdAsync in interface PubSubGroupType

Returns:

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

getSecurityGroupIdNode

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

Description copied from interface: PubSubGroupType

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

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

Specified by:

getSecurityGroupIdNode in interface PubSubGroupType

Returns:

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

getSecurityGroupIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSecurityGroupIdNodeAsync()

Description copied from interface: PubSubGroupType

Asynchronous implementation of PubSubGroupType.getSecurityGroupIdNode().

Specified by:

getSecurityGroupIdNodeAsync in interface PubSubGroupType

Returns:

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

getSecurityKeyServices

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

Description copied from interface: PubSubGroupType

Get the local value of the SecurityKeyServices Node.

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

Specified by:

getSecurityKeyServices in interface PubSubGroupType

Returns:

the local value of the SecurityKeyServices Node.

Throws:

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

setSecurityKeyServices

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

Description copied from interface: PubSubGroupType

Set the local value of the SecurityKeyServices Node.

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

Specified by:

setSecurityKeyServices in interface PubSubGroupType

Parameters:

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

Throws:

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

readSecurityKeyServices

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

Description copied from interface: PubSubGroupType

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

Specified by:

readSecurityKeyServices in interface PubSubGroupType

Returns:

the EndpointDescription value read from the server.

Throws:

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

writeSecurityKeyServices

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

Description copied from interface: PubSubGroupType

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

Specified by:

writeSecurityKeyServices in interface PubSubGroupType

Parameters:

value - the EndpointDescription value to write to the server.

Throws:

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

readSecurityKeyServicesAsync

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

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.readSecurityKeyServices().

Specified by:

readSecurityKeyServicesAsync in interface PubSubGroupType

Returns:

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

writeSecurityKeyServicesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecurityKeyServicesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] securityKeyServices)

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.writeSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]).

Specified by:

writeSecurityKeyServicesAsync in interface PubSubGroupType

Returns:

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

getSecurityKeyServicesNode

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

Description copied from interface: PubSubGroupType

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

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

Specified by:

getSecurityKeyServicesNode in interface PubSubGroupType

Returns:

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

getSecurityKeyServicesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSecurityKeyServicesNodeAsync()

Description copied from interface: PubSubGroupType

Asynchronous implementation of PubSubGroupType.getSecurityKeyServicesNode().

Specified by:

getSecurityKeyServicesNodeAsync in interface PubSubGroupType

Returns:

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

getMaxNetworkMessageSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxNetworkMessageSize()
                                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubGroupType

Get the local value of the MaxNetworkMessageSize Node.

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

Specified by:

getMaxNetworkMessageSize in interface PubSubGroupType

Returns:

the local value of the MaxNetworkMessageSize Node.

Throws:

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

setMaxNetworkMessageSize

public void setMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubGroupType

Set the local value of the MaxNetworkMessageSize Node.

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

Specified by:

setMaxNetworkMessageSize in interface PubSubGroupType

Parameters:

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

Throws:

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

readMaxNetworkMessageSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readMaxNetworkMessageSize()
                                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubGroupType

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

Specified by:

readMaxNetworkMessageSize in interface PubSubGroupType

Returns:

the UInteger value read from the server.

Throws:

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

writeMaxNetworkMessageSize

public void writeMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubGroupType

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

Specified by:

writeMaxNetworkMessageSize in interface PubSubGroupType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readMaxNetworkMessageSizeAsync

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

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.readMaxNetworkMessageSize().

Specified by:

readMaxNetworkMessageSizeAsync in interface PubSubGroupType

Returns:

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

writeMaxNetworkMessageSizeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxNetworkMessageSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNetworkMessageSize)

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.writeMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeMaxNetworkMessageSizeAsync in interface PubSubGroupType

Returns:

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

getMaxNetworkMessageSizeNode

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

Description copied from interface: PubSubGroupType

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

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

Specified by:

getMaxNetworkMessageSizeNode in interface PubSubGroupType

Returns:

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

getMaxNetworkMessageSizeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getMaxNetworkMessageSizeNodeAsync()

Description copied from interface: PubSubGroupType

Asynchronous implementation of PubSubGroupType.getMaxNetworkMessageSizeNode().

Specified by:

getMaxNetworkMessageSizeNodeAsync in interface PubSubGroupType

Returns:

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

getGroupProperties

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

Description copied from interface: PubSubGroupType

Get the local value of the GroupProperties Node.

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

Specified by:

getGroupProperties in interface PubSubGroupType

Returns:

the local value of the GroupProperties Node.

Throws:

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

setGroupProperties

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

Description copied from interface: PubSubGroupType

Set the local value of the GroupProperties Node.

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

Specified by:

setGroupProperties in interface PubSubGroupType

Parameters:

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

Throws:

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

readGroupProperties

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

Description copied from interface: PubSubGroupType

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

Specified by:

readGroupProperties in interface PubSubGroupType

Returns:

the KeyValuePair value read from the server.

Throws:

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

writeGroupProperties

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

Description copied from interface: PubSubGroupType

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

Specified by:

writeGroupProperties in interface PubSubGroupType

Parameters:

value - the KeyValuePair value to write to the server.

Throws:

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

readGroupPropertiesAsync

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

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.readGroupProperties().

Specified by:

readGroupPropertiesAsync in interface PubSubGroupType

Returns:

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

writeGroupPropertiesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeGroupPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] groupProperties)

Description copied from interface: PubSubGroupType

An asynchronous implementation of PubSubGroupType.writeGroupProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).

Specified by:

writeGroupPropertiesAsync in interface PubSubGroupType

Returns:

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

getGroupPropertiesNode

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

Description copied from interface: PubSubGroupType

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

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

Specified by:

getGroupPropertiesNode in interface PubSubGroupType

Returns:

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

getGroupPropertiesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getGroupPropertiesNodeAsync()

Description copied from interface: PubSubGroupType

Asynchronous implementation of PubSubGroupType.getGroupPropertiesNode().

Specified by:

getGroupPropertiesNodeAsync in interface PubSubGroupType

Returns:

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

getStatusNode

public PubSubStatusTypeNode getStatusNode()
                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubGroupType

Get the Status PubSubStatusType Node, or null if it does not exist.

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

Specified by:

getStatusNode in interface PubSubGroupType

Returns:

the Status PubSubStatusType 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.

getStatusNodeAsync

public CompletableFuture<? extends PubSubStatusTypeNode> getStatusNodeAsync()

Description copied from interface: PubSubGroupType

Asynchronous implementation of PubSubGroupType.getStatusNode().

Specified by:

getStatusNodeAsync in interface PubSubGroupType

Returns:

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