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

Interface PubSubGroupType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
ReaderGroupType, WriterGroupType
All Known Implementing Classes:
PubSubGroupTypeNode, ReaderGroupTypeNode, WriterGroupTypeNode
public interface PubSubGroupType extends BaseObjectType
See Also:

  • Field Details

    • SECURITY_MODE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode> SECURITY_MODE

    • SECURITY_GROUP_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> SECURITY_GROUP_ID

    • SECURITY_KEY_SERVICES

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]> SECURITY_KEY_SERVICES

    • MAX_NETWORK_MESSAGE_SIZE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> MAX_NETWORK_MESSAGE_SIZE

    • GROUP_PROPERTIES

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]> GROUP_PROPERTIES

  • Method Details

    • getSecurityMode

      org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode getSecurityMode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SecurityMode Node.

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

      Returns:
      the local value of the SecurityMode Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityMode Node.

    • setSecurityMode

      void setSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SecurityMode Node.

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

      Parameters:
      value - the local value to set for the SecurityMode Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityMode Node.

    • readSecurityMode

      org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode readSecurityMode() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the SecurityMode Node from the server and update the local value if the operation succeeds.
      Returns:
      the MessageSecurityMode value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeSecurityMode

      void writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the SecurityMode Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the MessageSecurityMode value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readSecurityModeAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode> readSecurityModeAsync()
      An asynchronous implementation of readSecurityMode().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeSecurityModeAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecurityModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value)
      An asynchronous implementation of writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getSecurityModeNode

      PropertyType getSecurityModeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SecurityMode PropertyType Node, or null if it does not exist.

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

      Returns:
      the SecurityMode PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getSecurityModeNodeAsync

      CompletableFuture<? extends PropertyType> getSecurityModeNodeAsync()
      Asynchronous implementation of getSecurityModeNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getSecurityGroupId

      String getSecurityGroupId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SecurityGroupId Node.

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

      Returns:
      the local value of the SecurityGroupId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityGroupId Node.

    • setSecurityGroupId

      void setSecurityGroupId(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SecurityGroupId Node.

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

      Parameters:
      value - the local value to set for the SecurityGroupId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityGroupId Node.

    • readSecurityGroupId

      String readSecurityGroupId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the SecurityGroupId Node from the server and update the local value if the operation succeeds.
      Returns:
      the String value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeSecurityGroupId

      void writeSecurityGroupId(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the SecurityGroupId Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the String value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readSecurityGroupIdAsync

      CompletableFuture<? extends String> readSecurityGroupIdAsync()
      An asynchronous implementation of readSecurityGroupId().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeSecurityGroupIdAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecurityGroupIdAsync(String value)
      An asynchronous implementation of writeSecurityGroupId(java.lang.String).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getSecurityGroupIdNode

      PropertyType getSecurityGroupIdNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SecurityGroupId PropertyType Node, or null if it does not exist.

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

      Returns:
      the SecurityGroupId PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getSecurityGroupIdNodeAsync

      CompletableFuture<? extends PropertyType> getSecurityGroupIdNodeAsync()
      Asynchronous implementation of getSecurityGroupIdNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getSecurityKeyServices

      org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] getSecurityKeyServices() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SecurityKeyServices Node.

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

      Returns:
      the local value of the SecurityKeyServices Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityKeyServices Node.

    • setSecurityKeyServices

      void setSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SecurityKeyServices Node.

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

      Parameters:
      value - the local value to set for the SecurityKeyServices Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityKeyServices Node.

    • readSecurityKeyServices

      org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] readSecurityKeyServices() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the SecurityKeyServices Node from the server and update the local value if the operation succeeds.
      Returns:
      the EndpointDescription value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeSecurityKeyServices

      void writeSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the SecurityKeyServices Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the EndpointDescription value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readSecurityKeyServicesAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]> readSecurityKeyServicesAsync()
      An asynchronous implementation of readSecurityKeyServices().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeSecurityKeyServicesAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecurityKeyServicesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[] value)
      An asynchronous implementation of writeSecurityKeyServices(org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getSecurityKeyServicesNode

      PropertyType getSecurityKeyServicesNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SecurityKeyServices PropertyType Node, or null if it does not exist.

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

      Returns:
      the SecurityKeyServices PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getSecurityKeyServicesNodeAsync

      CompletableFuture<? extends PropertyType> getSecurityKeyServicesNodeAsync()
      Asynchronous implementation of getSecurityKeyServicesNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getMaxNetworkMessageSize

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxNetworkMessageSize() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the MaxNetworkMessageSize Node.

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

      Returns:
      the local value of the MaxNetworkMessageSize Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the MaxNetworkMessageSize Node.

    • setMaxNetworkMessageSize

      void setMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the MaxNetworkMessageSize Node.

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

      Parameters:
      value - the local value to set for the MaxNetworkMessageSize Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the MaxNetworkMessageSize Node.

    • readMaxNetworkMessageSize

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readMaxNetworkMessageSize() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the MaxNetworkMessageSize Node from the server and update the local value if the operation succeeds.
      Returns:
      the UInteger value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeMaxNetworkMessageSize

      void writeMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the MaxNetworkMessageSize Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the UInteger value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readMaxNetworkMessageSizeAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readMaxNetworkMessageSizeAsync()
      An asynchronous implementation of readMaxNetworkMessageSize().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeMaxNetworkMessageSizeAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxNetworkMessageSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
      An asynchronous implementation of writeMaxNetworkMessageSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getMaxNetworkMessageSizeNode

      PropertyType getMaxNetworkMessageSizeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the MaxNetworkMessageSize PropertyType Node, or null if it does not exist.

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

      Returns:
      the MaxNetworkMessageSize PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getMaxNetworkMessageSizeNodeAsync

      CompletableFuture<? extends PropertyType> getMaxNetworkMessageSizeNodeAsync()
      Asynchronous implementation of getMaxNetworkMessageSizeNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getGroupProperties

      org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] getGroupProperties() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the GroupProperties Node.

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

      Returns:
      the local value of the GroupProperties Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the GroupProperties Node.

    • setGroupProperties

      void setGroupProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the GroupProperties Node.

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

      Parameters:
      value - the local value to set for the GroupProperties Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the GroupProperties Node.

    • readGroupProperties

      org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] readGroupProperties() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the GroupProperties Node from the server and update the local value if the operation succeeds.
      Returns:
      the KeyValuePair value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeGroupProperties

      void writeGroupProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the GroupProperties Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the KeyValuePair value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readGroupPropertiesAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]> readGroupPropertiesAsync()
      An asynchronous implementation of readGroupProperties().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeGroupPropertiesAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeGroupPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)
      An asynchronous implementation of writeGroupProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getGroupPropertiesNode

      PropertyType getGroupPropertiesNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the GroupProperties PropertyType Node, or null if it does not exist.

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

      Returns:
      the GroupProperties PropertyType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getGroupPropertiesNodeAsync

      CompletableFuture<? extends PropertyType> getGroupPropertiesNodeAsync()
      Asynchronous implementation of getGroupPropertiesNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getStatusNode

      PubSubStatusType getStatusNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Status PubSubStatusType Node, or null if it does not exist.

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

      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

      CompletableFuture<? extends PubSubStatusType> getStatusNodeAsync()
      Asynchronous implementation of getStatusNode().
      Returns:
      a CompletableFuture that completes successfully with the PubSubStatusType Node or completes exceptionally if an error occurs creating or getting the Node.