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

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

Class PublishSubscribeTypeNode

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

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

All Implemented Interfaces:

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

public class PublishSubscribeTypeNode
extends PubSubKeyServiceTypeNode
implements PublishSubscribeType

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

CONFIGURATION_PROPERTIES, CONFIGURATION_VERSION, DEFAULT_DATAGRAM_PUBLISHER_ID, DEFAULT_SECURITY_KEY_SERVICES, SUPPORTED_TRANSPORT_PROFILES

Constructor Summary

Constructors

Constructor

Description

PublishSubscribeTypeNode(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[]	getConfigurationProperties()	Get the local value of the ConfigurationProperties Node.
PropertyTypeNode	getConfigurationPropertiesNode()	Get the ConfigurationProperties PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getConfigurationPropertiesNodeAsync()	Asynchronous implementation of PublishSubscribeType.getConfigurationPropertiesNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getConfigurationVersion()	Get the local value of the ConfigurationVersion Node.
PropertyTypeNode	getConfigurationVersionNode()	Get the ConfigurationVersion PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getConfigurationVersionNodeAsync()	Asynchronous implementation of PublishSubscribeType.getConfigurationVersionNode().
FolderTypeNode	getDataSetClassesNode()	Get the DataSetClasses FolderType Node, or null if it does not exist.
CompletableFuture<? extends FolderTypeNode>	getDataSetClassesNodeAsync()	Asynchronous implementation of PublishSubscribeType.getDataSetClassesNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong	getDefaultDatagramPublisherId()	Get the local value of the DefaultDatagramPublisherId Node.
PropertyTypeNode	getDefaultDatagramPublisherIdNode()	Get the DefaultDatagramPublisherId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDefaultDatagramPublisherIdNodeAsync()	Asynchronous implementation of PublishSubscribeType.getDefaultDatagramPublisherIdNode().
org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]	getDefaultSecurityKeyServices()	Get the local value of the DefaultSecurityKeyServices Node.
PropertyTypeNode	getDefaultSecurityKeyServicesNode()	Get the DefaultSecurityKeyServices PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDefaultSecurityKeyServicesNodeAsync()	Asynchronous implementation of PublishSubscribeType.getDefaultSecurityKeyServicesNode().
PubSubDiagnosticsRootTypeNode	getDiagnosticsNode()	Get the Diagnostics PubSubDiagnosticsRootType Node, or null if it does not exist.
CompletableFuture<? extends PubSubDiagnosticsRootTypeNode>	getDiagnosticsNodeAsync()	Asynchronous implementation of PublishSubscribeType.getDiagnosticsNode().
DataSetFolderTypeNode	getPublishedDataSetsNode()	Get the PublishedDataSets DataSetFolderType Node, or null if it does not exist.
CompletableFuture<? extends DataSetFolderTypeNode>	getPublishedDataSetsNodeAsync()	Asynchronous implementation of PublishSubscribeType.getPublishedDataSetsNode().
PubSubCapabilitiesTypeNode	getPubSubCapablitiesNode()	Get the PubSubCapablities PubSubCapabilitiesType Node, or null if it does not exist.
CompletableFuture<? extends PubSubCapabilitiesTypeNode>	getPubSubCapablitiesNodeAsync()	Asynchronous implementation of PublishSubscribeType.getPubSubCapablitiesNode().
PubSubConfigurationTypeNode	getPubSubConfigurationNode()	Get the PubSubConfiguration PubSubConfigurationType Node, or null if it does not exist.
CompletableFuture<? extends PubSubConfigurationTypeNode>	getPubSubConfigurationNodeAsync()	Asynchronous implementation of PublishSubscribeType.getPubSubConfigurationNode().
PubSubStatusTypeNode	getStatusNode()	Get the Status PubSubStatusType Node, or null if it does not exist.
CompletableFuture<? extends PubSubStatusTypeNode>	getStatusNodeAsync()	Asynchronous implementation of PublishSubscribeType.getStatusNode().
SubscribedDataSetFolderTypeNode	getSubscribedDataSetsNode()	Get the SubscribedDataSets SubscribedDataSetFolderType Node, or null if it does not exist.
CompletableFuture<? extends SubscribedDataSetFolderTypeNode>	getSubscribedDataSetsNodeAsync()	Asynchronous implementation of PublishSubscribeType.getSubscribedDataSetsNode().
String[]	getSupportedTransportProfiles()	Get the local value of the SupportedTransportProfiles Node.
PropertyTypeNode	getSupportedTransportProfilesNode()	Get the SupportedTransportProfiles PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSupportedTransportProfilesNodeAsync()	Asynchronous implementation of PublishSubscribeType.getSupportedTransportProfilesNode().
org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]	readConfigurationProperties()	Read the value of the ConfigurationProperties Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]>	readConfigurationPropertiesAsync()	An asynchronous implementation of PublishSubscribeType.readConfigurationProperties().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readConfigurationVersion()	Read the value of the ConfigurationVersion 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>	readConfigurationVersionAsync()	An asynchronous implementation of PublishSubscribeType.readConfigurationVersion().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong	readDefaultDatagramPublisherId()	Read the value of the DefaultDatagramPublisherId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong>	readDefaultDatagramPublisherIdAsync()	An asynchronous implementation of PublishSubscribeType.readDefaultDatagramPublisherId().
org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]	readDefaultSecurityKeyServices()	Read the value of the DefaultSecurityKeyServices Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]>	readDefaultSecurityKeyServicesAsync()	An asynchronous implementation of PublishSubscribeType.readDefaultSecurityKeyServices().
String[]	readSupportedTransportProfiles()	Read the value of the SupportedTransportProfiles Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String[]>	readSupportedTransportProfilesAsync()	An asynchronous implementation of PublishSubscribeType.readSupportedTransportProfiles().
void	setConfigurationProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)	Set the local value of the ConfigurationProperties Node.
void	setConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the ConfigurationVersion Node.
void	setDefaultDatagramPublisherId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong value)	Set the local value of the DefaultDatagramPublisherId Node.
void	setDefaultSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value)	Set the local value of the DefaultSecurityKeyServices Node.
void	setSupportedTransportProfiles(String[] value)	Set the local value of the SupportedTransportProfiles Node.
void	writeConfigurationProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)	Write a new value for the ConfigurationProperties Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConfigurationPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] configurationProperties)	An asynchronous implementation of PublishSubscribeType.writeConfigurationProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).
void	writeConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the ConfigurationVersion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConfigurationVersionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger configurationVersion)	An asynchronous implementation of PublishSubscribeType.writeConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
void	writeDefaultDatagramPublisherId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong value)	Write a new value for the DefaultDatagramPublisherId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDefaultDatagramPublisherIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong defaultDatagramPublisherId)	An asynchronous implementation of PublishSubscribeType.writeDefaultDatagramPublisherId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong).
void	writeDefaultSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value)	Write a new value for the DefaultSecurityKeyServices Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDefaultSecurityKeyServicesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] defaultSecurityKeyServices)	An asynchronous implementation of PublishSubscribeType.writeDefaultSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]).
void	writeSupportedTransportProfiles(String[] value)	Write a new value for the SupportedTransportProfiles Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSupportedTransportProfilesAsync(String[] supportedTransportProfiles)	An asynchronous implementation of PublishSubscribeType.writeSupportedTransportProfiles(java.lang.String[]).

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

