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

Interface ApplicationConfigurationType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode, ServerConfigurationType
All Known Implementing Classes:
ApplicationConfigurationTypeNode
public interface ApplicationConfigurationType extends ServerConfigurationType
See Also:

  • Field Details

    • APPLICATION_URI

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

    • PRODUCT_URI

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

    • APPLICATION_TYPE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.ApplicationType> APPLICATION_TYPE

    • ENABLED

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> ENABLED

  • Method Details

    • getApplicationUri

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

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

      Specified by:
      getApplicationUri in interface ServerConfigurationType
      Returns:
      the local value of the ApplicationUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ApplicationUri Node.

    • setApplicationUri

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

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

      Specified by:
      setApplicationUri in interface ServerConfigurationType
      Parameters:
      value - the local value to set for the ApplicationUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ApplicationUri Node.

    • readApplicationUri

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

    • writeApplicationUri

      void writeApplicationUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ApplicationUri Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeApplicationUri in interface ServerConfigurationType
      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.

    • readApplicationUriAsync

      CompletableFuture<? extends String> readApplicationUriAsync()
      An asynchronous implementation of readApplicationUri().
      Specified by:
      readApplicationUriAsync in interface ServerConfigurationType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeApplicationUriAsync

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

    • getApplicationUriNode

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

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

      Specified by:
      getApplicationUriNode in interface ServerConfigurationType
      Returns:
      the ApplicationUri 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.

    • getApplicationUriNodeAsync

      CompletableFuture<? extends PropertyType> getApplicationUriNodeAsync()
      Asynchronous implementation of getApplicationUriNode().
      Specified by:
      getApplicationUriNodeAsync in interface ServerConfigurationType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getProductUri

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

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

      Specified by:
      getProductUri in interface ServerConfigurationType
      Returns:
      the local value of the ProductUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ProductUri Node.

    • setProductUri

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

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

      Specified by:
      setProductUri in interface ServerConfigurationType
      Parameters:
      value - the local value to set for the ProductUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ProductUri Node.

    • readProductUri

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

    • writeProductUri

      void writeProductUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ProductUri Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeProductUri in interface ServerConfigurationType
      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.

    • readProductUriAsync

      CompletableFuture<? extends String> readProductUriAsync()
      An asynchronous implementation of readProductUri().
      Specified by:
      readProductUriAsync in interface ServerConfigurationType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeProductUriAsync

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

    • getProductUriNode

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

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

      Specified by:
      getProductUriNode in interface ServerConfigurationType
      Returns:
      the ProductUri 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.

    • getProductUriNodeAsync

      CompletableFuture<? extends PropertyType> getProductUriNodeAsync()
      Asynchronous implementation of getProductUriNode().
      Specified by:
      getProductUriNodeAsync in interface ServerConfigurationType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getApplicationType

      org.eclipse.milo.opcua.stack.core.types.enumerated.ApplicationType getApplicationType() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ApplicationType Node.

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

      Specified by:
      getApplicationType in interface ServerConfigurationType
      Returns:
      the local value of the ApplicationType Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ApplicationType Node.

    • setApplicationType

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

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

      Specified by:
      setApplicationType in interface ServerConfigurationType
      Parameters:
      value - the local value to set for the ApplicationType Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ApplicationType Node.

    • readApplicationType

      org.eclipse.milo.opcua.stack.core.types.enumerated.ApplicationType readApplicationType() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ApplicationType Node from the server and update the local value if the operation succeeds.
      Specified by:
      readApplicationType in interface ServerConfigurationType
      Returns:
      the ApplicationType value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeApplicationType

      void writeApplicationType(org.eclipse.milo.opcua.stack.core.types.enumerated.ApplicationType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ApplicationType Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeApplicationType in interface ServerConfigurationType
      Parameters:
      value - the ApplicationType value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readApplicationTypeAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ApplicationType> readApplicationTypeAsync()
      An asynchronous implementation of readApplicationType().
      Specified by:
      readApplicationTypeAsync in interface ServerConfigurationType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeApplicationTypeAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeApplicationTypeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ApplicationType value)
      An asynchronous implementation of writeApplicationType(org.eclipse.milo.opcua.stack.core.types.enumerated.ApplicationType).
      Specified by:
      writeApplicationTypeAsync in interface ServerConfigurationType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getApplicationTypeNode

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

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

      Specified by:
      getApplicationTypeNode in interface ServerConfigurationType
      Returns:
      the ApplicationType 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.

    • getApplicationTypeNodeAsync

      CompletableFuture<? extends PropertyType> getApplicationTypeNodeAsync()
      Asynchronous implementation of getApplicationTypeNode().
      Specified by:
      getApplicationTypeNodeAsync in interface ServerConfigurationType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getEnabled

      Boolean getEnabled() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Enabled Node.

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

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

    • setEnabled

      void setEnabled(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Enabled Node.

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

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

    • readEnabled

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

    • writeEnabled

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

    • readEnabledAsync

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

    • writeEnabledAsync

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

    • getEnabledNode

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

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

      Returns:
      the Enabled 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.

    • getEnabledNodeAsync

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