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(value="dev-system-tenant")
 @RequestMapping(value="/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>>>	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) 保存租户信息：若ID为空则新增；否则判断是否重名后执行更新
ApiResult<String>	unAssignUser(Map<String,Object> dataMap) 取消分配用户
ApiResult<String>	update(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, success, success, success, success, validateToken

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

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

构造器详细资料

TenantController

public TenantController()

方法详细资料

pageUnAssignUser

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

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

参数:

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

返回:

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

pageAssignUser

@GetMapping(value="/pageAssignUser")
 @Permission(value="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(value="/assignUser")
 @Permission(value="ADMIN")
public ApiResult<String> assignUser(@RequestBody
                                                                                                                                                            Map<String,Object> dataMap)
                                                                                                                                                     throws SQLException

分配用户到指定租户

参数:

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

返回:

操作结果提示信息

抛出:

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

unAssignUser

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

取消分配用户

参数:

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

返回:

操作结果提示信息

page

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

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

参数:

paramMap - 查询条件参数

返回:

分页数据结果集

抛出:

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

list

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

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

参数:

paramMap - 查询过滤条件

返回:

所有符合条件的租户列表

抛出:

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

add

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

添加一个新的租户记录

参数:

paramMap - 新增租户的信息参数

返回:

操作状态描述字符串

抛出:

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

delete

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

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

参数:

ids - 要删除的租户ID数组

返回:

操作状态描述字符串

抛出:

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

getById

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

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

参数:

id - 租户唯一标识符

返回:

对应租户的完整信息

抛出:

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

update

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

更新现有租户的基本信息

参数:

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

返回:

操作状态描述字符串

抛出:

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

save

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

保存租户信息：若ID为空则新增；否则判断是否重名后执行更新

参数:

paramMap - 租户相关属性集合

返回:

操作状态描述字符串

抛出:

SQLException - SQL执行错误

EntityException - 实体处理异常

EntityEventException - 实体事件触发异常

EntityValidateException - 实体校验失败

EntityFormulaException - 公式计算异常

DuplicateKeyException - 主键冲突异常