top.dcenter.ums.security.core.oauth.repository.jdbc

类 Auth2JdbcUsersConnectionRepository

java.lang.Object

top.dcenter.ums.security.core.oauth.repository.jdbc.Auth2JdbcUsersConnectionRepository

所有已实现的接口:

UsersConnectionRepository

@CacheConfig(cacheManager="auth2RedisHashCacheManager")
public class Auth2JdbcUsersConnectionRepository
extends Object
implements UsersConnectionRepository

A data access interface for managing a global store of users connections to service providers. Provides data access operations. 抽取了 sql 语句，与 用户表的字段名称到 RepositoryProperties, 更便于用户自定义。

redis 缓存 key 说明: "h:"(单个返回值)/"hs(多个返回值):" 前缀表示为 hash key 前缀(绝对匹配), "hm:" 前缀表示为 hash key 前缀(父 key 可匹配, field 不能), "__" 为 hash key 的分隔符. 下面为 key 列表:

 USER_CONNECTION_HASH_CACHE_NAME:    'hs:' + providerId + '__' + providerUserId
 USER_CONNECTION_HASH_CACHE_NAME:    'h:' + userId + ':' + providerId + '__' + providerUserId
 USER_CONNECTION_HASH_CACHE_NAME:    'h:' + userId + '__' + providerId
 USER_CONNECTION_HASH_CACHE_NAME:    'hs:' + userId + '__' + providerId

 USER_CONNECTION_HASH_ALL_CLEAR_CACHE_NAME:   'hm:' + providerId + '__' + providerUserIds
 USER_CONNECTION_HASH_ALL_CLEAR_CACHE_NAME:   'hm:' + userId + '__' + methodName(findAllConnections,findAllListConnections)
 USER_CONNECTION_HASH_ALL_CLEAR_CACHE_NAME:   'hm:' + userId + '__' + providerUsers
 USER_CONNECTION_HASH_ALL_CLEAR_CACHE_NAME:   'hm:' + userId + '__' + parameters
 

版本:

V2.0 Created by 2020/5/13 13:41

作者:

YongWu zheng

构造器概要

构造器

构造器和说明
Auth2JdbcUsersConnectionRepository(org.springframework.jdbc.core.JdbcTemplate auth2UserConnectionJdbcTemplate, org.springframework.security.crypto.encrypt.TextEncryptor textEncryptor, RepositoryProperties repositoryProperties)

方法概要

限定符和类型	方法和说明
ConnectionData	addConnection(ConnectionData connection) 绑定.
org.springframework.util.MultiValueMap<String,ConnectionData>	findAllConnections(String userId) 获取 userId 的所有绑定信息.
List<ConnectionData>	findAllListConnections(String userId) 根据 userId 获取 ConnectionData list.
List<ConnectionData>	findConnectionByProviderIdAndProviderUserId(String providerId, String providerUserId) 根据 providerId 与 providerUserId 获取 ConnectionData list.
ConnectionData	findConnectionByTokenId(Long tokenId) 根据 tokenId 查找 ConnectionData 注意: 这里不做 spring cache 缓存处理, 这个接口主要用于 refreshToken 的定时任务, 只调用一次, 缓存无意义
List<ConnectionData>	findConnections(String userId, String providerId) 获取 userId 和 providerId 的所以绑定信息.
List<ConnectionData>	findConnectionsToUsers(org.springframework.jdbc.core.namedparam.MapSqlParameterSource parameters, String providerUsersCriteriaSql, String userId) 根据 userId 通过指定 providerUsersCriteriaSql 与 parameters 的 sql 获取 ConnectionData list
org.springframework.util.MultiValueMap<String,ConnectionData>	findConnectionsToUsers(String userId, org.springframework.util.MultiValueMap<String,String> providerUsers) 获取 userId 和 providerUserIds 的所以绑定信息.
ConnectionData	findPrimaryConnection(String userId, String providerId) 根据 userId 与 providerId 获取 ConnectionData.
Set<String>	findUserIdsConnectedTo(String providerId, Set<String> providerUserIds) Find the ids of the users who are connected to the specific provider user accounts.
ConnectionData	getConnection(String userId, top.dcenter.ums.security.core.api.oauth.entity.ConnectionKey connectionKey) 根据 userId 和 connectionKey 获取 ConnectionData.
ConnectionData	getPrimaryConnection(String userId, String providerId) 获取 userId 和 providerId 的所以 rank 值最小的绑定信息.
void	removeConnection(String userId, top.dcenter.ums.security.core.api.oauth.entity.ConnectionKey connectionKey) 解除绑定.
void	removeConnections(String userId, String providerId) 解除绑定.
ConnectionData	updateConnection(ConnectionData connection) Update a Connection already added to this repository.
ConnectionData	updateConnectionByTokenId(AuthTokenPo token) 根据 AuthTokenPo#getId() 更新 ConnectionData.

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

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

