Class PubSubConnectionTypeNode
- All Implemented Interfaces:
BaseObjectType,PubSubConnectionType,org.eclipse.milo.opcua.sdk.core.nodes.Node,org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
-
Field Summary
Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.PubSubConnectionType
CONNECTION_PROPERTIES, PUBLISHER_ID -
Constructor Summary
ConstructorsConstructorDescriptionPubSubConnectionTypeNode(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 TypeMethodDescriptionGet the AddressNetworkAddressTypeNode, ornullif it does not exist.CompletableFuture<? extends NetworkAddressTypeNode>Asynchronous implementation ofPubSubConnectionType.getAddressNode().org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]Get the local value of the ConnectionProperties Node.Get the ConnectionPropertiesPropertyTypeNode, ornullif it does not exist.CompletableFuture<? extends PropertyTypeNode>Asynchronous implementation ofPubSubConnectionType.getConnectionPropertiesNode().Get the DiagnosticsPubSubDiagnosticsConnectionTypeNode, ornullif it does not exist.Asynchronous implementation ofPubSubConnectionType.getDiagnosticsNode().Get the local value of the PublisherId Node.Get the PublisherIdPropertyTypeNode, ornullif it does not exist.CompletableFuture<? extends PropertyTypeNode>Asynchronous implementation ofPubSubConnectionType.getPublisherIdNode().Get the StatusPubSubStatusTypeNode, ornullif it does not exist.CompletableFuture<? extends PubSubStatusTypeNode>Asynchronous implementation ofPubSubConnectionType.getStatusNode().Get the local value of the TransportProfileUri Node.Get the TransportProfileUriSelectionListTypeNode, ornullif it does not exist.CompletableFuture<? extends SelectionListTypeNode>Asynchronous implementation ofPubSubConnectionType.getTransportProfileUriNode().Get the TransportSettingsConnectionTransportTypeNode, ornullif it does not exist.CompletableFuture<? extends ConnectionTransportTypeNode>Asynchronous implementation ofPubSubConnectionType.getTransportSettingsNode().org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]Read the value of the ConnectionProperties Node from the server and update the local value if the operation succeeds.CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]>An asynchronous implementation ofPubSubConnectionType.readConnectionProperties().Read the value of the PublisherId Node from the server and update the local value if the operation succeeds.An asynchronous implementation ofPubSubConnectionType.readPublisherId().Read the value of the TransportProfileUri Node from the server and update the local value if the operation succeeds.CompletableFuture<? extends String>An asynchronous implementation ofPubSubConnectionType.readTransportProfileUri().voidsetConnectionProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) Set the local value of the ConnectionProperties Node.voidsetPublisherId(Object value) Set the local value of the PublisherId Node.voidsetTransportProfileUri(String value) Set the local value of the TransportProfileUri Node.voidwriteConnectionProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) Write a new value for the ConnectionProperties Node to the server and update the local value if the operation succeeds.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>writeConnectionPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] connectionProperties) An asynchronous implementation ofPubSubConnectionType.writeConnectionProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).voidwritePublisherId(Object value) Write a new value for the PublisherId Node to the server and update the local value if the operation succeeds.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>writePublisherIdAsync(Object publisherId) An asynchronous implementation ofPubSubConnectionType.writePublisherId(java.lang.Object).voidwriteTransportProfileUri(String value) Write a new value for the TransportProfileUri Node to the server and update the local value if the operation succeeds.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>writeTransportProfileUriAsync(String transportProfileUri) An asynchronous implementation ofPubSubConnectionType.writeTransportProfileUri(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, writeEventNotifierMethods 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, writeWriteMaskMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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, setWriteMaskMethods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
getEventNotifier, setEventNotifier
-
Constructor Details
-
PubSubConnectionTypeNode
public PubSubConnectionTypeNode(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
-
getPublisherId
Description copied from interface:PubSubConnectionTypeGet the local value of the PublisherId Node.The returned value is the last seen; it is not read live from the server.
- Specified by:
getPublisherIdin interfacePubSubConnectionType- Returns:
- the local value of the PublisherId Node.
- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the PublisherId Node.
-
setPublisherId
Description copied from interface:PubSubConnectionTypeSet the local value of the PublisherId Node.The value is only updated locally; it is not written to the server.
- Specified by:
setPublisherIdin interfacePubSubConnectionType- Parameters:
value- the local value to set for the PublisherId Node.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the PublisherId Node.
-
readPublisherId
Description copied from interface:PubSubConnectionTypeRead the value of the PublisherId Node from the server and update the local value if the operation succeeds.- Specified by:
readPublisherIdin interfacePubSubConnectionType- Returns:
- the
Objectvalue read from the server. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
writePublisherId
Description copied from interface:PubSubConnectionTypeWrite a new value for the PublisherId Node to the server and update the local value if the operation succeeds.- Specified by:
writePublisherIdin interfacePubSubConnectionType- Parameters:
value- theObjectvalue to write to the server.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
readPublisherIdAsync
Description copied from interface:PubSubConnectionTypeAn asynchronous implementation ofPubSubConnectionType.readPublisherId().- Specified by:
readPublisherIdAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
-
writePublisherIdAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePublisherIdAsync(Object publisherId) Description copied from interface:PubSubConnectionTypeAn asynchronous implementation ofPubSubConnectionType.writePublisherId(java.lang.Object).- Specified by:
writePublisherIdAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
-
getPublisherIdNode
Description copied from interface:PubSubConnectionTypeGet the PublisherIdPropertyTypeNode, ornullif it does not exist.The Node is created when first accessed and cached for subsequent calls.
- Specified by:
getPublisherIdNodein interfacePubSubConnectionType- Returns:
- the PublisherId
PropertyTypeNode, ornullif it does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the Node.
-
getPublisherIdNodeAsync
Description copied from interface:PubSubConnectionTypeAsynchronous implementation ofPubSubConnectionType.getPublisherIdNode().- Specified by:
getPublisherIdNodeAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
-
getConnectionProperties
public org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] getConnectionProperties() throws org.eclipse.milo.opcua.stack.core.UaExceptionDescription copied from interface:PubSubConnectionTypeGet the local value of the ConnectionProperties Node.The returned value is the last seen; it is not read live from the server.
- Specified by:
getConnectionPropertiesin interfacePubSubConnectionType- Returns:
- the local value of the ConnectionProperties Node.
- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the ConnectionProperties Node.
-
setConnectionProperties
public void setConnectionProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) throws org.eclipse.milo.opcua.stack.core.UaException Description copied from interface:PubSubConnectionTypeSet the local value of the ConnectionProperties Node.The value is only updated locally; it is not written to the server.
- Specified by:
setConnectionPropertiesin interfacePubSubConnectionType- Parameters:
value- the local value to set for the ConnectionProperties Node.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the ConnectionProperties Node.
-
readConnectionProperties
public org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] readConnectionProperties() throws org.eclipse.milo.opcua.stack.core.UaExceptionDescription copied from interface:PubSubConnectionTypeRead the value of the ConnectionProperties Node from the server and update the local value if the operation succeeds.- Specified by:
readConnectionPropertiesin interfacePubSubConnectionType- Returns:
- the
KeyValuePairvalue read from the server. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
writeConnectionProperties
public void writeConnectionProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) throws org.eclipse.milo.opcua.stack.core.UaException Description copied from interface:PubSubConnectionTypeWrite a new value for the ConnectionProperties Node to the server and update the local value if the operation succeeds.- Specified by:
writeConnectionPropertiesin interfacePubSubConnectionType- Parameters:
value- theKeyValuePairvalue to write to the server.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
readConnectionPropertiesAsync
public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]> readConnectionPropertiesAsync()Description copied from interface:PubSubConnectionTypeAn asynchronous implementation ofPubSubConnectionType.readConnectionProperties().- Specified by:
readConnectionPropertiesAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
-
writeConnectionPropertiesAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConnectionPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] connectionProperties) Description copied from interface:PubSubConnectionTypeAn asynchronous implementation ofPubSubConnectionType.writeConnectionProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).- Specified by:
writeConnectionPropertiesAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
-
getConnectionPropertiesNode
public PropertyTypeNode getConnectionPropertiesNode() throws org.eclipse.milo.opcua.stack.core.UaExceptionDescription copied from interface:PubSubConnectionTypeGet the ConnectionPropertiesPropertyTypeNode, ornullif it does not exist.The Node is created when first accessed and cached for subsequent calls.
- Specified by:
getConnectionPropertiesNodein interfacePubSubConnectionType- Returns:
- the ConnectionProperties
PropertyTypeNode, ornullif it does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the Node.
-
getConnectionPropertiesNodeAsync
Description copied from interface:PubSubConnectionTypeAsynchronous implementation ofPubSubConnectionType.getConnectionPropertiesNode().- Specified by:
getConnectionPropertiesNodeAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
-
getTransportProfileUri
Description copied from interface:PubSubConnectionTypeGet the local value of the TransportProfileUri Node.The returned value is the last seen; it is not read live from the server.
- Specified by:
getTransportProfileUriin interfacePubSubConnectionType- Returns:
- the local value of the TransportProfileUri Node.
- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the TransportProfileUri Node.
-
setTransportProfileUri
public void setTransportProfileUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException Description copied from interface:PubSubConnectionTypeSet the local value of the TransportProfileUri Node.The value is only updated locally; it is not written to the server.
- Specified by:
setTransportProfileUriin interfacePubSubConnectionType- Parameters:
value- the local value to set for the TransportProfileUri Node.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the TransportProfileUri Node.
-
readTransportProfileUri
Description copied from interface:PubSubConnectionTypeRead the value of the TransportProfileUri Node from the server and update the local value if the operation succeeds.- Specified by:
readTransportProfileUriin interfacePubSubConnectionType- Returns:
- the
Stringvalue read from the server. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
writeTransportProfileUri
public void writeTransportProfileUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException Description copied from interface:PubSubConnectionTypeWrite a new value for the TransportProfileUri Node to the server and update the local value if the operation succeeds.- Specified by:
writeTransportProfileUriin interfacePubSubConnectionType- Parameters:
value- theStringvalue to write to the server.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
readTransportProfileUriAsync
Description copied from interface:PubSubConnectionTypeAn asynchronous implementation ofPubSubConnectionType.readTransportProfileUri().- Specified by:
readTransportProfileUriAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
-
writeTransportProfileUriAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTransportProfileUriAsync(String transportProfileUri) Description copied from interface:PubSubConnectionTypeAn asynchronous implementation ofPubSubConnectionType.writeTransportProfileUri(java.lang.String).- Specified by:
writeTransportProfileUriAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
-
getTransportProfileUriNode
public SelectionListTypeNode getTransportProfileUriNode() throws org.eclipse.milo.opcua.stack.core.UaExceptionDescription copied from interface:PubSubConnectionTypeGet the TransportProfileUriSelectionListTypeNode, ornullif it does not exist.The Node is created when first accessed and cached for subsequent calls.
- Specified by:
getTransportProfileUriNodein interfacePubSubConnectionType- Returns:
- the TransportProfileUri
SelectionListTypeNode, ornullif it does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the Node.
-
getTransportProfileUriNodeAsync
Description copied from interface:PubSubConnectionTypeAsynchronous implementation ofPubSubConnectionType.getTransportProfileUriNode().- Specified by:
getTransportProfileUriNodeAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the SelectionListType Node or completes exceptionally if an error occurs creating or getting the Node.
-
getAddressNode
Description copied from interface:PubSubConnectionTypeGet the AddressNetworkAddressTypeNode, ornullif it does not exist.The Node is created when first accessed and cached for subsequent calls.
- Specified by:
getAddressNodein interfacePubSubConnectionType- Returns:
- the Address
NetworkAddressTypeNode, ornullif it does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the Node.
-
getAddressNodeAsync
Description copied from interface:PubSubConnectionTypeAsynchronous implementation ofPubSubConnectionType.getAddressNode().- Specified by:
getAddressNodeAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the NetworkAddressType Node or completes exceptionally if an error occurs creating or getting the Node.
-
getTransportSettingsNode
public ConnectionTransportTypeNode getTransportSettingsNode() throws org.eclipse.milo.opcua.stack.core.UaExceptionDescription copied from interface:PubSubConnectionTypeGet the TransportSettingsConnectionTransportTypeNode, ornullif it does not exist.The Node is created when first accessed and cached for subsequent calls.
- Specified by:
getTransportSettingsNodein interfacePubSubConnectionType- Returns:
- the TransportSettings
ConnectionTransportTypeNode, ornullif it does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the Node.
-
getTransportSettingsNodeAsync
Description copied from interface:PubSubConnectionTypeAsynchronous implementation ofPubSubConnectionType.getTransportSettingsNode().- Specified by:
getTransportSettingsNodeAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the ConnectionTransportType Node or completes exceptionally if an error occurs creating or getting the Node.
-
getStatusNode
Description copied from interface:PubSubConnectionTypeGet the StatusPubSubStatusTypeNode, ornullif it does not exist.The Node is created when first accessed and cached for subsequent calls.
- Specified by:
getStatusNodein interfacePubSubConnectionType- Returns:
- the Status
PubSubStatusTypeNode, ornullif it does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the Node.
-
getStatusNodeAsync
Description copied from interface:PubSubConnectionTypeAsynchronous implementation ofPubSubConnectionType.getStatusNode().- Specified by:
getStatusNodeAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the PubSubStatusType Node or completes exceptionally if an error occurs creating or getting the Node.
-
getDiagnosticsNode
public PubSubDiagnosticsConnectionTypeNode getDiagnosticsNode() throws org.eclipse.milo.opcua.stack.core.UaExceptionDescription copied from interface:PubSubConnectionTypeGet the DiagnosticsPubSubDiagnosticsConnectionTypeNode, ornullif it does not exist.The Node is created when first accessed and cached for subsequent calls.
- Specified by:
getDiagnosticsNodein interfacePubSubConnectionType- Returns:
- the Diagnostics
PubSubDiagnosticsConnectionTypeNode, ornullif it does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an error occurs creating or getting the Node.
-
getDiagnosticsNodeAsync
Description copied from interface:PubSubConnectionTypeAsynchronous implementation ofPubSubConnectionType.getDiagnosticsNode().- Specified by:
getDiagnosticsNodeAsyncin interfacePubSubConnectionType- Returns:
- a CompletableFuture that completes successfully with the PubSubDiagnosticsConnectionType Node or completes exceptionally if an error occurs creating or getting the Node.
-