Package com.bytedesk.core.settings

Class SettingsRestService

java.lang.Object

com.bytedesk.core.base.BaseRestService<T,TRequest,TResponse>

com.bytedesk.core.base.BaseRestServiceWithExport<SettingsEntity,SettingsRequest,SettingsResponse,SettingsExcel>

com.bytedesk.core.settings.SettingsRestService

@Service
public class SettingsRestService
extends BaseRestServiceWithExport<SettingsEntity,SettingsRequest,SettingsResponse,SettingsExcel>

Field Summary

Fields

Modifier and Type	Field	Description
private final AuthService	authService
private final EmailRepository	emailRepository
private final org.modelmapper.ModelMapper	modelMapper
private final SettingsRepository	settingsRepository
private final SmsProviderRepository	smsProviderRepository
private final UidUtils	uidUtils
private final WorkgroupRepository	workgroupRepository

Constructor Summary

Constructors

Constructor	Description
SettingsRestService()

Method Summary

Modifier and Type	Method	Description
SettingsExcel	convertToExcel(SettingsEntity entity)	转换为Excel对象 子类必须实现此方法
SettingsResponse	convertToResponse(SettingsEntity entity)
SettingsResponse	create(SettingsRequest request)
private SettingsEntity	createPlatformSettingsEntity(SettingsRequest request)	创建平台设置实体
protected org.springframework.data.jpa.domain.Specification<SettingsEntity>	createSpecification(SettingsRequest request)	创建Specification对象，子类必须实现 用于queryByOrg的通用实现
void	delete(SettingsRequest request)
void	deleteByUid(String uid)
protected SettingsEntity	doSave(SettingsEntity entity)	子类实现具体的保存逻辑
protected org.springframework.data.domain.Page<SettingsEntity>	executePageQuery(org.springframework.data.jpa.domain.Specification<SettingsEntity> spec, org.springframework.data.domain.Pageable pageable)	执行分页查询，子类必须实现 用于queryByOrg的通用实现
Boolean	existsByUid(String uid)
Optional<SettingsEntity>	findByNameAndOrgUidAndType(String name, String orgUid, String type)
Optional<SettingsEntity>	findByUid(String uid)
SettingsResponse	getPlatformSettings(String type)	获取平台级别设置
private String	getPlatformSettingsDescription(String type)	获取平台设置描述
private String	getPlatformSettingsName(String type)	获取平台设置名称
String	getTicketCenterWorkgroupUid()	获取工单中心工作组UID
SettingsEntity	handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e, SettingsEntity entity)
void	initPlatformTicketCenterSettings()	初始化平台工单中心设置 使用默认工作组 DEFAULT_WORKGROUP_UID_TICKET
void	initSettings(String orgUid)	初始化平台级别设置 检查是否已初始化，如果未初始化则创建默认的平台设置
SettingsResponse	savePlatformSettings(SettingsRequest request)	保存/更新平台级别设置
boolean	testEmailSettings(String testEmail)	测试邮件配置
boolean	testSmsSettings(String testMobile)	测试短信配置
SettingsResponse	update(SettingsRequest request)
private void	updatePlatformSettingsEntity(SettingsEntity entity, SettingsRequest request)	更新平台设置实体字段

Methods inherited from class com.bytedesk.core.base.BaseRestServiceWithExport

queryByOrgEntity

Methods inherited from class com.bytedesk.core.base.BaseRestService

deleteByOrgUid, findByOrgUid, getUidFromRequest, queryByOrg, queryByUid, queryByUser, recover, save, setUserUidToRequest

Methods inherited from class java.lang.Object

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

Field Details

settingsRepository

private final SettingsRepository settingsRepository

modelMapper

private final org.modelmapper.ModelMapper modelMapper

uidUtils

private final UidUtils uidUtils

authService

private final AuthService authService

emailRepository

private final EmailRepository emailRepository

smsProviderRepository

private final SmsProviderRepository smsProviderRepository

workgroupRepository

private final WorkgroupRepository workgroupRepository

Constructor Details

SettingsRestService

public SettingsRestService()

Method Details

createSpecification

protected org.springframework.data.jpa.domain.Specification<SettingsEntity> createSpecification(SettingsRequest request)

Description copied from class: BaseRestService

创建Specification对象，子类必须实现 用于queryByOrg的通用实现

Specified by:

createSpecification in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

executePageQuery

