net.sohelp.boot.dev.web.ops.oauth2

类 OAuth2Controller

java.lang.Object

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

net.sohelp.boot.dev.web.ops.oauth2.OAuth2Controller

@RestController(value="dev-oauth2")
 @RequestMapping(value="/dev/oauth2")
public class OAuth2Controller
extends BaseController

OAuth2授权管理控制器，提供OAuth2客户端的增删改查、状态控制及密钥重置等功能。

从以下版本开始:

2023/12/20

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
OAuth2Controller()

方法概要

限定符和类型	方法和说明
ApiResult<String>	delete(Map<String,Object> appMap) 批量删除OAuth2应用记录。
ApiResult<String>	disabled(Map<String,Object> dataMap) 启用或禁用指定的OAuth2应用。
ApiResult<Pager<Map<String,Object>>>	page(Map<String,Object> paramMap) 根据条件分页查询OAuth2应用列表。
ApiResult<String>	resetSecret(String appId) 重新生成并设置指定OAuth2应用的AppSecret。
ApiResult<String>	save(Map<String,Object> paramMap) 保存OAuth2账户信息。

从类继承的方法 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

构造器详细资料

OAuth2Controller

public OAuth2Controller()

方法详细资料

save

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

保存OAuth2账户信息。若未传入ID则新增记录并自动生成AppID与AppSecret；否则更新已有记录。

参数:

paramMap - 请求参数映射表，必须包含字段如id（可选）、app_notes等业务相关字段

返回:

返回操作结果，成功时返回提示信息

抛出:

EntityEventException - 实体事件异常

EntityValidateException - 实体验证异常

SQLException - SQL执行异常

EntityFormulaException - 公式计算异常

EntityException - 实体通用异常

DuplicateKeyException - 主键冲突异常

TokenAuthenticationException - 认证失败异常

disabled

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

启用或禁用指定的OAuth2应用。

参数:

dataMap - 包含appId和enabled状态的数据映射

返回:

操作结果描述字符串

抛出:

SQLException - 数据库访问错误

EntityException - 实体处理异常

resetSecret

@PostMapping(value="/resetSecret")
 @Transactional(rollbackFor=java.lang.Exception.class)
 @Permission(value="ADMIN")
public ApiResult<String> resetSecret(@RequestParam
                                                                                                                                                              String appId)
                                                                                                                                                       throws SQLException,
                                                                                                                                                              EntityException

重新生成并设置指定OAuth2应用的AppSecret。

参数:

appId - 应用标识符

返回:

成功后返回新的AppSecret

抛出:

SQLException - 数据库访问错误

EntityException - 实体处理异常

page

@PostMapping(value="/page")
 @Permission(value="ADMIN")
public ApiResult<Pager<Map<String,Object>>> page(@RequestBody
                                                                                                           Map<String,Object> paramMap)
                                                                                                    throws SQLException,
                                                                                                           EntityEventException,
                                                                                                           EntityException

根据条件分页查询OAuth2应用列表。

参数:

paramMap - 查询条件参数，支持按app_id和app_notes模糊匹配

返回:

分页数据对象，包含符合条件的应用信息列表

抛出:

SQLException - 数据库访问错误

EntityEventException - 实体事件异常

EntityException - 实体处理异常

delete

@PostMapping(value="/delete")
 @Permission(value="ADMIN")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> delete(@RequestBody(required=false)
                                                                                                                                                    Map<String,Object> appMap)
                                                                                                                                             throws SQLException

批量删除OAuth2应用记录。

参数:

appMap - 请求参数，应包含一个名为"appId"的列表用于指定要删除的应用ID集合

返回:

删除操作的结果描述

抛出:

SQLException - 数据库访问错误