UsersConnectionRepository (ums-oauth 2.2.25 API)

所有已知实现类:

Auth2JdbcUsersConnectionRepository
```
public interface UsersConnectionRepository
```
A data access interface for managing a global store of users connections to service providers. Provides data access operations.

版本:

V2.0 Created by 2020-10-08 20:10

作者:

Keith Donald, YongWu zheng

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`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> providerUserIds)` 获取 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, ConnectionKey connectionKey)` 根据 userId 和 connectionKey 获取 ConnectionData.
`ConnectionData`	`getPrimaryConnection(String userId, String providerId)` 获取 userId 和 providerId 的所以 rank 值最小的绑定信息.
`void`	`removeConnection(String userId, 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`.

- 方法详细资料
  - findConnectionByProviderIdAndProviderUserId
```
List<ConnectionData> findConnectionByProviderIdAndProviderUserId(String providerId,
                                                                 String providerUserId)
```
    根据 providerId 与 providerUserId 获取 ConnectionData list.
    
    参数:
    
    providerId - 第三方服务商, 如: qq, github
    
    providerUserId - 第三方用户 Id
    
    返回:
    
    connection data list
  - findUserIdsConnectedTo
```
Set<String> findUserIdsConnectedTo(String providerId,
                                   Set<String> providerUserIds)
```
    Find the ids of the users who are connected to the specific provider user accounts.
    
    参数:
    
    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
```
org.springframework.util.MultiValueMap<String,ConnectionData> findAllConnections(String userId)
```
    获取 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.
    参数:
    
    userId - the userId
    
    返回:
    
    all connections the current user has across all providers.
  - findConnections
```
List<ConnectionData> findConnections(String userId,
                                     String providerId)
```
    获取 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.
    
    参数:
    
    userId - 本地账户用户 Id
    
    providerId - the provider id e.g. "qq"
    
    返回:
    
    the connections the user has to the provider, or an empty list if none
  - findConnectionsToUsers
```
org.springframework.util.MultiValueMap<String,ConnectionData> findConnectionsToUsers(String userId,
                                                                                     org.springframework.util.MultiValueMap<String,String> providerUserIds)
```
    获取 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.
    
    参数:
    
    userId - 本地账户用户 Id
    
    providerUserIds - 第三方用户 Id
    
    返回:
    
    the provider user connection map
  - getPrimaryConnection
```
ConnectionData getPrimaryConnection(String userId,
                                    String providerId)
                             throws NotConnectedException
```
    获取 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.
    
    参数:
    
    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
```
ConnectionData addConnection(ConnectionData connection)
```
    绑定. 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.
    
    参数:
    
    connection - the new connection to add to this repository
    
    返回:
    
    ConnectionData 这里返回值的目的主要为了更新 spring cache
    
    抛出:
    
    DuplicateConnectionException - if the user already has this connection
  - updateConnection
```
ConnectionData updateConnection(ConnectionData connection)
```
    Update a Connection already added to this repository. Merges the field values of the given connection object with the values stored in the repository.
    
    参数:
    
    connection - the existing connection to update in this repository
    
    返回:
    
    ConnectionData 这里返回值的目的主要为了更新 spring cache
  - removeConnections
```
void removeConnections(String userId,
                       String providerId)
```
    解除绑定. Remove all Connections between the current user and the provider from this repository. Does nothing if no provider connections exist.
    
    参数:
    
    userId - 本地账户用户 Id
    
    providerId - the provider id e.g. "qq"
  - removeConnection
```
void removeConnection(String userId,
                      ConnectionKey connectionKey)
```
    解除绑定. Remove a single Connection for the current user from this repository. Does nothing if no such connection exists.
    
    参数:
    
    userId - 本地账户用户 Id
    
    connectionKey - the connection key
  - findPrimaryConnection
```
ConnectionData findPrimaryConnection(String userId,
                                     String providerId)
```
    根据 userId 与 providerId 获取 ConnectionData. 获取 userId 和 providerId 的所以 rank 值最小的绑定信息.
    
    参数:
    
    userId - 本地账户用户 Id
    
    providerId - the provider id e.g. "qq"
    
    返回:
    
    ConnectionData
  - getConnection
```
ConnectionData getConnection(String userId,
                             ConnectionKey connectionKey)
                      throws NoSuchConnectionException
```
    根据 userId 和 connectionKey 获取 ConnectionData. 获取 userId 和 providerId, provideUserId 的绑定信息.
    
    参数:
    
    userId - 本地账户用户 Id
    
    connectionKey - connectionKey
    
    返回:
    
    ConnectionData
    
    抛出:
    
    NoSuchConnectionException - no such connection exception
  - findAllListConnections
```
List<ConnectionData> findAllListConnections(String userId)
```
    根据 userId 获取 ConnectionData list. 获取 userId 的所有绑定信息.
    
    参数:
    
    userId - 本地账户用户 Id
    
    返回:
    
    connection data list
  - findConnectionsToUsers
```
List<ConnectionData> findConnectionsToUsers(org.springframework.jdbc.core.namedparam.MapSqlParameterSource parameters,
                                            String providerUsersCriteriaSql,
                                            String userId)
```
    根据 userId 通过指定 providerUsersCriteriaSql 与 parameters 的 sql 获取 ConnectionData list
    
    参数:
    
    parameters - sql 的 where 条件与对应参数
    
    providerUsersCriteriaSql - providerUsersCriteriaSql
    
    userId - 本地账户用户 Id
    
    返回:
    
    connection data list
  - updateConnectionByTokenId
```
ConnectionData updateConnectionByTokenId(AuthTokenPo token)
```
    根据 AuthTokenPo#getId() 更新 ConnectionData.
    注意: 使用这个接口更新会使 spring cache 缓存更新延迟, 出现缓存强一致性问题, 这接口目的用于 refreshToken 的定时任务, 更新时间一般在凌晨 1-5 点.
    
    参数:
    
    token - AuthTokenPo
    
    返回:
    
    返回更新过的 ConnectionData, 还可以顺便更新 spring cache
  - findConnectionByTokenId
```
ConnectionData findConnectionByTokenId(Long tokenId)
```
    根据 tokenId 查找 ConnectionData
    注意: 这里不做 spring cache 缓存处理, 这个接口主要用于 refreshToken 的定时任务, 只调用一次, 缓存无意义
    
    参数:
    
    tokenId - AuthTokenPo#getId()
    
    返回:
    
    ConnectionData

接口 UsersConnectionRepository

方法概要

方法详细资料

findConnectionByProviderIdAndProviderUserId

findUserIdsConnectedTo

findAllConnections

findConnections

findConnectionsToUsers

getPrimaryConnection

addConnection

updateConnection

removeConnections

removeConnection

findPrimaryConnection

getConnection

findAllListConnections

findConnectionsToUsers

updateConnectionByTokenId

findConnectionByTokenId