All Implemented Interfaces:
BaseObjectType, UserManagementType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class UserManagementTypeNode extends BaseObjectTypeNode implements UserManagementType
  • Constructor Details

    • UserManagementTypeNode

      public UserManagementTypeNode(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

    • getUsers

      public org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] getUsers() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the local value of the Users Node.

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

      Specified by:
      getUsers in interface UserManagementType
      Returns:
      the local value of the Users Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Users Node.
    • setUsers

      public void setUsers(org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Set the local value of the Users Node.

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

      Specified by:
      setUsers in interface UserManagementType
      Parameters:
      value - the local value to set for the Users Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Users Node.
    • readUsers

      public org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] readUsers() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Read the value of the Users Node from the server and update the local value if the operation succeeds.
      Specified by:
      readUsers in interface UserManagementType
      Returns:
      the UserManagementDataType value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeUsers

      public void writeUsers(org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Write a new value for the Users Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeUsers in interface UserManagementType
      Parameters:
      value - the UserManagementDataType value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readUsersAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[]> readUsersAsync()
      Description copied from interface: UserManagementType
      An asynchronous implementation of UserManagementType.readUsers().
      Specified by:
      readUsersAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeUsersAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeUsersAsync(org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] users)
      Description copied from interface: UserManagementType
      Specified by:
      writeUsersAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getUsersNode

      public PropertyTypeNode getUsersNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the Users PropertyType Node, or null if it does not exist.

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

      Specified by:
      getUsersNode in interface UserManagementType
      Returns:
      the Users 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.
    • getUsersNodeAsync

      public CompletableFuture<? extends PropertyTypeNode> getUsersNodeAsync()
      Description copied from interface: UserManagementType
      Asynchronous implementation of UserManagementType.getUsersNode().
      Specified by:
      getUsersNodeAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getPasswordLength

      public org.eclipse.milo.opcua.stack.core.types.structured.Range getPasswordLength() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the local value of the PasswordLength Node.

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

      Specified by:
      getPasswordLength in interface UserManagementType
      Returns:
      the local value of the PasswordLength Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PasswordLength Node.
    • setPasswordLength

      public void setPasswordLength(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Set the local value of the PasswordLength Node.

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

      Specified by:
      setPasswordLength in interface UserManagementType
      Parameters:
      value - the local value to set for the PasswordLength Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PasswordLength Node.
    • readPasswordLength

      public org.eclipse.milo.opcua.stack.core.types.structured.Range readPasswordLength() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Read the value of the PasswordLength Node from the server and update the local value if the operation succeeds.
      Specified by:
      readPasswordLength in interface UserManagementType
      Returns:
      the Range value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writePasswordLength

      public void writePasswordLength(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Write a new value for the PasswordLength Node to the server and update the local value if the operation succeeds.
      Specified by:
      writePasswordLength in interface UserManagementType
      Parameters:
      value - the Range value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readPasswordLengthAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.Range> readPasswordLengthAsync()
      Description copied from interface: UserManagementType
      An asynchronous implementation of UserManagementType.readPasswordLength().
      Specified by:
      readPasswordLengthAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writePasswordLengthAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePasswordLengthAsync(org.eclipse.milo.opcua.stack.core.types.structured.Range passwordLength)
      Description copied from interface: UserManagementType
      Specified by:
      writePasswordLengthAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getPasswordLengthNode

      public PropertyTypeNode getPasswordLengthNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the PasswordLength PropertyType Node, or null if it does not exist.

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

      Specified by:
      getPasswordLengthNode in interface UserManagementType
      Returns:
      the PasswordLength 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.
    • getPasswordLengthNodeAsync

      public CompletableFuture<? extends PropertyTypeNode> getPasswordLengthNodeAsync()
      Description copied from interface: UserManagementType
      Asynchronous implementation of UserManagementType.getPasswordLengthNode().
      Specified by:
      getPasswordLengthNodeAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getPasswordOptions

      public org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask getPasswordOptions() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the local value of the PasswordOptions Node.

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

      Specified by:
      getPasswordOptions in interface UserManagementType
      Returns:
      the local value of the PasswordOptions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PasswordOptions Node.
    • setPasswordOptions

      public void setPasswordOptions(org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Set the local value of the PasswordOptions Node.

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

      Specified by:
      setPasswordOptions in interface UserManagementType
      Parameters:
      value - the local value to set for the PasswordOptions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PasswordOptions Node.
    • readPasswordOptions

      public org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask readPasswordOptions() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Read the value of the PasswordOptions Node from the server and update the local value if the operation succeeds.
      Specified by:
      readPasswordOptions in interface UserManagementType
      Returns:
      the PasswordOptionsMask value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writePasswordOptions

      public void writePasswordOptions(org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Write a new value for the PasswordOptions Node to the server and update the local value if the operation succeeds.
      Specified by:
      writePasswordOptions in interface UserManagementType
      Parameters:
      value - the PasswordOptionsMask value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readPasswordOptionsAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask> readPasswordOptionsAsync()
      Description copied from interface: UserManagementType
      An asynchronous implementation of UserManagementType.readPasswordOptions().
      Specified by:
      readPasswordOptionsAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writePasswordOptionsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePasswordOptionsAsync(org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask passwordOptions)
      Description copied from interface: UserManagementType
      Specified by:
      writePasswordOptionsAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getPasswordOptionsNode

      public PropertyTypeNode getPasswordOptionsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the PasswordOptions PropertyType Node, or null if it does not exist.

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

      Specified by:
      getPasswordOptionsNode in interface UserManagementType
      Returns:
      the PasswordOptions 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.
    • getPasswordOptionsNodeAsync

      public CompletableFuture<? extends PropertyTypeNode> getPasswordOptionsNodeAsync()
      Description copied from interface: UserManagementType
      Asynchronous implementation of UserManagementType.getPasswordOptionsNode().
      Specified by:
      getPasswordOptionsNodeAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.
    • getPasswordRestrictions

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getPasswordRestrictions() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the local value of the PasswordRestrictions Node.

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

      Specified by:
      getPasswordRestrictions in interface UserManagementType
      Returns:
      the local value of the PasswordRestrictions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PasswordRestrictions Node.
    • setPasswordRestrictions

      public void setPasswordRestrictions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Set the local value of the PasswordRestrictions Node.

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

      Specified by:
      setPasswordRestrictions in interface UserManagementType
      Parameters:
      value - the local value to set for the PasswordRestrictions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the PasswordRestrictions Node.
    • readPasswordRestrictions

      public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readPasswordRestrictions() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Read the value of the PasswordRestrictions Node from the server and update the local value if the operation succeeds.
      Specified by:
      readPasswordRestrictions in interface UserManagementType
      Returns:
      the LocalizedText value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writePasswordRestrictions

      public void writePasswordRestrictions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Write a new value for the PasswordRestrictions Node to the server and update the local value if the operation succeeds.
      Specified by:
      writePasswordRestrictions in interface UserManagementType
      Parameters:
      value - the LocalizedText value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readPasswordRestrictionsAsync

      public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readPasswordRestrictionsAsync()
      Description copied from interface: UserManagementType
      An asynchronous implementation of UserManagementType.readPasswordRestrictions().
      Specified by:
      readPasswordRestrictionsAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writePasswordRestrictionsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePasswordRestrictionsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText passwordRestrictions)
      Description copied from interface: UserManagementType
      Specified by:
      writePasswordRestrictionsAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getPasswordRestrictionsNode

      public PropertyTypeNode getPasswordRestrictionsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Description copied from interface: UserManagementType
      Get the PasswordRestrictions PropertyType Node, or null if it does not exist.

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

      Specified by:
      getPasswordRestrictionsNode in interface UserManagementType
      Returns:
      the PasswordRestrictions 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.
    • getPasswordRestrictionsNodeAsync

      public CompletableFuture<? extends PropertyTypeNode> getPasswordRestrictionsNodeAsync()
      Description copied from interface: UserManagementType
      Asynchronous implementation of UserManagementType.getPasswordRestrictionsNode().
      Specified by:
      getPasswordRestrictionsNodeAsync in interface UserManagementType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.