getKeyPushTargetsNode, getKeyPushTargetsNodeAsync, getSecurityGroupsNode, getSecurityGroupsNodeAsync

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

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

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

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

getEventNotifier, setEventNotifier

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

getKeyPushTargetsNode, getKeyPushTargetsNodeAsync, getSecurityGroupsNode, getSecurityGroupsNodeAsync

Constructor Details

PublishSubscribeTypeNode

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

getSupportedTransportProfiles

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

Description copied from interface: PublishSubscribeType

Get the local value of the SupportedTransportProfiles Node.

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

Specified by:

getSupportedTransportProfiles in interface PublishSubscribeType

Returns:

the local value of the SupportedTransportProfiles Node.

Throws:

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

setSupportedTransportProfiles

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

Description copied from interface: PublishSubscribeType

Set the local value of the SupportedTransportProfiles Node.

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

Specified by:

setSupportedTransportProfiles in interface PublishSubscribeType

Parameters:

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

Throws:

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

readSupportedTransportProfiles

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

Description copied from interface: PublishSubscribeType

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

Specified by:

readSupportedTransportProfiles in interface PublishSubscribeType

Returns:

the String value read from the server.

Throws:

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

writeSupportedTransportProfiles

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeSupportedTransportProfiles in interface PublishSubscribeType

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.

