Package com.bytedesk.core.socket.connection

Class ConnectionRestService

java.lang.Object

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

com.bytedesk.core.base.BaseRestServiceWithExport<ConnectionEntity,ConnectionRequest,ConnectionResponse,ConnectionExcel>

com.bytedesk.core.socket.connection.ConnectionRestService

@Service
public class ConnectionRestService
extends BaseRestServiceWithExport<ConnectionEntity,ConnectionRequest,ConnectionResponse,ConnectionExcel>

Field Summary

Fields

Modifier and Type	Field	Description
private final AuthService	authService
private final org.springframework.cache.CacheManager	cacheManager
private final ConnectionMetrics	connectionMetrics
private final ConnectionRepository	connectionRepository
private static final long	MIN_INTERVAL_MS
private final org.modelmapper.ModelMapper	modelMapper
private final PresenceTtlResolver	presenceTtlResolver
private final org.springframework.data.redis.core.StringRedisTemplate	stringRedisTemplate
private final UidUtils	uidUtils

Constructor Summary

Constructors

Constructor	Description
ConnectionRestService()

Method Summary

Modifier and Type	Method	Description
private void	applyConnectedState(ConnectionEntity entity, String protocol, Integer ttlSeconds, long now)
private void	cacheLastDbWrite(String clientId, long ts)
ConnectionExcel	convertToExcel(ConnectionEntity entity)	转换为Excel对象 子类必须实现此方法
ConnectionResponse	convertToResponse(ConnectionEntity entity)
int	countActiveConnections(String userUid)
ConnectionResponse	create(ConnectionRequest request)
protected org.springframework.data.jpa.domain.Specification<ConnectionEntity>	createSpecification(ConnectionRequest request)	创建Specification对象，子类必须实现 用于queryByOrg的通用实现
void	delete(ConnectionRequest request)
void	deleteByUid(String uid)
protected ConnectionEntity	doSave(ConnectionEntity entity)	子类实现具体的保存逻辑
private boolean	ensureConnectionExistsFromHeartbeat(String clientId, long now)
private void	evictPresenceCaches(String userUid)
protected org.springframework.data.domain.Page<ConnectionEntity>	executePageQuery(org.springframework.data.jpa.domain.Specification<ConnectionEntity> spec, org.springframework.data.domain.Pageable pageable)	执行分页查询，子类必须实现 用于queryByOrg的通用实现
Boolean	existsByUid(String uid)
int	expireStaleSessions()	Cleanup expired (stale) connections by TTL
private ConnectionEntity	fetchConnectionForUpdate(String clientId, Supplier<ConnectionEntity> creator)
Optional<ConnectionEntity>	findByUid(String uid)
int	flushHeartbeatCacheBatch(Map<String,Long> heartbeats)	批量刷新心跳缓存到数据库，返回成功更新条数。
PresenceResponse	getPresence(String userUid)
ConnectionEntity	handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e, ConnectionEntity entity)
void	heartbeat(String clientId)	Update heartbeat for a client connection
boolean	isUserOnline(String userUid)	Determine online (has >=1 active non-expired connection)
List<ConnectionResponse>	listActiveConnections(String userUid)
void	markConnected(String userUid, String orgUid, String clientId, String deviceUid, String protocol, String channel, String ip, String userAgent, Integer ttlSeconds)	Mark (or create) a connection as connected.
void	markDisconnected(String clientId)	Mark a client connection as disconnected
private void	tryWriteHeartbeatToCache(String clientId, long ts)
ConnectionResponse	update(ConnectionRequest 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

connectionRepository

private final ConnectionRepository connectionRepository

modelMapper

private final org.modelmapper.ModelMapper modelMapper

uidUtils

private final UidUtils uidUtils

authService

private final AuthService authService

presenceTtlResolver

private final PresenceTtlResolver presenceTtlResolver

connectionMetrics

private final ConnectionMetrics connectionMetrics

stringRedisTemplate

private final org.springframework.data.redis.core.StringRedisTemplate stringRedisTemplate

cacheManager

private final org.springframework.cache.CacheManager cacheManager

MIN_INTERVAL_MS

private static final long MIN_INTERVAL_MS

See Also:

• Constant Field Values

Constructor Details

ConnectionRestService

public ConnectionRestService()

Method Details

createSpecification

protected org.springframework.data.jpa.domain.Specification<ConnectionEntity> createSpecification(ConnectionRequest request)

Description copied from class: BaseRestService

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

Specified by:

createSpecification in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

executePageQuery

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

Description copied from class: BaseRestService

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

Specified by:

executePageQuery in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

findByUid

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

Specified by:

findByUid in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

existsByUid

public Boolean existsByUid(String uid)

create

@Transactional
public ConnectionResponse create(ConnectionRequest request)

Specified by:

create in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

update

@Transactional
public ConnectionResponse update(ConnectionRequest request)

Specified by:

update in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

doSave

protected ConnectionEntity doSave(ConnectionEntity entity)

Description copied from class: BaseRestService

子类实现具体的保存逻辑

Specified by:

doSave in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

handleOptimisticLockingFailureException

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

Specified by:

handleOptimisticLockingFailureException in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

deleteByUid

@Transactional
public void deleteByUid(String uid)

Specified by:

deleteByUid in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

delete

public void delete(ConnectionRequest request)

Specified by:

delete in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

convertToResponse

public ConnectionResponse convertToResponse(ConnectionEntity entity)

Specified by:

convertToResponse in class BaseRestService<ConnectionEntity,ConnectionRequest,ConnectionResponse>

convertToExcel

public ConnectionExcel convertToExcel(ConnectionEntity entity)

Description copied from class: BaseRestServiceWithExport

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

Specified by:

convertToExcel in class BaseRestServiceWithExport<ConnectionEntity,ConnectionRequest,ConnectionResponse,ConnectionExcel>

markConnected

@Transactional
public void markConnected(String userUid,
 String orgUid,
 String clientId,
 String deviceUid,
 String protocol,
 String channel,
 String ip,
 String userAgent,
 Integer ttlSeconds)

Mark (or create) a connection as connected. clientId format recommendation: userUid/client/deviceUid

heartbeat

@Transactional
public void heartbeat(String clientId)

Update heartbeat for a client connection

tryWriteHeartbeatToCache

private void tryWriteHeartbeatToCache(String clientId,
 long ts)

cacheLastDbWrite

private void cacheLastDbWrite(String clientId,
 long ts)

fetchConnectionForUpdate

private ConnectionEntity fetchConnectionForUpdate(String clientId,
 Supplier<ConnectionEntity> creator)

applyConnectedState

private void applyConnectedState(ConnectionEntity entity,
 String protocol,
 Integer ttlSeconds,
 long now)

ensureConnectionExistsFromHeartbeat

private boolean ensureConnectionExistsFromHeartbeat(String clientId,
 long now)

flushHeartbeatCacheBatch

@Transactional
public int flushHeartbeatCacheBatch(Map<String,Long> heartbeats)

批量刷新心跳缓存到数据库，返回成功更新条数。 该方法供定时任务调用。

markDisconnected

@Transactional
public void markDisconnected(String clientId)

Mark a client connection as disconnected

expireStaleSessions

@Transactional
public int expireStaleSessions()

Cleanup expired (stale) connections by TTL

isUserOnline

@Transactional(readOnly=true)
public boolean isUserOnline(String userUid)

Determine online (has >=1 active non-expired connection)

countActiveConnections

@Transactional(readOnly=true)
public int countActiveConnections(String userUid)

getPresence

@Transactional(readOnly=true)
@Cacheable(value="presence",
           key="#userUid",
           unless="#result == null")
public PresenceResponse getPresence(String userUid)

listActiveConnections

@Transactional(readOnly=true)
@Cacheable(value="activeConnections",
           key="#userUid",
           unless="#result == null")
public List<ConnectionResponse> listActiveConnections(String userUid)

evictPresenceCaches

private void evictPresenceCaches(String userUid)