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

类 DefaultConnectionServiceImpl

java.lang.Object

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

所有已实现的接口:

ConnectionService

public class DefaultConnectionServiceImpl
extends Object
implements ConnectionService

默认的第三方授权登录时自动注册处理器。
signUp(AuthUser, String, String) 功能：第三方登录自动注册时, 根据 第三方的 authUser 注册为本地账户的用户, 用户名的生成规则由 UmsUserDetailsService.generateUsernames(AuthUser) 定义, 默认规则为: username 或 username + "_" + providerId 或 username + "_" + providerId + "_" + providerUserId. 如需自定义用户名生成逻辑, 重新实现 UmsUserDetailsService.generateUsernames(AuthUser) 方法即可

版本:

V2.0 Created by 2020/5/14 22:32

作者:

YongWu zheng

另请参阅:

ConnectionService

构造器概要

构造器

构造器和说明
DefaultConnectionServiceImpl(top.dcenter.ums.security.core.api.service.UmsUserDetailsService userDetailsService, Auth2Properties auth2Properties, UsersConnectionRepository usersConnectionRepository, UsersConnectionTokenRepository usersConnectionTokenRepository, Auth2StateCoder auth2StateCoder)

方法概要

限定符和类型	方法和说明
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 data) 根据传入的参数更新第三方授权登录的用户信息, 包括 accessToken 信息,

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

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

构造器详细资料

DefaultConnectionServiceImpl

public DefaultConnectionServiceImpl(top.dcenter.ums.security.core.api.service.UmsUserDetailsService userDetailsService,
                                    Auth2Properties auth2Properties,
                                    UsersConnectionRepository usersConnectionRepository,
                                    UsersConnectionTokenRepository usersConnectionTokenRepository,
                                    Auth2StateCoder auth2StateCoder)

方法详细资料

signUp

@Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRES_NEW)
 @NonNull
public 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

从接口复制的说明: ConnectionService

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}.

指定者:

signUp 在接口中 ConnectionService

参数:

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

@Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public void updateUserConnectionAndAuthToken(@NonNull
                                                                                                                                          me.zhyd.oauth.model.AuthUser authUser,
                                                                                                                                          @NonNull
                                                                                                                                          ConnectionData data)
                                                                                                                                   throws UpdateConnectionException

从接口复制的说明: ConnectionService

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

指定者:

updateUserConnectionAndAuthToken 在接口中 ConnectionService

参数:

authUser - AuthUser

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

抛出:

UpdateConnectionException - 更新异常

binding

@Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public void binding(@NonNull
                                                                                                                 org.springframework.security.core.userdetails.UserDetails principal,
                                                                                                                 @NonNull
                                                                                                                 me.zhyd.oauth.model.AuthUser authUser,
                                                                                                                 @NonNull
                                                                                                                 String providerId)

从接口复制的说明: ConnectionService

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

指定者:

binding 在接口中 ConnectionService

参数:

principal - 本地用户数据

authUser - 第三方用户信息

providerId - 第三方服务商 Id

unbinding

@Transactional(rollbackFor=java.lang.Exception.class,
               propagation=REQUIRED)
public void unbinding(@NonNull
                                                                                                                   String userId,
                                                                                                                   @NonNull
                                                                                                                   String providerId,
                                                                                                                   @NonNull
                                                                                                                   String providerUserId)

从接口复制的说明: ConnectionService

解除绑定(第三方)

指定者:

unbinding 在接口中 ConnectionService

参数:

userId - 用户 Id

providerId - 第三方服务商 Id

providerUserId - 第三方用户 Id

findConnectionByProviderIdAndProviderUserId

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

从接口复制的说明: ConnectionService

根据 providerId 与 providerUserId 获取 ConnectionData list.

指定者:

findConnectionByProviderIdAndProviderUserId 在接口中 ConnectionService

参数:

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

providerUserId - 第三方用户 Id

返回:

connection data list

listAllConnections

@NonNull
public org.springframework.util.MultiValueMap<String,ConnectionDto> listAllConnections(@NonNull
                                                                                                 String userId)

从接口复制的说明: ConnectionService

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.

指定者:

listAllConnections 在接口中 ConnectionService

参数:

userId - the userId

返回:

all connections the current user has across all providers.