net.sohelp.boot.dev.web.system.config

类 SysConfigController

java.lang.Object

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

net.sohelp.boot.dev.web.system.config.SysConfigController

@RestController(value="dev-system-config")
 @RequestMapping(value="/dev/system/config")
public class SysConfigController
extends BaseController

系统配置控制器，用于管理系统相关的各种配置信息。

从以下版本开始:

2023/3/28

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
SysConfigController()

方法概要

限定符和类型	方法和说明
ApiResult<Map<String,Object>>	getDevConfig() 获取开发环境下的系统配置。
ApiResult<Map<String,Object>>	getDingding() 获取钉钉登录配置信息。
ApiResult<Map<String,Object>>	getDingdingMessage() 获取钉钉消息通知配置信息。
ApiResult<Map<String,Map<String,Object>>>	getLogin() 获取所有登录相关的配置信息。
ApiResult<Map<String,Object>>	getMailMessage() 获取邮件消息通知配置信息。
ApiResult<Map<String,Object>>	getParam() 获取系统基本参数配置。
ApiResult<Map<String,Object>>	getPhone() 获取手机号码登录配置信息。
ApiResult<Map<String,Object>>	getQq() 获取QQ登录配置信息。
ApiResult<Map<String,Object>>	getQywx() 获取企业微信登录配置信息。
ApiResult<Map<String,Object>>	getQywxMessage() 获取企业微信消息通知配置信息。
Object	getSystemLogo() 获取系统Logo图片资源。
ApiResult<Map<String,Object>>	getTenantConfig() 获取当前租户的配置信息。
ApiResult<Map<String,Object>>	getWx() 获取微信登录配置信息。
ApiResult<Map<String,Object>>	getWxMessage() 获取微信消息通知配置信息。
ApiResult<String>	save(Map<String,Object> paramMap) 保存系统基础设置。
ApiResult<String>	saveDevConfig(Map<String,Object> dataMap) 保存开发环境下的系统配置。
ApiResult<String>	saveDingding(Map<String,Object> paramMap) 保存钉钉登录配置信息。
ApiResult<String>	saveDingdingMessage(Map<String,Object> paramMap) 保存钉钉消息通知配置信息。
ApiResult<String>	saveLogin(Map<String,Object> paramMap) 保存登录相关配置信息，包括忘记密码、用户注册、Token、验证码及安全传输等模块。
ApiResult<String>	saveMailMessage(Map<String,Object> paramMap) 保存邮件消息通知配置信息。
ApiResult<String>	savePhone(Map<String,Object> paramMap) 保存手机号码登录配置信息。
ApiResult<String>	saveQq(Map<String,Object> paramMap) 保存QQ登录配置信息。
ApiResult<String>	saveQywx(Map<String,Object> paramMap) 保存企业微信登录配置信息。
ApiResult<String>	saveQywxMessage(Map<String,Object> paramMap) 保存企业微信消息通知配置信息。
ApiResult<String>	saveTenantConfig(Map<String,Object> dataMap) 保存租户配置信息。
ApiResult<String>	saveWeixin(Map<String,Object> paramMap) 保存微信登录配置信息。
ApiResult<String>	saveWxMessage(Map<String,Object> paramMap) 保存微信消息通知配置信息。
ApiResult<String>	uploadLogo(String logo) 上传并保存系统Logo图片。

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

构造器详细资料

SysConfigController

public SysConfigController()

方法详细资料

saveTenantConfig

@PostMapping(value="/saveTenantConfig")
 @Permission(value="ADMIN")
public ApiResult<String> saveTenantConfig(@RequestBody
                                                                                                                Map<String,Object> dataMap)
                                                                                                         throws SQLException

保存租户配置信息。

参数:

dataMap - 包含租户配置数据的映射表

返回:

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

抛出:

SQLException - 数据库访问异常时抛出

getTenantConfig

@GetMapping(value="/getTenantConfig")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getTenantConfig()
                                                                                                                  throws SQLException

获取当前租户的配置信息。

返回:

返回包含租户配置信息的结果对象

抛出:

SQLException - 数据库访问异常时抛出

saveDevConfig

@PostMapping(value="/saveDevConfig")
 @Permission(value="ADMIN")
public ApiResult<String> saveDevConfig(@RequestBody
                                                                                                          Map<String,Object> dataMap)
                                                                                                   throws SQLException

保存开发环境下的系统配置。

参数:

dataMap - 开发配置参数映射表

返回:

