程序包 com.alibaba.nacos.plugin.auth.impl.roles

接口 NacosRoleService

所有已知实现类:
AbstractCachedRoleService, AbstractCheckedRoleService, NacosRoleServiceDirectImpl, NacosRoleServiceRemoteImpl
public interface NacosRoleService
Nacos auth plugin role service interface.
作者:
xiweng.yy

  • 方法详细资料

    • hasPermission

      boolean hasPermission(NacosUser nacosUser, Permission permission)
      Determine if the user has permission of the resource.

      Note if the user has many roles, this method returns true if any one role of the user has the desired permission.

      参数:
      nacosUser - user info
      permission - permission to auth
      返回:
      true if granted, false otherwise

    • addPermission

      void addPermission(String role, String resource, String action)
      Add permission to tole.
      参数:
      role - role name
      resource - resource
      action - action

    • deletePermission

      void deletePermission(String role, String resource, String action)
      Delete permission from role.
      参数:
      role - role name
      resource - resource
      action - action

    • getPermissions

      List<PermissionInfo> getPermissions(String role)
      Get all permissions of the role.
      参数:
      role - role name
      返回:
      List of PermissionInfo for the role

    • getPermissions

      com.alibaba.nacos.api.model.Page<PermissionInfo> getPermissions(String role, int pageNo, int pageSize)
      Accurate search permissions by role name pattern.
      参数:
      role - role name pattern
      pageNo - page number
      pageSize - page size
      返回:
      List of RoleInfo match role name pattern

    • findPermissions

      com.alibaba.nacos.api.model.Page<PermissionInfo> findPermissions(String role, int pageNo, int pageSize)
      Blur search permissions by role name pattern.
      参数:
      role - role name pattern
      pageNo - page number
      pageSize - page size
      返回:
      List of RoleInfo match role name pattern

    • isDuplicatePermission

      com.alibaba.nacos.api.model.v2.Result<Boolean> isDuplicatePermission(String role, String resource, String action)
      Judge whether the permission is duplicate.
      参数:
      role - role name
      resource - resource
      action - action
      返回:
      true if duplicate, false otherwise

    • getRoles

      List<RoleInfo> getRoles(String username)
      Get All roles for target user.
      参数:
      username - username of target user
      返回:
      List of RoleInfo for target user

    • getRoles

      com.alibaba.nacos.api.model.Page<RoleInfo> getRoles(String username, String role, int pageNo, int pageSize)
      Accurate search roles by role name pattern.
      参数:
      username - username of target user
      role - role name
      pageNo - page number
      pageSize - page size
      返回:
      List of RoleInfo match role name pattern

    • findRoles

      com.alibaba.nacos.api.model.Page<RoleInfo> findRoles(String username, String role, int pageNo, int pageSize)
      Blur search roles by role name pattern.
      参数:
      username - username of target user
      role - role name pattern
      pageNo - page number
      pageSize - page size
      返回:
      List of RoleInfo match role name pattern

    • findRoleNames

      List<String> findRoleNames(String role)
      Blur search role names by role name pattern.
      参数:
      role - role name pattern
      返回:
      List of RoleInfo match role name pattern

    • getAllRoles

      List<RoleInfo> getAllRoles()
      Get All roles in Nacos.
      返回:
      List of RoleInfo in Nacos

    • addRole

      void addRole(String role, String username)
      Add role to user.
      参数:
      role - role name
      username - user name

    • deleteRole

      void deleteRole(String role, String userName)
      Delete Role from user.
      参数:
      role - role
      userName - userName

    • deleteRole

      void deleteRole(String role)
      Delete Role from Nacos.
      参数:
      role - role

    • addAdminRole

      void addAdminRole(String username)
      Add role.
      参数:
      username - user name

    • hasGlobalAdminRole

      boolean hasGlobalAdminRole(String userName)
      Check if user has admin role.
      参数:
      userName - user name
      返回:
      true if user has admin role.

    • hasGlobalAdminRole

      boolean hasGlobalAdminRole()
      Check if all user has at least one admin role.
      返回:
      true if all user has at least one admin role.