protected org.springframework.data.domain.Page<SettingsEntity> executePageQuery(org.springframework.data.jpa.domain.Specification<SettingsEntity> spec,
 org.springframework.data.domain.Pageable pageable)

Description copied from class: BaseRestService

执行分页查询，子类必须实现 用于queryByOrg的通用实现

Specified by:

executePageQuery in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

findByUid

@Cacheable(value="settings",
           key="#uid",
           unless="#result==null")
public Optional<SettingsEntity> findByUid(String uid)

Specified by:

findByUid in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

findByNameAndOrgUidAndType

@Cacheable(value="settings",
           key="#name + \'_\' + #orgUid + \'_\' + #type",
           unless="#result==null")
public Optional<SettingsEntity> findByNameAndOrgUidAndType(String name,
 String orgUid,
 String type)

existsByUid

public Boolean existsByUid(String uid)

create

@Transactional
public SettingsResponse create(SettingsRequest request)

Specified by:

create in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

update

@Transactional
public SettingsResponse update(SettingsRequest request)

Specified by:

update in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

doSave

@CacheEvict(value="settings",key="#entity.uid") @CacheEvict(value="settings",key="#entity.name + \'_\' + #entity.orgUid + \'_\' + #entity.type",condition="#entity.name != null && #entity.orgUid != null && #entity.type != null") @CacheEvict(value="platformSettings",key="#entity.type",condition="#entity.level != null && #entity.level.equals(T(com.bytedesk.core.enums.LevelEnum).PLATFORM.name())")
protected SettingsEntity doSave(SettingsEntity entity)

Description copied from class: BaseRestService

子类实现具体的保存逻辑

Specified by:

doSave in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

handleOptimisticLockingFailureException

public SettingsEntity handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e,
 SettingsEntity entity)

Specified by:

handleOptimisticLockingFailureException in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

deleteByUid

@Transactional
public void deleteByUid(String uid)

Specified by:

deleteByUid in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

delete

public void delete(SettingsRequest request)

Specified by:

delete in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

convertToResponse

public SettingsResponse convertToResponse(SettingsEntity entity)

Specified by:

convertToResponse in class BaseRestService<SettingsEntity,SettingsRequest,SettingsResponse>

convertToExcel

public SettingsExcel convertToExcel(SettingsEntity entity)

Description copied from class: BaseRestServiceWithExport

转换为Excel对象 子类必须实现此方法

Specified by:

convertToExcel in class BaseRestServiceWithExport<SettingsEntity,SettingsRequest,SettingsResponse,SettingsExcel>

initSettings

public void initSettings(String orgUid)

初始化平台级别设置 检查是否已初始化，如果未初始化则创建默认的平台设置

Parameters:

orgUid - 组织UID（用于组织级别设置，平台级别设置使用默认组织）

initPlatformTicketCenterSettings

@Transactional
public void initPlatformTicketCenterSettings()

初始化平台工单中心设置 使用默认工作组 DEFAULT_WORKGROUP_UID_TICKET

getPlatformSettings

@Cacheable(value="platformSettings",
           key="#type",
           unless="#result == null")
public SettingsResponse getPlatformSettings(String type)

获取平台级别设置

Parameters:

type - 设置类型 (EMAIL, SMS, TICKET_CENTER)

Returns:

设置响应

savePlatformSettings

@CacheEvict(value="platformSettings",
            key="#request.type")
@Transactional
public SettingsResponse savePlatformSettings(SettingsRequest request)

保存/更新平台级别设置

Parameters:

request - 设置请求

Returns:

设置响应

createPlatformSettingsEntity

private SettingsEntity createPlatformSettingsEntity(SettingsRequest request)

创建平台设置实体

updatePlatformSettingsEntity

private void updatePlatformSettingsEntity(SettingsEntity entity,
 SettingsRequest request)

更新平台设置实体字段

getPlatformSettingsName

private String getPlatformSettingsName(String type)

获取平台设置名称

getPlatformSettingsDescription

private String getPlatformSettingsDescription(String type)

获取平台设置描述

testEmailSettings

public boolean testEmailSettings(String testEmail)

测试邮件配置

Parameters:

testEmail - 测试邮件地址

Returns:

是否发送成功

testSmsSettings

public boolean testSmsSettings(String testMobile)

测试短信配置

Parameters:

testMobile - 测试手机号

Returns:

是否发送成功

getTicketCenterWorkgroupUid

public String getTicketCenterWorkgroupUid()

获取工单中心工作组UID

Returns:

工作组UID