程序包 net.sohelp.boot.dev.web.system.tenant

类 TenantController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.dev.web.system.tenant.TenantController

@RestController("dev-system-tenant")
@RequestMapping("/dev/system/tenant")
public class TenantController
extends BaseController

租户管理控制器，提供租户相关的增删改查、用户分配与取消分配等功能。

从以下版本开始:

2022/8/2

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器	说明
TenantController()

方法概要

修饰符和类型	方法	说明
ApiResult<String>	add(Map<String,Object> paramMap)	添加一个新的租户记录
ApiResult<String>	assignUser(Map<String,Object> dataMap)	分配用户到指定租户
ApiResult<String>	delete(String[] ids)	删除一个或多个租户及其关联关系
ApiResult<Map<String,Object>>	getById(String id)	根据ID获取单个租户详细信息
ApiResult<List<Map<String,Object>>>	getMenu(String tenant_id, String appUuid)	获取指定租户在某应用下的菜单权限配置情况
ApiResult<List<Map<String,Object>>>	list(Map<String,Object> paramMap)	获取所有租户列表（用于下拉选择等场景）
ApiResult<Pager<Map<String,Object>>>	page(Map<String,Object> paramMap)	分页查询所有租户信息，并统计每个租户下的用户数量
ApiResult<Pager<Map<String,Object>>>	pageAssignUser(Map<String,Object> paramMap)	根据租户ID读取已分配用户分页查询
ApiResult<Pager<Map<String,Object>>>	pageUnAssignUser(Map<String,Object> paramMap)	根据租户ID获取未分配的用户分页查询
ApiResult<String>	save(Map<String,Object> paramMap)
ApiResult<String>	setting(Map<String,Object> paramMap)	设置租户到期信息和状态
ApiResult<String>	toggleStatus(Map<String,Object> paramMap)	切换租户启用/禁用状态
ApiResult<String>	unAssignUser(Map<String,Object> dataMap)	取消分配用户
ApiResult<String>	update(Map<String,Object> paramMap)	更新现有租户的基本信息
ApiResult<String>	updateMenu(Map<String,Object> paramMap)	更新租户对应的菜单权限设置

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, response, responseStream, success, success, success, success, validateToken

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

TenantController

public TenantController()

方法详细资料

pageUnAssignUser

@GetMapping("/pageUnAssignUser")
@Permission("ADMIN")
public ApiResult<Pager<Map<String,Object>>> pageUnAssignUser(@RequestParam
 Map<String,Object> paramMap)

根据租户ID获取未分配的用户分页查询

参数:

paramMap - 请求参数映射，必须包含"tenant_id"

返回:

返回分页结果，包含未分配用户的列表信息

pageAssignUser

@GetMapping("/pageAssignUser")
@Permission("ADMIN")
public ApiResult<Pager<Map<String,Object>>> pageAssignUser(@RequestParam
 Map<String,Object> paramMap)

根据租户ID读取已分配用户分页查询

参数:

paramMap - 请求参数映射，必须包含"tenant_id"

返回:

返回分页结果，包含已分配用户的列表信息

assignUser

@Transactional(rollbackFor=java.lang.Exception.class)
@PostMapping("/assignUser")
@Permission("ADMIN")
public ApiResult<String> assignUser(@RequestBody
 Map<String,Object> dataMap)
                             throws SQLException

分配用户到指定租户

参数:

dataMap - 包含租户ID和要分配的用户ID列表的数据映射

返回:

操作结果提示信息

抛出:

SQLException - 数据库操作异常时抛出

unAssignUser

@Transactional(rollbackFor=java.lang.Exception.class)
@PostMapping("/unAssignUser")
@Permission("ADMIN")
public ApiResult<String> unAssignUser(@RequestBody
 Map<String,Object> dataMap)

取消分配用户

参数:

dataMap - 包含租户ID和要取消分配的用户ID列表的数据映射

返回:

操作结果提示信息

page

@GetMapping("/page")
@Permission("ADMIN")
public ApiResult<Pager<Map<String,Object>>> page(@RequestParam
 Map<String,Object> paramMap)
                                          throws Exception

分页查询所有租户信息，并统计每个租户下的用户数量

参数:

paramMap - 查询条件参数

返回:

分页数据结果集

抛出:

Exception - 查询过程中可能发生的异常

list

