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

Interface UserManagementType

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

  • Field Details

    • USERS

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

    • PASSWORD_LENGTH

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.Range> PASSWORD_LENGTH

    • PASSWORD_OPTIONS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask> PASSWORD_OPTIONS

    • PASSWORD_RESTRICTIONS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> PASSWORD_RESTRICTIONS

  • Method Details

    • getUsers

      org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] getUsers() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Users Node.

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

      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

      void setUsers(org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Users Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] readUsers() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Users Node from the server and update the local value if the operation succeeds.
      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

      void writeUsers(org.eclipse.milo.opcua.stack.core.types.structured.UserManagementDataType[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Users Node to the server and update the local value if the operation succeeds.
      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

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

    • writeUsersAsync

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

    • getUsersNode

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

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

      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

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

    • getPasswordLength

      org.eclipse.milo.opcua.stack.core.types.structured.Range getPasswordLength() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PasswordLength Node.

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

      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

      void setPasswordLength(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PasswordLength Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.structured.Range readPasswordLength() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PasswordLength Node from the server and update the local value if the operation succeeds.
      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

      void writePasswordLength(org.eclipse.milo.opcua.stack.core.types.structured.Range value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PasswordLength Node to the server and update the local value if the operation succeeds.
      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

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

    • writePasswordLengthAsync

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

    • getPasswordLengthNode

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

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

      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

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

    • getPasswordOptions

      org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask getPasswordOptions() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PasswordOptions Node.

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

      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

      void setPasswordOptions(org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PasswordOptions Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask readPasswordOptions() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PasswordOptions Node from the server and update the local value if the operation succeeds.
      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

      void writePasswordOptions(org.eclipse.milo.opcua.stack.core.types.structured.PasswordOptionsMask value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PasswordOptions Node to the server and update the local value if the operation succeeds.
      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

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

    • writePasswordOptionsAsync

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

    • getPasswordOptionsNode

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

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

      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

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

    • getPasswordRestrictions

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getPasswordRestrictions() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PasswordRestrictions Node.

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

      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

      void setPasswordRestrictions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PasswordRestrictions Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readPasswordRestrictions() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the PasswordRestrictions Node from the server and update the local value if the operation succeeds.
      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

      void writePasswordRestrictions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the PasswordRestrictions Node to the server and update the local value if the operation succeeds.
      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

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

    • writePasswordRestrictionsAsync

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

    • getPasswordRestrictionsNode

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

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

      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

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