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

Interface RoleType

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

  • Field Details

    • IDENTITIES

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

    • APPLICATIONS_EXCLUDE

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

    • APPLICATIONS

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

    • ENDPOINTS_EXCLUDE

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

    • ENDPOINTS

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

    • CUSTOM_CONFIGURATION

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

  • Method Details

    • getIdentities

      org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] getIdentities() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Identities Node.

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

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

    • setIdentities

      void setIdentities(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Identities Node.

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

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

    • readIdentities

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

    • writeIdentities

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

    • readIdentitiesAsync

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

    • writeIdentitiesAsync

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

    • getIdentitiesNode

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

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

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

    • getIdentitiesNodeAsync

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

    • getApplicationsExclude

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

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

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

    • setApplicationsExclude

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

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

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

    • readApplicationsExclude

      Boolean readApplicationsExclude() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ApplicationsExclude 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.

    • writeApplicationsExclude

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

    • readApplicationsExcludeAsync

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

    • writeApplicationsExcludeAsync

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

    • getApplicationsExcludeNode

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

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

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

    • getApplicationsExcludeNodeAsync

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

    • getApplications

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

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

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

    • setApplications

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

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

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

    • readApplications

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

    • writeApplications

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

    • readApplicationsAsync

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

    • writeApplicationsAsync

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

    • getApplicationsNode

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

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

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

    • getApplicationsNodeAsync

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

    • getEndpointsExclude

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

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

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

    • setEndpointsExclude

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

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

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

    • readEndpointsExclude

      Boolean readEndpointsExclude() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the EndpointsExclude 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.

    • writeEndpointsExclude

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

    • readEndpointsExcludeAsync

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

    • writeEndpointsExcludeAsync

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

    • getEndpointsExcludeNode

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

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

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

    • getEndpointsExcludeNodeAsync

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

    • getEndpoints

      org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] getEndpoints() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Endpoints Node.

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

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

    • setEndpoints

      void setEndpoints(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Endpoints Node.

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

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

    • readEndpoints

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

    • writeEndpoints

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

    • readEndpointsAsync

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

    • writeEndpointsAsync

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

    • getEndpointsNode

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

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

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

    • getEndpointsNodeAsync

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

    • getCustomConfiguration

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

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

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

    • setCustomConfiguration

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

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

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

    • readCustomConfiguration

      Boolean readCustomConfiguration() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the CustomConfiguration 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.

    • writeCustomConfiguration

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

    • readCustomConfigurationAsync

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

    • writeCustomConfigurationAsync

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

    • getCustomConfigurationNode

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

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

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

    • getCustomConfigurationNodeAsync

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