构造器详细资料

Auth2JdbcUsersConnectionRepository

public Auth2JdbcUsersConnectionRepository(org.springframework.jdbc.core.JdbcTemplate auth2UserConnectionJdbcTemplate,
                                          org.springframework.security.crypto.encrypt.TextEncryptor textEncryptor,
                                          RepositoryProperties repositoryProperties)

方法详细资料

findConnectionByProviderIdAndProviderUserId

@Cacheable(cacheNames="UCHC",
           key="\'hs:\' + #providerId + \'__\' + #providerUserId")
public List<ConnectionData> findConnectionByProviderIdAndProviderUserId(String providerId,
                                                                                                                                                                           String providerUserId)

从接口复制的说明: UsersConnectionRepository

根据 providerId 与 providerUserId 获取 ConnectionData list.

指定者:

findConnectionByProviderIdAndProviderUserId 在接口中 UsersConnectionRepository

参数:

providerId - 第三方服务商, 如: qq, github

providerUserId - 第三方用户 Id

返回:

connection data list

findUserIdsConnectedTo

@Cacheable(cacheNames="UCHACC",
           key="\'hm:\' + #providerId + \'__\' + #providerUserIds")
public Set<String> findUserIdsConnectedTo(String providerId,
                                                                                                                                                Set<String> providerUserIds)

从接口复制的说明: UsersConnectionRepository

Find the ids of the users who are connected to the specific provider user accounts.

指定者:

findUserIdsConnectedTo 在接口中 UsersConnectionRepository

参数:

providerId - 第三方服务商, 如: qq, github

providerUserIds - the set of provider user ids e.g. ("987665", "435796", "584444").

返回:

the set of user ids connected to those service provider users, or empty if none.

findAllConnections

@Cacheable(cacheNames="UCHACC",
           key="\'hm:\' + #userId + \'__\' + #root.methodName")
public org.springframework.util.MultiValueMap<String,ConnectionData> findAllConnections(String userId)

从接口复制的说明: UsersConnectionRepository

获取 userId 的所有绑定信息. Find all connections the current user has across all providers. The returned map contains an entry for each provider the user is connected to. The key for each entry is the providerId, and the value is the list of ConnectionDatas that exist between the user and that provider. For example, if the user is connected once to Facebook and twice to Twitter, the returned map would contain two entries with the following structure:

 {
     "qq" -> Connection("Jack") ,
     "github"  -> Connection("Tomas"), Connection("Jessica")
 }
 

The returned map is sorted by providerId and entry values are ordered by rank. Returns an empty map if the user has no connections.

指定者:

findAllConnections 在接口中 UsersConnectionRepository

参数:

userId - the userId

返回:

all connections the current user has across all providers.

findConnections

@Cacheable(cacheNames="UCHC",
           key="\'hs:\' + #userId + \'__\' + #providerId")
public List<ConnectionData> findConnections(String userId,
                                                                                                                                       String providerId)

从接口复制的说明: UsersConnectionRepository

获取 userId 和 providerId 的所以绑定信息. Find the connections the current user has to the provider registered by the given id e.g. 'qq'. The returned list is ordered by connection rank. Returns an empty list if the user has no connections to the provider.

指定者:

findConnections 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

providerId - the provider id e.g. "qq"

返回:

the connections the user has to the provider, or an empty list if none

findConnectionsToUsers

@Cacheable(cacheNames="UCHACC",
           key="\'hm:\' + #userId + \'__\' + #providerUsers")
public org.springframework.util.MultiValueMap<String,ConnectionData> findConnectionsToUsers(String userId,
                                                                                                                                                                                            org.springframework.util.MultiValueMap<String,String> providerUsers)

从接口复制的说明: UsersConnectionRepository

获取 userId 和 providerUserIds 的所以绑定信息. Find the connections the current user has to the given provider users. The providerUsers parameter accepts a map containing an entry for each provider the caller is interested in. The key for each entry is the providerId e.g. "qq", and the value is a list of provider user ids to fetch connections to e.g. ("987665", "435796", "584444"). The returned map has the same structure and order, except the provider userId values have been replaced by Connection instances. If no connection exists between the current user and a given provider user, a null value is returned for that position.

指定者:

findConnectionsToUsers 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