readSupportedTransportProfilesAsync

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

Description copied from interface: PublishSubscribeType

An asynchronous implementation of PublishSubscribeType.readSupportedTransportProfiles().

Specified by:

readSupportedTransportProfilesAsync in interface PublishSubscribeType

Returns:

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

writeSupportedTransportProfilesAsync

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

Description copied from interface: PublishSubscribeType

An asynchronous implementation of PublishSubscribeType.writeSupportedTransportProfiles(java.lang.String[]).

Specified by:

writeSupportedTransportProfilesAsync in interface PublishSubscribeType

Returns:

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

getSupportedTransportProfilesNode

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

Description copied from interface: PublishSubscribeType

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

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

Specified by:

getSupportedTransportProfilesNode in interface PublishSubscribeType

Returns:

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

getSupportedTransportProfilesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSupportedTransportProfilesNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getSupportedTransportProfilesNode().

Specified by:

getSupportedTransportProfilesNodeAsync in interface PublishSubscribeType

Returns:

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

getDefaultDatagramPublisherId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong getDefaultDatagramPublisherId()
                                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

Get the local value of the DefaultDatagramPublisherId Node.

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

Specified by:

getDefaultDatagramPublisherId in interface PublishSubscribeType

Returns:

the local value of the DefaultDatagramPublisherId Node.

Throws:

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

setDefaultDatagramPublisherId

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

Description copied from interface: PublishSubscribeType

Set the local value of the DefaultDatagramPublisherId Node.

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

Specified by:

setDefaultDatagramPublisherId in interface PublishSubscribeType

Parameters:

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

Throws:

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

readDefaultDatagramPublisherId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong readDefaultDatagramPublisherId()
                                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

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

Specified by:

readDefaultDatagramPublisherId in interface PublishSubscribeType

Returns:

the ULong value read from the server.

Throws:

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

writeDefaultDatagramPublisherId

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeDefaultDatagramPublisherId in interface PublishSubscribeType

Parameters:

value - the ULong value to write to the server.

Throws:

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

readDefaultDatagramPublisherIdAsync

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

Description copied from interface: PublishSubscribeType

An asynchronous implementation of PublishSubscribeType.readDefaultDatagramPublisherId().

Specified by:

readDefaultDatagramPublisherIdAsync in interface PublishSubscribeType

Returns:

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

writeDefaultDatagramPublisherIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDefaultDatagramPublisherIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong defaultDatagramPublisherId)

Description copied from interface: PublishSubscribeType

An asynchronous implementation of PublishSubscribeType.writeDefaultDatagramPublisherId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong).

Specified by:

writeDefaultDatagramPublisherIdAsync in interface PublishSubscribeType

Returns:

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

getDefaultDatagramPublisherIdNode

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

Description copied from interface: PublishSubscribeType

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

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

Specified by:

getDefaultDatagramPublisherIdNode in interface PublishSubscribeType

Returns:

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

getDefaultDatagramPublisherIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDefaultDatagramPublisherIdNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getDefaultDatagramPublisherIdNode().

Specified by:

getDefaultDatagramPublisherIdNodeAsync in interface PublishSubscribeType

Returns:

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

getConfigurationVersion

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

Description copied from interface: PublishSubscribeType

Get the local value of the ConfigurationVersion Node.

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

Specified by:

getConfigurationVersion in interface PublishSubscribeType

Returns:

the local value of the ConfigurationVersion Node.

Throws:

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

setConfigurationVersion

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

Description copied from interface: PublishSubscribeType

Set the local value of the ConfigurationVersion Node.

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

Specified by:

setConfigurationVersion in interface PublishSubscribeType

Parameters:

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

Throws:

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

readConfigurationVersion

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

Description copied from interface: PublishSubscribeType

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

Specified by:

readConfigurationVersion in interface PublishSubscribeType

Returns:

the UInteger value read from the server.

Throws:

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

writeConfigurationVersion

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeConfigurationVersion in interface PublishSubscribeType

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.

