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

Interface KeyCredentialConfigurationType

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

  • Field Details

    • RESOURCE_URI

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

    • PROFILE_URI

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

    • ENDPOINT_URLS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String[]> ENDPOINT_URLS

    • CREDENTIAL_ID

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

    • SERVICE_STATUS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> SERVICE_STATUS

  • Method Details

    • getResourceUri

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

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

      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

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

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

      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

      String readResourceUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ResourceUri 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.

    • writeResourceUri

      void writeResourceUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ResourceUri 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.

    • readResourceUriAsync

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

    • writeResourceUriAsync

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

    • getResourceUriNode

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

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

      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

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

    • getProfileUri

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

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

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

    • setProfileUri

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

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

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

    • readProfileUri

      String readProfileUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ProfileUri 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.

    • writeProfileUri

      void writeProfileUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ProfileUri 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.

    • readProfileUriAsync

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

    • writeProfileUriAsync

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

    • getProfileUriNode

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

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

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

    • getProfileUriNodeAsync

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

    • getEndpointUrls

      String[] getEndpointUrls() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the EndpointUrls Node.

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

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

    • setEndpointUrls

      void setEndpointUrls(String[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the EndpointUrls Node.

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

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

    • readEndpointUrls

      String[] readEndpointUrls() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the EndpointUrls 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.

    • writeEndpointUrls

      void writeEndpointUrls(String[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the EndpointUrls 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.

    • readEndpointUrlsAsync

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

    • writeEndpointUrlsAsync

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

    • getEndpointUrlsNode

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

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

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

    • getEndpointUrlsNodeAsync

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

    • getCredentialId

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

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

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

    • setCredentialId

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

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

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

    • readCredentialId

      String readCredentialId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the CredentialId 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.

    • writeCredentialId

      void writeCredentialId(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the CredentialId 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.

    • readCredentialIdAsync

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

    • writeCredentialIdAsync

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

    • getCredentialIdNode

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

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

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

    • getCredentialIdNodeAsync

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

    • getServiceStatus

      org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getServiceStatus() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ServiceStatus Node.

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

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

    • setServiceStatus

      void setServiceStatus(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ServiceStatus Node.

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

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

    • readServiceStatus

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

    • writeServiceStatus

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

    • readServiceStatusAsync

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

    • writeServiceStatusAsync

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

    • getServiceStatusNode

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

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

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

    • getServiceStatusNodeAsync

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