providerUsers - 第三方用户 Id

返回:

the provider user connection map

getConnection

@Cacheable(cacheNames="UCHC",
           key="\'h:\' + #userId + \':\' + #connectionKey.providerId + \'__\' + #connectionKey.providerUserId")
public ConnectionData getConnection(String userId,
                                                                                                                                                                                    top.dcenter.ums.security.core.api.oauth.entity.ConnectionKey connectionKey)
                                                                                                                                                                             throws NoSuchConnectionException

从接口复制的说明: UsersConnectionRepository

根据 userId 和 connectionKey 获取 ConnectionData. 获取 userId 和 providerId, provideUserId 的绑定信息.

指定者:

getConnection 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

connectionKey - connectionKey

返回:

ConnectionData

抛出:

NoSuchConnectionException - no such connection exception

findPrimaryConnection

@Cacheable(cacheNames="UCHC",
           key="\'h:\' + #userId + \'__\' + #providerId")
public ConnectionData findPrimaryConnection(String userId,
                                                                                                                                      String providerId)

从接口复制的说明: UsersConnectionRepository

根据 userId 与 providerId 获取 ConnectionData. 获取 userId 和 providerId 的所以 rank 值最小的绑定信息.

指定者:

findPrimaryConnection 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

providerId - the provider id e.g. "qq"

返回:

ConnectionData

getPrimaryConnection

@Cacheable(cacheNames="UCHC",
           key="\'h:\' + #userId + \'__\' + #providerId")
public ConnectionData getPrimaryConnection(String userId,
                                                                                                                                     String providerId)
                                                                                                                              throws NotConnectedException

从接口复制的说明: UsersConnectionRepository

获取 userId 和 providerId 的所以 rank 值最小的绑定信息. Get the "primary" connection the current user. If the user has multiple connections to the provider, this method returns the one with the top rank (or priority). Useful for direct use by application code to obtain a parameterized Connection instance.

指定者:

getPrimaryConnection 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

providerId - the provider id e.g. "qq"

返回:

the primary connection

抛出:

NotConnectedException - if the user is not connected to the provider of the API

addConnection

