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

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

Class BrokerConnectionTransportTypeNode

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

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

All Implemented Interfaces:

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

public class BrokerConnectionTransportTypeNode
extends ConnectionTransportTypeNode
implements BrokerConnectionTransportType

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

AUTHENTICATION_PROFILE_URI, RESOURCE_URI

Constructor Summary

Constructors

Constructor

Description

BrokerConnectionTransportTypeNode(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
String	getAuthenticationProfileUri()	Get the local value of the AuthenticationProfileUri Node.
PropertyTypeNode	getAuthenticationProfileUriNode()	Get the AuthenticationProfileUri PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getAuthenticationProfileUriNodeAsync()	Asynchronous implementation of BrokerConnectionTransportType.getAuthenticationProfileUriNode().
String	getResourceUri()	Get the local value of the ResourceUri Node.
PropertyTypeNode	getResourceUriNode()	Get the ResourceUri PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getResourceUriNodeAsync()	Asynchronous implementation of BrokerConnectionTransportType.getResourceUriNode().
String	readAuthenticationProfileUri()	Read the value of the AuthenticationProfileUri Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readAuthenticationProfileUriAsync()	An asynchronous implementation of BrokerConnectionTransportType.readAuthenticationProfileUri().
String	readResourceUri()	Read the value of the ResourceUri Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readResourceUriAsync()	An asynchronous implementation of BrokerConnectionTransportType.readResourceUri().
void	setAuthenticationProfileUri(String value)	Set the local value of the AuthenticationProfileUri Node.
void	setResourceUri(String value)	Set the local value of the ResourceUri Node.
void	writeAuthenticationProfileUri(String value)	Write a new value for the AuthenticationProfileUri Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAuthenticationProfileUriAsync(String authenticationProfileUri)	An asynchronous implementation of BrokerConnectionTransportType.writeAuthenticationProfileUri(java.lang.String).
void	writeResourceUri(String value)	Write a new value for the ResourceUri Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeResourceUriAsync(String resourceUri)	An asynchronous implementation of BrokerConnectionTransportType.writeResourceUri(java.lang.String).

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

BrokerConnectionTransportTypeNode

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

getResourceUri

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

Description copied from interface: BrokerConnectionTransportType

Get the local value of the ResourceUri Node.

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

Specified by:

getResourceUri in interface BrokerConnectionTransportType

Returns:

the local value of the ResourceUri Node.

Throws:

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

setResourceUri

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

Description copied from interface: BrokerConnectionTransportType

Set the local value of the ResourceUri Node.

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

Specified by:

setResourceUri in interface BrokerConnectionTransportType

Parameters:

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

Throws:

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

readResourceUri

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

Description copied from interface: BrokerConnectionTransportType

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

Specified by:

readResourceUri in interface BrokerConnectionTransportType

Returns:

the String value read from the server.

Throws:

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

writeResourceUri

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

Description copied from interface: BrokerConnectionTransportType

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

Specified by:

writeResourceUri in interface BrokerConnectionTransportType

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.

readResourceUriAsync

public CompletableFuture<? extends String> readResourceUriAsync()

Description copied from interface: BrokerConnectionTransportType

An asynchronous implementation of BrokerConnectionTransportType.readResourceUri().

Specified by:

readResourceUriAsync in interface BrokerConnectionTransportType

Returns:

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

writeResourceUriAsync

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

Description copied from interface: BrokerConnectionTransportType

An asynchronous implementation of BrokerConnectionTransportType.writeResourceUri(java.lang.String).

Specified by:

writeResourceUriAsync in interface BrokerConnectionTransportType

Returns:

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

getResourceUriNode

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

Description copied from interface: BrokerConnectionTransportType

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

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

Specified by:

getResourceUriNode in interface BrokerConnectionTransportType

Returns:

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

getResourceUriNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getResourceUriNodeAsync()

Description copied from interface: BrokerConnectionTransportType

Asynchronous implementation of BrokerConnectionTransportType.getResourceUriNode().

Specified by:

getResourceUriNodeAsync in interface BrokerConnectionTransportType

Returns:

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

getAuthenticationProfileUri

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

Description copied from interface: BrokerConnectionTransportType

Get the local value of the AuthenticationProfileUri Node.

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

Specified by:

getAuthenticationProfileUri in interface BrokerConnectionTransportType

Returns:

the local value of the AuthenticationProfileUri Node.

Throws:

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

setAuthenticationProfileUri

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

Description copied from interface: BrokerConnectionTransportType

Set the local value of the AuthenticationProfileUri Node.

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

Specified by:

setAuthenticationProfileUri in interface BrokerConnectionTransportType

Parameters:

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

Throws:

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

readAuthenticationProfileUri

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

Description copied from interface: BrokerConnectionTransportType

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

Specified by:

readAuthenticationProfileUri in interface BrokerConnectionTransportType

Returns:

the String value read from the server.

Throws:

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

writeAuthenticationProfileUri

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

Description copied from interface: BrokerConnectionTransportType

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

Specified by:

writeAuthenticationProfileUri in interface BrokerConnectionTransportType

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.

readAuthenticationProfileUriAsync

public CompletableFuture<? extends String> readAuthenticationProfileUriAsync()

Description copied from interface: BrokerConnectionTransportType

An asynchronous implementation of BrokerConnectionTransportType.readAuthenticationProfileUri().

Specified by:

readAuthenticationProfileUriAsync in interface BrokerConnectionTransportType

Returns:

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

writeAuthenticationProfileUriAsync

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

Description copied from interface: BrokerConnectionTransportType

An asynchronous implementation of BrokerConnectionTransportType.writeAuthenticationProfileUri(java.lang.String).

Specified by:

writeAuthenticationProfileUriAsync in interface BrokerConnectionTransportType

Returns:

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

getAuthenticationProfileUriNode

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

Description copied from interface: BrokerConnectionTransportType

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

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

Specified by:

getAuthenticationProfileUriNode in interface BrokerConnectionTransportType

Returns:

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

getAuthenticationProfileUriNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getAuthenticationProfileUriNodeAsync()

Description copied from interface: BrokerConnectionTransportType

Asynchronous implementation of BrokerConnectionTransportType.getAuthenticationProfileUriNode().

Specified by:

getAuthenticationProfileUriNodeAsync in interface BrokerConnectionTransportType

Returns:

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