操作成功的响应结果

抛出:

SQLException - 数据库访问异常时抛出

getDevConfig

@GetMapping(value="/getDevConfig")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getDevConfig()
                                                                                                            throws SQLException

获取开发环境下的系统配置。

返回:

包含开发配置的数据结果

抛出:

SQLException - 数据库访问异常时抛出

uploadLogo

@PostMapping(value="/uploadLogo")
 @Permission(value="DEVELOPER")
public ApiResult<String> uploadLogo(@RequestParam
                                                                                                        String logo)
                                                                                                 throws EntityException,
                                                                                                        SQLException,
                                                                                                        EntityValidateException,
                                                                                                        EntityFormulaException,
                                                                                                        EntityEventException,
                                                                                                        DuplicateKeyException

上传并保存系统Logo图片。

参数:

logo - 图片Base64编码字符串

返回:

上传结果状态

抛出:

EntityException - 实体相关异常

SQLException - 数据库访问异常

EntityValidateException - 实体验证失败异常

EntityFormulaException - 公式计算异常

EntityEventException - 事件处理异常

DuplicateKeyException - 主键冲突异常

getSystemLogo

@GetMapping(value="/getSystemLogo")
public Object getSystemLogo()
                                                          throws IOException

获取系统Logo图片资源。

返回:

响应实体或null（如果文件不存在）

抛出:

IOException - IO读取错误时抛出

getParam

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

获取系统基本参数配置。

返回:

系统基础配置参数集合

抛出:

Exception - 处理过程中可能发生的通用异常

save

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

保存系统基础设置。

参数:

paramMap - 配置参数映射表

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

saveWeixin

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

保存微信登录配置信息。

参数:

paramMap - 微信登录配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getWx

@GetMapping(value="/getWeixin")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getWx()

获取微信登录配置信息。

返回:

微信登录配置参数集合

saveQywx

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

保存企业微信登录配置信息。

参数:

paramMap - 企业微信登录配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getQywx

@GetMapping(value="/getQywx")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getQywx()

获取企业微信登录配置信息。

返回:

企业微信登录配置参数集合

saveQq

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

保存QQ登录配置信息。

参数:

paramMap - QQ登录配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getQq

@GetMapping(value="/getQq")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getQq()

获取QQ登录配置信息。

返回:

QQ登录配置参数集合

savePhone

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

保存手机号码登录配置信息。

参数:

paramMap - 手机号码登录配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getPhone

@GetMapping(value="/getPhone")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getPhone()

获取手机号码登录配置信息。

返回:

手机号码登录配置参数集合

saveDingding

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

保存钉钉登录配置信息。

参数:

paramMap - 钉钉登录配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getDingding

@GetMapping(value="/getDingding")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getDingding()

获取钉钉登录配置信息。

返回:

钉钉登录配置参数集合

saveWxMessage

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

保存微信消息通知配置信息。

参数:

paramMap - 微信消息通知配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getWxMessage

@GetMapping(value="/getWxMessage")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getWxMessage()

获取微信消息通知配置信息。

返回:

微信消息通知配置参数集合

saveMailMessage

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

保存邮件消息通知配置信息。

参数:

paramMap - 邮件消息通知配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getMailMessage

@GetMapping(value="/getMailMessage")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getMailMessage()

获取邮件消息通知配置信息。

返回:

邮件消息通知配置参数集合

saveDingdingMessage

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

保存钉钉消息通知配置信息。

参数:

paramMap - 钉钉消息通知配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getDingdingMessage

@GetMapping(value="/getDingdingMessage")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getDingdingMessage()

获取钉钉消息通知配置信息。

返回:

钉钉消息通知配置参数集合

saveQywxMessage

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

保存企业微信消息通知配置信息。

参数:

paramMap - 企业微信消息通知配置参数

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getQywxMessage

@GetMapping(value="/getQywxMessage")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Object>> getQywxMessage()

获取企业微信消息通知配置信息。

返回:

企业微信消息通知配置参数集合

saveLogin

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

保存登录相关配置信息，包括忘记密码、用户注册、Token、验证码及安全传输等模块。

参数:

paramMap - 登录配置参数映射表

返回:

操作结果状态

抛出:

Exception - 处理过程中的任意异常

getLogin

@GetMapping(value="/getLogin")
 @Permission(value="ADMIN")
public ApiResult<Map<String,Map<String,Object>>> getLogin()

获取所有登录相关的配置信息。

返回:

包含各个子项配置的总配置映射表