@Caching(evict={@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #connection.userId",beforeInvocation=true),@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #connection.providerId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'h:\' + #connection.userId + \':\' + #connection.providerId + \'__\' + #connection.providerUserId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'h:\' + #connection.userId + \'__\' + #connection.providerId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'hs:\' + #connection.userId + \'__\' + #connection.providerId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'hs:\' + #connection.providerId + \'__\' + #connection.providerUserId",beforeInvocation=true)},put={@CachePut(cacheNames="UCHC",key="\'h:\' + #connection.userId + \'__\' + #connection.providerId"),@CachePut(cacheNames="UCHC",key="\'h:\' + #connection.userId + \':\' + #connection.providerId + \'__\' + #connection.providerUserId")})
 @Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public ConnectionData addConnection(ConnectionData connection)

从接口复制的说明: UsersConnectionRepository

绑定. Add a new connection to this repository for the current user. After the connection is added, it can be retrieved later using one of the finders defined in this interface.

指定者:

addConnection 在接口中 UsersConnectionRepository

参数:

connection - the new connection to add to this repository

返回:

ConnectionData 这里返回值的目的主要为了更新 spring cache

updateConnection

@Caching(evict={@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #connection.userId",beforeInvocation=true),@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #connection.providerId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'h:\' + #connection.userId + \':\' + #connection.providerId + \'__\' + #connection.providerUserId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'h:\' + #connection.userId + \'__\' + #connection.providerId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'hs:\' + #connection.userId + \'__\' + #connection.providerId",beforeInvocation=true),@CacheEvict(cacheNames="UCHC",key="\'hs:\' + #connection.providerId + \'__\' + #connection.providerUserId",beforeInvocation=true)},put={@CachePut(cacheNames="UCHC",key="\'h:\' + #connection.userId + \'__\' + #connection.providerId"),@CachePut(cacheNames="UCHC",key="\'h:\' + #connection.userId + \':\' + #connection.providerId + \'__\' + #connection.providerUserId")})
 @Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public ConnectionData updateConnection(ConnectionData connection)

从接口复制的说明: UsersConnectionRepository

Update a Connection already added to this repository. Merges the field values of the given connection object with the values stored in the repository.

指定者:

updateConnection 在接口中 UsersConnectionRepository

参数:

connection - the existing connection to update in this repository

返回:

ConnectionData 这里返回值的目的主要为了更新 spring cache

updateConnectionByTokenId

@Caching(evict={@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #result.userId"),@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #result.providerId"),@CacheEvict(cacheNames="UCHC",key="\'hs:\' + #result.userId + \'__\' + #result.providerId"),@CacheEvict(cacheNames="UCHC",key="\'hs:\' + #result.providerId + \'__\' + #result.providerUserId")},put={@CachePut(cacheNames="UCHC",key="\'h:\' + #result.userId + \'__\' + #result.providerId"),@CachePut(cacheNames="UCHC",key="\'h:\' + #result.userId + \':\' + #result.providerId + \'__\' + #result.providerUserId")})
 @Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public ConnectionData updateConnectionByTokenId(AuthTokenPo token)

从接口复制的说明: UsersConnectionRepository

根据 AuthTokenPo#getId() 更新 ConnectionData.
注意: 使用这个接口更新会使 spring cache 缓存更新延迟, 出现缓存强一致性问题, 这接口目的用于 refreshToken 的定时任务, 更新 时间一般在凌晨 1-5 点.

指定者:

updateConnectionByTokenId 在接口中 UsersConnectionRepository

参数:

token - AuthTokenPo

返回:

返回更新过的 ConnectionData, 还可以顺便更新 spring cache

findConnectionByTokenId

public ConnectionData findConnectionByTokenId(Long tokenId)

从接口复制的说明: UsersConnectionRepository

根据 tokenId 查找 ConnectionData
注意: 这里不做 spring cache 缓存处理, 这个接口主要用于 refreshToken 的定时任务, 只调用一次, 缓存无意义

指定者:

findConnectionByTokenId 在接口中 UsersConnectionRepository

参数:

tokenId - AuthTokenPo#getId()

返回:

ConnectionData

removeConnections

@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #userId",beforeInvocation=true) @CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #providerId",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",key="\'h:\' + #userId + \':\' + #providerId",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",key="\'h:\' + #userId + \'__\' + #providerId",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",key="\'hs:\' + #userId + \':\' + #providerId",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",key="\'hs:\' + #providerId",beforeInvocation=true)
 @Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public void removeConnections(String userId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String providerId)

从接口复制的说明: UsersConnectionRepository

解除绑定. Remove all Connections between the current user and the provider from this repository. Does nothing if no provider connections exist.

指定者:

removeConnections 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

providerId - the provider id e.g. "qq"

removeConnection

@CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #userId",beforeInvocation=true) @CacheEvict(cacheNames="UCHACC",key="\'hm:\' + #connectionKey.providerId",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",keyGenerator="removeConnectionsByConnectionKeyWithUserIdKeyGenerator",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",key="\'h:\' + #userId + \'__\' + #connectionKey.providerId",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",key="\'hs:\' + #userId + \'__\' + #connectionKey.providerId",beforeInvocation=true) @CacheEvict(cacheNames="UCHC",key="\'hs:\' + #connectionKey.providerId + \'__\' + #connectionKey.providerUserId",beforeInvocation=true)
 @Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public void removeConnection(String userId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  top.dcenter.ums.security.core.api.oauth.entity.ConnectionKey connectionKey)

从接口复制的说明: UsersConnectionRepository

解除绑定. Remove a single Connection for the current user from this repository. Does nothing if no such connection exists.

指定者:

removeConnection 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

connectionKey - the connection key

findAllListConnections

@Cacheable(cacheNames="UCHACC",
           key="\'hm:\' + #userId + \'__\' + #root.methodName")
public List<ConnectionData> findAllListConnections(String userId)

从接口复制的说明: UsersConnectionRepository

根据 userId 获取 ConnectionData list. 获取 userId 的所有绑定信息.

指定者:

findAllListConnections 在接口中 UsersConnectionRepository

参数:

userId - 本地账户用户 Id

返回:

connection data list

findConnectionsToUsers

@Cacheable(cacheNames="UCHACC",
           key="\'hm:\' + #userId + \'__\' + #parameters")
public List<ConnectionData> findConnectionsToUsers(org.springframework.jdbc.core.namedparam.MapSqlParameterSource parameters,
                                                                                                                                                String providerUsersCriteriaSql,
                                                                                                                                                String userId)

从接口复制的说明: UsersConnectionRepository

根据 userId 通过指定 providerUsersCriteriaSql 与 parameters 的 sql 获取 ConnectionData list

指定者:

findConnectionsToUsers 在接口中 UsersConnectionRepository

参数:

parameters - sql 的 where 条件 与 对应参数

providerUsersCriteriaSql - providerUsersCriteriaSql

userId - 本地账户用户 Id

返回:

connection data list