top.dcenter.ums.security.core.api.oauth.signup

接口 ConnectionService

所有已知实现类:

DefaultConnectionServiceImpl

public interface ConnectionService

A command that signs up a new user in the event no user id could be mapped from a AuthUser. Allows for implicitly creating a local user profile from connection data during a provider sign-in attempt. note: To replace the implementation logic of the built-in auth_token and user_connection tables, implement this interface to inject the IOC container, And set the property ums.repository.enableStartUpInitializeTable = false.

版本:

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

作者:

YongWu zheng

方法概要

限定符和类型	方法和说明
void	binding(org.springframework.security.core.userdetails.UserDetails principal, me.zhyd.oauth.model.AuthUser authUser, String providerId) 第三方授权登录信息AuthUser绑定到本地账号UserDetails, 且添加第三方授权登录信息到 user_connection 与 auth_token
List<ConnectionData>	findConnectionByProviderIdAndProviderUserId(String providerId, String providerUserId) 根据 providerId 与 providerUserId 获取 ConnectionData list.
org.springframework.util.MultiValueMap<String,ConnectionDto>	listAllConnections(String userId) Find all connections the current user has across all providers.
org.springframework.security.core.userdetails.UserDetails	signUp(me.zhyd.oauth.model.AuthUser authUser, String providerId, String encodeState) Sign up a new user of the application from the connection.
void	unbinding(String userId, String providerId, String providerUserId) 解除绑定(第三方)
void	updateUserConnectionAndAuthToken(me.zhyd.oauth.model.AuthUser authUser, ConnectionData connectionData) 根据传入的参数更新第三方授权登录的用户信息, 包括 accessToken 信息,

方法详细资料

signUp

@NonNull
org.springframework.security.core.userdetails.UserDetails signUp(@NonNull
                                                                           me.zhyd.oauth.model.AuthUser authUser,
                                                                           @NonNull
                                                                           String providerId,
                                                                           @NonNull
                                                                           String encodeState)
                                                                    throws top.dcenter.ums.security.core.exception.RegisterUserFailureException

Sign up a new user of the application from the connection. 如果 authUser.getUsername() 重名, 则使用 authUser.getUsername() + "_" + authUser.getSource() 或 authUser.getUsername() + "_" + authUser.getSource() + "_" + authUser.getUuid() 即 username_{providerId}_{providerUserId}.

参数:

authUser - the user info from the provider sign-in attempt

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

encodeState - 加密后的 state. https://gitee.com/pcore/just-auth-spring-security-starter/issues/I22JC7

返回:

the new user UserDetails. May be null to indicate that an implicit failed to register local user.

抛出:

top.dcenter.ums.security.core.exception.RegisterUserFailureException - 用户重名或注册失败

updateUserConnectionAndAuthToken

void updateUserConnectionAndAuthToken(me.zhyd.oauth.model.AuthUser authUser,
                                      ConnectionData connectionData)
                               throws UpdateConnectionException

根据传入的参数更新第三方授权登录的用户信息, 包括 accessToken 信息,

参数:

authUser - AuthUser

connectionData - 第三方授权登录的用户信息

抛出:

UpdateConnectionException - 更新异常

binding

void binding(@NonNull
             org.springframework.security.core.userdetails.UserDetails principal,
             @NonNull
             me.zhyd.oauth.model.AuthUser authUser,
             @NonNull
             String providerId)

第三方授权登录信息AuthUser绑定到本地账号UserDetails, 且添加第三方授权登录信息到 user_connection 与 auth_token

参数:

principal - 本地用户数据

authUser - 第三方用户信息

providerId - 第三方服务商 Id

unbinding

void unbinding(@NonNull
               String userId,
               @NonNull
               String providerId,
               @NonNull
               String providerUserId)

解除绑定(第三方)

参数:

userId - 用户 Id

providerId - 第三方服务商 Id

providerUserId - 第三方用户 Id

findConnectionByProviderIdAndProviderUserId

@Nullable
List<ConnectionData> findConnectionByProviderIdAndProviderUserId(@NonNull
                                                                            String providerId,
                                                                            @NonNull
                                                                            String providerUserId)

根据 providerId 与 providerUserId 获取 ConnectionData list.

参数:

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

providerUserId - 第三方用户 Id

返回:

connection data list

listAllConnections

@NonNull
org.springframework.util.MultiValueMap<String,ConnectionDto> listAllConnections(@NonNull
                                                                                          String 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.