public interface User
Interface representing a user used in the permission service.
Since:
3.1.170
  • Method Details

    • getLogin

      @Nullable String getLogin()
      Returns the login of this user or null if not specified.
      Returns:
      the login of this user or null
      Since:
      3.1
      See Also:
    • setLogin

      void setLogin(String login)
      Sets the login for this user
      Parameters:
      login - the login for this user.
      Since:
      3.1.170
      See Also:
    • getRealname

      @Nullable String getRealname()
      Returns the realname of this user or null if not specified
      Returns:
      the realname of this user or null
      Since:
      3.1.170
    • setRealname

      void setRealname(String realname)
      Sets the realname for this user.
      Parameters:
      realname - the realname for this user.
      Since:
      3.1.170
    • getPassword

      @Nullable char[] getPassword()
      Returns the password of this user or null if not specified
      Returns:
      the password of this user or null
      Since:
      3.1.170
    • setPassword

      void setPassword(char[] password)
      Sets the password for this user.
      Parameters:
      password - the password for this user.
      Since:
      3.1.170
    • getGroupsIds

      @NotNull String[] getGroupsIds()
      Returns an array of group ids this user belongs to.
      Since:
      3.1.170
      See Also:
    • setGroupIds

      void setGroupIds(String[] groupIds)
      Sets the given group ids for this user.
      Since:
      3.1.170
      See Also:
    • addGroupId

      void addGroupId(String groupId)
      Adds the given group id to the list of group ids this user belongs to.
      Parameters:
      groupId - the group id to add to the list of group ids
      Since:
      3.1.170
    • removeGroupId

      void removeGroupId(String groupId)
      Removes the given group id from the list of group ids this user belongs to.
      Parameters:
      groupId - the group id to remove from the list group ids
      Since:
      3.1.170
    • isActive

      boolean isActive()
      Indicates whether this user is active or not.
      Returns:
      true if this user is active, false otherwise.
      Since:
      3.1.170
    • setActive

      void setActive(boolean active)
      Actiavates/Deactivates this user.
      Parameters:
      active - true to activate this user, false to deactivate
      Since:
      3.1.170