@GetMapping("/list")
@Permission("ADMIN")
public ApiResult<List<Map<String,Object>>> list(@RequestParam
 Map<String,Object> paramMap)
                                         throws Exception

获取所有租户列表（用于下拉选择等场景）

参数:

paramMap - 查询过滤条件

返回:

所有符合条件的租户列表

抛出:

Exception - 查询过程中的数据库访问异常

add

@PostMapping("/add")
@Permission("DEVELOPER")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog("\u6dfb\u52a0\u79df\u6237")
public ApiResult<String> add(@RequestBody
 Map<String,Object> paramMap)
                      throws Exception

添加一个新的租户记录

参数:

paramMap - 新增租户的信息参数

返回:

操作状态描述字符串

抛出:

Exception - 插入或验证过程中可能出现的异常

delete

@PostMapping("/delete")
@Transactional(rollbackFor=java.lang.Exception.class)
@Permission("DEVELOPER")
@OperationLog("\u5220\u9664\u79df\u6237")
public ApiResult<String> delete(@RequestBody
 String[] ids)
                         throws Exception

删除一个或多个租户及其关联关系

参数:

ids - 要删除的租户ID数组

返回:

操作状态描述字符串

抛出:

Exception - 删除过程中可能出现的异常

getById

@GetMapping("/getById")
@Permission("ADMIN")
public ApiResult<Map<String,Object>> getById(@RequestParam
 String id)
                                      throws Exception

根据ID获取单个租户详细信息

参数:

id - 租户唯一标识符

返回:

对应租户的完整信息

抛出:

Exception - 查询过程中的异常情况

update

@PostMapping("/update")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog("\u66f4\u65b0\u79df\u6237")
@Permission("DEVELOPER")
public ApiResult<String> update(@RequestBody
 Map<String,Object> paramMap)
                         throws Exception

更新现有租户的基本信息

参数:

paramMap - 需要更新的字段及新值

返回:

操作状态描述字符串

抛出:

Exception - 更新过程中出现的异常

setting

@PostMapping("/setting")
@Transactional(rollbackFor=java.lang.Exception.class)
@Permission("DEVELOPER")
@OperationLog("\u8bbe\u7f6e\u79df\u6237")
public ApiResult<String> setting(@RequestBody
 Map<String,Object> paramMap)
                          throws SQLException

设置租户到期信息和状态

参数:

paramMap - 包含 id, expire_type(permanent/days/date), expire_days, expire_date, status

返回:

操作结果

抛出:

SQLException

toggleStatus

@PostMapping("/toggleStatus")
@Transactional(rollbackFor=java.lang.Exception.class)
@Permission("DEVELOPER")
@OperationLog("\u5207\u6362\u79df\u6237\u72b6\u6001")
public ApiResult<String> toggleStatus(@RequestBody
 Map<String,Object> paramMap)
                               throws SQLException

切换租户启用/禁用状态

参数:

paramMap - 包含 id, status (0=禁用, 1=启用)

返回:

操作结果

抛出:

SQLException

save

@PostMapping("/save")
@Transactional(rollbackFor=java.lang.Exception.class)
@Permission("DEVELOPER")
public ApiResult<String> save(@RequestBody
 Map<String,Object> paramMap)
                       throws SQLException,
EntityException,
EntityEventException,
EntityValidateException,
EntityFormulaException,
DuplicateKeyException

抛出:

SQLException

EntityException

EntityEventException

EntityValidateException

EntityFormulaException

DuplicateKeyException

getMenu

@GetMapping("/getMenu")
@Permission("ADMIN")
public ApiResult<List<Map<String,Object>>> getMenu(@RequestParam
 String tenant_id,
 @RequestParam
 String appUuid)
                                            throws Exception

获取指定租户在某应用下的菜单权限配置情况

参数:

tenant_id - 租户ID

appUuid - 应用UUID

返回:

包含菜单项及是否被选中的列表

抛出:

Exception

updateMenu

@PostMapping("/updateMenu")
@Transactional(rollbackFor=java.lang.Exception.class)
@Permission("ADMIN")
public ApiResult<String> updateMenu(@RequestBody
 Map<String,Object> paramMap)
                             throws Exception

更新租户对应的菜单权限设置

参数:

paramMap - 请求体，包含租户ID、应用UUID以及菜单ID列表

返回:

操作结果提示信息

抛出:

Exception