cn.herodotus.engine.oauth2.authorization.definition

类 AbstractSocialAuthenticationHandler

java.lang.Object

cn.herodotus.engine.oauth2.authorization.definition.AbstractSocialAuthenticationHandler

所有已实现的接口:

SocialAuthenticationHandler

public abstract class AbstractSocialAuthenticationHandler
extends Object
implements SocialAuthenticationHandler

Description: 抽象的社交登录处理器

实现社交登录和手机号码登录的主要流程逻辑

作者:

: gengwei.zheng

Date:

: 2021/5/16 17:38

构造器概要

构造器

构造器和说明
AbstractSocialAuthenticationHandler()

方法概要

限定符和类型	方法和说明
abstract void	additionalRegisterOperation(cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser HerodotusUser, cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails) 随着系统业务复杂度的增加，系统用户注册成功之后，也许还会进行其它额外的操作，来补充新用户的相关信息。
abstract void	additionalSignInOperation(cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser HerodotusUser, cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails newSocialUserDetails, cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails oldSocialUserDetails) 社交用户登录后，附加的其它操作
cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser	authentication(String source, cn.herodotus.engine.assistant.core.domain.AccessPrincipal accessPrincipal) 社交登录 1.
abstract void	binding(String userId, cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails) 系统用户与社交用户绑定操作
abstract cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails	identity(String source, cn.herodotus.engine.assistant.core.domain.AccessPrincipal accessPrincipal) 第三方登录以及手机号码验证的认证，认证成功返回对应系统中的返回信息
abstract cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails	isUserExist(cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails) 根据社交登录返回的用户信息，查询系统中是否有响应的信息
abstract cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser	register(cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails) 系统用户注册 根据社交用户提供的一些信息，进行系统用户的注册
abstract cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser	signIn(cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails) 系统用户注册 根据社交用户提供的一些信息，进行系统用户的注册

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

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

构造器详细资料

AbstractSocialAuthenticationHandler

public AbstractSocialAuthenticationHandler()

方法详细资料

identity

public abstract cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails identity(String source,
                                                                                             cn.herodotus.engine.assistant.core.domain.AccessPrincipal accessPrincipal)
                                                                                      throws cn.herodotus.engine.access.core.exception.AccessIdentityVerificationFailedException

第三方登录以及手机号码验证的认证，认证成功返回对应系统中的返回信息

参数:

source - 社交登录提供者分类

accessPrincipal - 社交登录所需要的参数信息

返回:

认证成功后返回的信息 SocialUserDetails

抛出:

cn.herodotus.engine.access.core.exception.AccessIdentityVerificationFailedException - 社交登录认证出错

isUserExist

public abstract cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails isUserExist(cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails)

根据社交登录返回的用户信息，查询系统中是否有响应的信息

参数:

socialUserDetails - 第三方系统或者手机号码认证成功后返回的信息 SocialUserDetails

返回:

系统UserDetails SocialUserDetails

register

public abstract cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser register(cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails)
                                                                                  throws cn.herodotus.engine.oauth2.core.exception.UsernameAlreadyExistsException

系统用户注册

根据社交用户提供的一些信息，进行系统用户的注册

参数:

socialUserDetails - SocialUserDetails

返回:

系统用户 HerodotusUser

抛出:

cn.herodotus.engine.oauth2.core.exception.UsernameAlreadyExistsException - 用户名已经存在

binding

public abstract void binding(String userId,
                             cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails)
                      throws SocialCredentialsUserBindingFailedException

系统用户与社交用户绑定操作

参数:

socialUserDetails - 第三方系统或者手机号码认证成功后返回的信息 SocialUserDetails

userId - 系统用户的ID。

抛出:

SocialCredentialsUserBindingFailedException - 绑定出现错误Exception

additionalRegisterOperation

public abstract void additionalRegisterOperation(cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser HerodotusUser,
                                                 cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails)

随着系统业务复杂度的增加，系统用户注册成功之后，也许还会进行其它额外的操作，来补充新用户的相关信息。 所以提供一个方法，方便进行新用户其它业务信息的操作。建议采用是异步操作。

参数:

HerodotusUser - 系统用户信息 HerodotusUser

socialUserDetails - 社交登录过程中，第三方系统返回的新信息

signIn

public abstract cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser signIn(cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails socialUserDetails)

系统用户注册

根据社交用户提供的一些信息，进行系统用户的注册

参数:

socialUserDetails - SocialUserDetails

返回:

系统用户 HerodotusUser

additionalSignInOperation

public abstract void additionalSignInOperation(cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser HerodotusUser,
                                               cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails newSocialUserDetails,
                                               cn.herodotus.engine.oauth2.core.definition.domain.SocialUserDetails oldSocialUserDetails)

社交用户登录后，附加的其它操作

参数:

HerodotusUser - 系统用户信息 HerodotusUser

newSocialUserDetails - 社交登录过程中，第三方系统返回的新信息 SocialUserDetails

oldSocialUserDetails - 系统中已经存在的社交用户信息

authentication

public cn.herodotus.engine.oauth2.core.definition.domain.HerodotusUser authentication(String source,
                                                                                      cn.herodotus.engine.assistant.core.domain.AccessPrincipal accessPrincipal)
                                                                               throws org.springframework.security.core.AuthenticationException

社交登录

1. 首先在第三方系统进行认证，或者手机号码、扫码认证。返回认证后的信息 2. 根据认证返回的信息，在系统中查询是否有对应的用户信息。 2.1. 如果有对应的信息，根据需要更新社交用户的信息，然后返回系统用户信息，进行登录。 2.2. 如果没有对应信息，就先进行用户的注册，然后进行社交用户和系统用户的绑定。

指定者:

authentication 在接口中 SocialAuthenticationHandler

参数:

source - 社交登录提供者分类

accessPrincipal - 社交登录所需要的信息

返回:

系统用户

抛出:

org.springframework.security.core.AuthenticationException - AuthenticationException 认证错误