readConfigurationVersionAsync

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

Description copied from interface: PublishSubscribeType

An asynchronous implementation of PublishSubscribeType.readConfigurationVersion().

Specified by:

readConfigurationVersionAsync in interface PublishSubscribeType

Returns:

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

writeConfigurationVersionAsync

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeConfigurationVersionAsync in interface PublishSubscribeType

Returns:

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

getConfigurationVersionNode

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

Description copied from interface: PublishSubscribeType

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

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

Specified by:

getConfigurationVersionNode in interface PublishSubscribeType

Returns:

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

getConfigurationVersionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getConfigurationVersionNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getConfigurationVersionNode().

Specified by:

getConfigurationVersionNodeAsync in interface PublishSubscribeType

Returns:

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

getDefaultSecurityKeyServices

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

Description copied from interface: PublishSubscribeType

Get the local value of the DefaultSecurityKeyServices Node.

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

Specified by:

getDefaultSecurityKeyServices in interface PublishSubscribeType

Returns:

the local value of the DefaultSecurityKeyServices Node.

Throws:

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

setDefaultSecurityKeyServices

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

Description copied from interface: PublishSubscribeType

Set the local value of the DefaultSecurityKeyServices Node.

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

Specified by:

setDefaultSecurityKeyServices in interface PublishSubscribeType

Parameters:

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

Throws:

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

readDefaultSecurityKeyServices

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

Description copied from interface: PublishSubscribeType

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

Specified by:

readDefaultSecurityKeyServices in interface PublishSubscribeType

Returns:

the EndpointDescription value read from the server.

Throws:

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

writeDefaultSecurityKeyServices

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeDefaultSecurityKeyServices in interface PublishSubscribeType

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.

readDefaultSecurityKeyServicesAsync

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

Description copied from interface: PublishSubscribeType

An asynchronous implementation of PublishSubscribeType.readDefaultSecurityKeyServices().

Specified by:

readDefaultSecurityKeyServicesAsync in interface PublishSubscribeType

Returns:

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

writeDefaultSecurityKeyServicesAsync

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeDefaultSecurityKeyServicesAsync in interface PublishSubscribeType

Returns:

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

getDefaultSecurityKeyServicesNode

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

Description copied from interface: PublishSubscribeType

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

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

Specified by:

getDefaultSecurityKeyServicesNode in interface PublishSubscribeType

Returns:

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

getDefaultSecurityKeyServicesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDefaultSecurityKeyServicesNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getDefaultSecurityKeyServicesNode().

Specified by:

getDefaultSecurityKeyServicesNodeAsync in interface PublishSubscribeType

Returns:

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

getConfigurationProperties

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

Description copied from interface: PublishSubscribeType

Get the local value of the ConfigurationProperties Node.

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

Specified by:

getConfigurationProperties in interface PublishSubscribeType

Returns:

the local value of the ConfigurationProperties Node.

Throws:

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

setConfigurationProperties

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

Description copied from interface: PublishSubscribeType

Set the local value of the ConfigurationProperties Node.

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

Specified by:

setConfigurationProperties in interface PublishSubscribeType

Parameters:

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

Throws:

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

readConfigurationProperties

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

Description copied from interface: PublishSubscribeType

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

Specified by:

readConfigurationProperties in interface PublishSubscribeType

Returns:

the KeyValuePair value read from the server.

Throws:

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

writeConfigurationProperties

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeConfigurationProperties in interface PublishSubscribeType

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.

readConfigurationPropertiesAsync

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

Description copied from interface: PublishSubscribeType

An asynchronous implementation of PublishSubscribeType.readConfigurationProperties().

Specified by:

readConfigurationPropertiesAsync in interface PublishSubscribeType

Returns:

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

writeConfigurationPropertiesAsync

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

Description copied from interface: PublishSubscribeType

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

Specified by:

writeConfigurationPropertiesAsync in interface PublishSubscribeType

Returns:

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

getConfigurationPropertiesNode

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

Description copied from interface: PublishSubscribeType

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

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

Specified by:

getConfigurationPropertiesNode in interface PublishSubscribeType

Returns:

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

getConfigurationPropertiesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getConfigurationPropertiesNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getConfigurationPropertiesNode().

Specified by:

getConfigurationPropertiesNodeAsync in interface PublishSubscribeType

Returns:

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

getPublishedDataSetsNode

public DataSetFolderTypeNode getPublishedDataSetsNode()
                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

Get the PublishedDataSets DataSetFolderType Node, or null if it does not exist.

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

Specified by:

getPublishedDataSetsNode in interface PublishSubscribeType

Returns:

the PublishedDataSets DataSetFolderType 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.

getPublishedDataSetsNodeAsync

public CompletableFuture<? extends DataSetFolderTypeNode> getPublishedDataSetsNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getPublishedDataSetsNode().

Specified by:

getPublishedDataSetsNodeAsync in interface PublishSubscribeType

Returns:

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

getSubscribedDataSetsNode

public SubscribedDataSetFolderTypeNode getSubscribedDataSetsNode()
                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

Get the SubscribedDataSets SubscribedDataSetFolderType Node, or null if it does not exist.

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

Specified by:

getSubscribedDataSetsNode in interface PublishSubscribeType

Returns:

the SubscribedDataSets SubscribedDataSetFolderType 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.

getSubscribedDataSetsNodeAsync

public CompletableFuture<? extends SubscribedDataSetFolderTypeNode> getSubscribedDataSetsNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getSubscribedDataSetsNode().

Specified by:

getSubscribedDataSetsNodeAsync in interface PublishSubscribeType

Returns:

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

getPubSubConfigurationNode

public PubSubConfigurationTypeNode getPubSubConfigurationNode()
                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

Get the PubSubConfiguration PubSubConfigurationType Node, or null if it does not exist.

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

Specified by:

getPubSubConfigurationNode in interface PublishSubscribeType

Returns:

the PubSubConfiguration PubSubConfigurationType 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.

getPubSubConfigurationNodeAsync

public CompletableFuture<? extends PubSubConfigurationTypeNode> getPubSubConfigurationNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getPubSubConfigurationNode().

Specified by:

getPubSubConfigurationNodeAsync in interface PublishSubscribeType

Returns:

a CompletableFuture that completes successfully with the PubSubConfigurationType 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: PublishSubscribeType

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 PublishSubscribeType

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: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getStatusNode().

Specified by:

getStatusNodeAsync in interface PublishSubscribeType

Returns:

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

getDiagnosticsNode

public PubSubDiagnosticsRootTypeNode getDiagnosticsNode()
                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

Get the Diagnostics PubSubDiagnosticsRootType Node, or null if it does not exist.

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

Specified by:

getDiagnosticsNode in interface PublishSubscribeType

Returns:

the Diagnostics PubSubDiagnosticsRootType 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.

getDiagnosticsNodeAsync

public CompletableFuture<? extends PubSubDiagnosticsRootTypeNode> getDiagnosticsNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getDiagnosticsNode().

Specified by:

getDiagnosticsNodeAsync in interface PublishSubscribeType

Returns:

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

getPubSubCapablitiesNode

public PubSubCapabilitiesTypeNode getPubSubCapablitiesNode()
                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

Get the PubSubCapablities PubSubCapabilitiesType Node, or null if it does not exist.

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

Specified by:

getPubSubCapablitiesNode in interface PublishSubscribeType

Returns:

the PubSubCapablities PubSubCapabilitiesType 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.

getPubSubCapablitiesNodeAsync

public CompletableFuture<? extends PubSubCapabilitiesTypeNode> getPubSubCapablitiesNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getPubSubCapablitiesNode().

Specified by:

getPubSubCapablitiesNodeAsync in interface PublishSubscribeType

Returns:

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

getDataSetClassesNode

public FolderTypeNode getDataSetClassesNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishSubscribeType

Get the DataSetClasses FolderType Node, or null if it does not exist.

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

Specified by:

getDataSetClassesNode in interface PublishSubscribeType

Returns:

the DataSetClasses FolderType 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.

getDataSetClassesNodeAsync

public CompletableFuture<? extends FolderTypeNode> getDataSetClassesNodeAsync()

Description copied from interface: PublishSubscribeType

Asynchronous implementation of PublishSubscribeType.getDataSetClassesNode().

Specified by:

getDataSetClassesNodeAsync in interface PublishSubscribeType

Returns:

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